More readme rewrites, update svg line ordering

README.md

@@ -2,48 +2,99 @@
 
 ![Screenshot of ScreamRouter](/images/ScreamRouter.png)
 
-[New Readme](Readme/readme.md)
+### What is ScreamRouter
 
-### What is it
-ScreamRouter is a Python-based audio router for Scream sources and sinks. It allows you to enter an IP address for all of your Scream audio sources and IP address, port, bit depth, sample rate, and channel configuration for all of your sinks. It has a web interface for managing the configuration and listening to sinks.
+ScreamRouter is a versatile audio routing and management system with a Python frontend/configuration layer and a C++ backend, designed for network audio streaming. It supports Scream and RTP audio sources, along with Scream receivers and web-based MP3 streamers as receivers. The system offers a robust set of features for configuring and controlling audio streams across a network:
+
+1. Source Management: Users can add and configure audio sources by specifying their IP addresses.
+
+2. Sink Configuration: Sinks (audio outputs) can be customized with detailed parameters including IP address, port, bit depth, sample rate, and channel configuration.
+
+3. Routing: ScreamRouter allows flexible routing between sources and sinks, enabling complex audio setups.
+
+4. Web Interface: A user-friendly web interface facilitates easy configuration management and provides the ability to listen to sinks directly through the browser.
+
+5. Advanced Audio Processing: The system includes a custom mixer, equalizer, and channel layout processor for optimal audio quality and minimal latency.
+
+6. Grouping and Volume Control: Sources and sinks can be grouped for simultaneous control, with volume adjustable at every level (source, route, sink, and group).
+
+7. Integration Capabilities: ScreamRouter offers integration with Home Assistant and supports various streaming services through Docker containers.
+
+8. Extensibility: A flexible plugin system allows for easy addition of new audio sources.
+
+This tool is intended for creating whole-house audio setups, managing multiple audio streams, and providing granular control over network audio routing and processing.
 
 ### What is Scream
-[Scream is a virtual audio driver for Windows](https://github.com/duncanthrax/scream) created by Tom Kistner. It operates by sending any received PCM data from Windows's sound engine over the network unprocessed. This allows very low latency. Each packet from Scream is 1152 bytes worth of PCM from Windows's audio engine with a 5 byte header that describes the format of the stream.
-
-The simplicity of Scream allows it to be very easy to work with while retaining low latency.
-
-### Features
-* Configure Sources based off of IP address, Configure Routes between Sources and Sinks, Configure Sinks with Bit Depth, Sample Rate, Channel Layout, Sink IP, and Port
-* Group together Sources and Sinks to control and play to multiple at a time
-* Control the volume for each Source, Route, Sink, and Group the stream passes through
-* Exposes an MP3 stream of all sinks so they can be listened to in a browser
-* Can play a URL out of a sink or sink group
-* Has a Home Assistant Custom Component for managing Sinks and playing media back through Sinks (See: https://github.com/netham45/screamrouter_ha_component )
-* Automatically saves to YAML on setting change
-* Uses a custom mixer/equalizer/channel layout up/downmixer so latency can be minimized
-* Can adjust equalization for any sink, route, source, or group
-* Contains a plugin system to easily allow additional sources to be added
-* Milkdrop Visualizations thanks to the browser-based [Butterchurn](https://github.com/jberg/butterchurn) project
-* There are playback sinks available for common OSes such as [Windows](https://github.com/duncanthrax/scream/tree/master/Receivers/dotnet-windows/ScreamReader), [Linux](https://github.com/duncanthrax/scream/tree/master/Receivers/unix), and [Android](https://github.com/martinellimarco/scream-android/tree/90d1364ee36dd12ec9d7d2798926150b370030f3). I've written one for [ESP32 A1S Audiokit Dev boards](https://github.com/netham45/esp32-audiokit-screamreader/), and [one for esp32/esp32s that does toslink and usb uac 1.0 output](https://github.com/netham45/esp32-scream-receiver/) and I've written a multi-platform receiver in [Python](https://github.com/netham45/pyscreamreader).
-* Embedded noVNC for controlling remote computers playing music
-* Can accept streams from PulseAudio
-* Docker containers to add support for [Amazon Music](https://github.com/netham45/screamrouter-amazon-music-docker), [Firefox](https://github.com/netham45/screamrouter-firefox-docker), [Spotify](https://github.com/netham45/screamrouter-spotify-docker)
-* Linux tool for sending PCM data from the command line [ScreamSender](https://github.com/netham45/screamsender/)
-* Ability to send media control commands to containers from API and web interface
-
-![Screenshot of ScreamRouter noVNC](/images/noVNC.png)
+
+[Scream](https://github.com/duncanthrax/scream) is a virtual audio driver for Windows developed by Tom Kistner. It offers the following key features:
+
+1. Network Transmission: Sends PCM data from Windows' sound engine over the network without processing.
+2. Low Latency: Achieves minimal delay due to its streamlined approach.
+3. Simple Protocol: Each packet consists of 1152 bytes of PCM data and a 5-byte header describing the stream format.
+4. Ease of Use: The simplicity of Scream's design makes it both user-friendly and efficient.
+
+Scream's straightforward architecture allows for easy integration while maintaining high performance in audio streaming applications.
+
+### Key Features
+
+#### Audio Routing and Configuration
+* Configure Sources by IP address
+* Set up Routes between Sources and Sinks
+* Customize Sinks with Bit Depth, Sample Rate, Channel Layout, IP, and Port
+* Group Sources and Sinks for simultaneous control and playback
+* Volume control at every level: Source, Route, Sink, and Group
+
+#### Audio Processing and Playback
+* Custom mixer/equalizer/channel layout processor for minimal latency
+* Adjustable equalization for any sink, route, source, or group
+* MP3 stream exposure for browser-based listening of all sinks
+* URL playback capability for sinks or sink groups
+* Milkdrop Visualizations via [Butterchurn](https://github.com/jberg/butterchurn) project
+
+#### Integration and Compatibility
+* Home Assistant Custom Component for managing Sinks and media playback
+* PulseAudio stream acceptance
+* Embedded noVNC for remote computer control
+* Docker containers for [Amazon Music](https://github.com/netham45/screamrouter-amazon-music-docker), [Firefox](https://github.com/netham45/screamrouter-firefox-docker), and [Spotify](https://github.com/netham45/screamrouter-spotify-docker)
+
+#### System Management
+* Automatic YAML saving on setting changes
+* Flexible plugin system for easy addition of new sources
+* API and web interface for media control commands to containers
+
+#### Additional Tools and Receivers
+* [ScreamSender](https://github.com/netham45/screamsender/): Linux tool for sending PCM data from the command line
+* Playback sinks available for [Windows](https://github.com/duncanthrax/scream/tree/master/Receivers/dotnet-windows/ScreamReader), [Linux](https://github.com/duncanthrax/scream/tree/master/Receivers/unix), and [Android](https://github.com/martinellimarco/scream-android/tree/90d1364ee36dd12ec9d7d2798926150b370030f3)
+* Custom receivers:
+  - [ESP32 A1S Audiokit Dev boards](https://github.com/netham45/esp32-audiokit-screamreader/)
+  - [ESP32/ESP32S with TOSLINK and USB UAC 1.0 output](https://github.com/netham45/esp32-scream-receiver/)
+  - [Multi-platform Python receiver](https://github.com/netham45/pyscreamreader)
 
 ### Use Cases
-* Mixing one or many Scream Sources to one or many Scream Receivers for a whole-house audio setup
-* Changing the volume of groups of sinks at once while having each sink also individually leveled
-* Use a web browser as a sink via the 'Listen to Sink' feature
-* Use any streaming MP3 player as a sink via the exposed API
-* Programatically enable/disable sinks, or adjust the volume through the FastAPI API, or through Home Assistant
-* Play back sound effects and Text to Speech to arbitrary Sinks from Home Assistant automations
-* Line up speakers with differing timings by delaying one
-* Adjusting EQ for a cheap speaker so it sounds better
-
-![Screenshot of HA for ScreamRouter](/images/HAMediaPlayer.png)
+
+ScreamRouter offers a versatile solution for various audio management scenarios, including:
+
+1. Comprehensive Whole-House Audio Systems:
+   - Integrate multiple Scream Sources and Receivers for seamless audio distribution throughout your home.
+
+2. Advanced Volume Management:
+   - Implement granular volume control at both group and individual sink levels, ensuring optimal audio balance across your setup.
+
+3. Web-Based Audio Access:
+   - Utilize the 'Listen to Sink' feature to enable browser-based audio playback, enhancing accessibility and flexibility.
+
+4. Universal Sink Compatibility:
+   - Leverage the exposed API to incorporate any streaming MP3 player as a sink, expanding your audio output options.
+
+5. Programmatic Audio Control:
+   - Employ the FastAPI interface or Home Assistant integration for automated management of sink activation, deactivation, and volume adjustments.
+
+6. Home Automation Integration:
+   - Seamlessly incorporate sound effects and Text-to-Speech functionality into Home Assistant automations for enhanced smart home experiences.
+
+7. Sound Quality Enhancement:
+   - Utilize built-in equalization tools to optimize audio output, particularly beneficial for improving the performance of budget-friendly speakers.
+
 ## Documentation
 
 For comprehensive information on various aspects of ScreamRouter, please refer to the following guides:
@@ -61,17 +112,20 @@ For comprehensive information on various aspects of ScreamRouter, please refer t
 * [User Interface Guide](Readme/ui.md): Documentation on using the ScreamRouter web interface
 * [VNC Integration](Readme/vnc.md): Guide to using the embedded noVNC for remote computer control
 
-## Prerequisites
+## Relevant Repos
+### Docker Containers
+* [Amazon Music Docker Container for ScreamRouter](https://github.com/netham45/screamrouter-amazon-music-docker)
+* [Firefox Docker Container for ScreamRouter](https://github.com/netham45/screamrouter-firefox-docker)
+* [Spotify Docker Container for ScreamRouter](https://github.com/netham45/screamrouter-spotify-docker)
+
+### Receivers
+* [ESP32/ESP32s spdif/USB UAC 1.0 audio receiver](https://github.com/netham45/esp32-scream-receiver)
+* [ESP32 A1S Audiokit Receiver](https://github.com/netham45/esp32-audiokit-screamreader)
+* [Python Scream Receiver](https://github.com/netham45/pyscreamreader)
 
-- Scream (configured for UDP unicast on port 16401)
-- Python requirements (see requirements.txt)
-- Linux environment
-- SSL certificate (path configurable in src/constants/constants.py)
+### Senders
+* [Tool for appending Scream headers to PCM streams on Linux](https://github.com/netham45/screamsender) [Documentation](/Readme/screamsender.md)
 
-## Quick Start
+## Installation Guide
 
-1. Install Docker
-2. Build the ScreamRouter Docker Container
-3. Run the ScreamRouter Docker Container
-4. Access the web interface on port 443
-5. Add Sources, Sinks, and Routes as needed
+See [The ScreamRouter Docker install guide](https://github.com/netham45/screamrouter/blob/main/Readme/docker-screamrouter.md)

Readme/docker-screamrouter.md

@@ -9,6 +9,8 @@ There is a basic Docker container to build and run ScreamRouter available.
 
 ## Building the Docker Image
 
+The scripts to build the Docker image are in [the docker/ directory](/docker/)
+
 To build the ScreamRouter Docker image, run:
 
 ```bash

Readme/homeassistant.md

@@ -62,12 +62,8 @@ If you encounter issues:
 2. Verify that the component is correctly installed in your `custom_components` directory.
 3. Review the Home Assistant logs for any error messages related to ScreamRouter.
 
-## Support
-
-For issues specific to the Home Assistant component, please open an issue in the ScreamRouter GitHub repository. For general ScreamRouter questions, refer to the main ScreamRouter documentation.
-
 ## Screenshots
 
-![Screenshot of HA for ScreamRouter](/images/home_assistant.png)
+![Screenshot of HA for ScreamRouter](/images/HAMediaPlayer.png)
 
 This screenshot shows the ScreamRouter integration in action within Home Assistant, demonstrating the various control options available for audio sources, routes, and sinks.

Readme/screamsender.md

@@ -0,0 +1,50 @@
+# ScreamSender
+
+ScreamSender is a Linux utility designed to encapsulate PCM audio streams and send them to a remote Scream receiver or [ScreamRouter](http://github.com/netham45/ScreamRouter) over UDP. While originally intended for LG WebOS TVs, it can run on any Linux-based system.
+
+## Key Features
+
+- Accepts PCM audio input from stdin
+- Sends audio streams to specified Scream receivers
+- Supports stereo channel layout
+- Configurable sample rate and bit depth
+
+## Usage
+
+`screamsender -i -p [-s ] [-b ]`
+
+### Parameters
+
+- `-i <IP Address>`: IP Address of the Scream receiver (Mandatory)
+- `-p <Port>`: Port of the Scream receiver (Mandatory)
+- `-s <Sample Rate>`: Sample Rate (Default: 48000)
+- `-b <Bit Depth>`: Bit Depth (Default: 32)
+
+## Building
+
+### Local Build
+
+Tested on Debian 12 and Alma 9 containers:
+
+1. Install required packages: `g++` and `gcc`
+2. Compile with: `g++ screamsender.cpp -o screamsender`
+
+### Cross-compile for aarch64
+
+Tested on a Debian 12 container:
+
+1. Install required packages: `g++-aarch64-linux-gnu`, `gcc-aarch64-linux-gnu`, `binutils-aarch64-linux-gnu`
+2. Compile with: `aarch64-linux-gnu-g++ --static screamsender.cpp -o screamsender_aarch64`
+
+## LG WebOS TV Audio Capture
+
+Tested on an LG C1 TV:
+
+`arecord -B 0 -D "hw:1,2" -f S32_LE -c 2 -r 48000 - | screamsender -i <IP Address> -p <Port>`
+
+
+Note: Capturing audio from HDMI requires the audio to be routed through the TV (e.g., TV speakers, wired headphones, or Bluetooth). ARC/eARC output is not supported. Only stereo audio is available from the TV.
+
+## Integration with ScreamRouter
+
+ScreamSender can be used as a source for ScreamRouter, allowing you to incorporate audio from Linux devices or LG WebOS TVs into your ScreamRouter setup.

Readme/ui.md

@@ -37,13 +37,20 @@ Sinks represent audio outputs. To manage sinks:
 
 ## Creating and Managing Routes
 
-Routes define connections between sources and sinks. To create a route:
+Routes define connections between sources and sinks. To create a route either:
 1. Select a source from the Sources panel.
 2. Select a sink from the Sinks panel.
 3. Use the Routes panel to configure:
    - Volume adjustment
    - Equalizer settings
    - Delay adjustment
+   - Enabling/disabling routes -- Routes will automatically be created when enabled if they don't already exist.
+
+Or, use the "Edit Routes" option available:
+1. Select a source or sink.
+2. Select "Edit Routes".
+3. Choose to Enable or Disable the sources or sinks you want connected to your choice
+4. Save the configuration
 
 ## Using the Equalizer
 
@@ -54,6 +61,14 @@ The Equalizer feature allows you to adjust audio settings at various levels:
 
 Equalizer settings stack, allowing for fine-tuned audio control.
 
+## Routing View
+
+On desktop the routing view will be lines connecting sources to sinks representing each active connection. They can be hovered over to show the connection or clicked on to activate the source and sink on either side of the route.
+
+Routes that are not associated with currently selected sinks/sources will be displayed as black lines, routes associated with selected sources/sinks will be displayed as green.
+
+On mobile the routing view will be a list instead of connecting lines.
+
 ## Advanced Features
 
 ### Groups

Readme/vnc.md

@@ -8,6 +8,8 @@ This project implements VNC (Virtual Network Computing) functionality to allow r
 - A WebSocket proxy is started on-demand to bridge the VNC connection
 - The VNC viewer runs in the browser using noVNC
 
+![Screenshot of ScreamRouter noVNC](/images/noVNC.png)
+
 ## Key Components
 
 1. `APIWebsite` class in `api_website.py`:
@@ -39,8 +41,4 @@ VNC connection details are stored in the Source Configuration:
 - `vnc_ip`: IP address of the VNC server
 - `vnc_port`: Port of the VNC server
 
-## Security Considerations
-
-- VNC connections use TLS encryption via the WebSocket proxy
-
 This VNC implementation allows convenient in-browser remote access to source devices, integrating smoothly with the rest of the application's interface.