Skip to content

Commit

Permalink
readme stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
netham45 committed Aug 7, 2024
1 parent 3689ce2 commit 9bf66c2
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ For comprehensive information on various aspects of ScreamRouter, please refer t
- Guide to using the embedded noVNC for remote computer control

## Relevant Repos

### Scream
* [Scream Windows Driver](https://github.com/duncanthrax/scream/)

### 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)
Expand All @@ -126,9 +130,12 @@ For comprehensive information on various aspects of ScreamRouter, please refer t
* [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)
* [Windows C# Receiver](https://github.com/duncanthrax/scream/tree/master/Receivers/dotnet-windows/ScreamReader)
* [Unix Receiver](https://github.com/duncanthrax/scream/tree/master/Receivers/unix)
* [Android Receiver](https://github.com/martinellimarco/scream-android/)

### Senders
* [Tool for appending Scream headers to PCM streams on Linux](https://github.com/netham45/screamsender) [Documentation](/Readme/screamsender.md)
* [Tool for prepending Scream headers to PCM streams on Linux](https://github.com/netham45/screamsender)

## Installation Guide

Expand Down
42 changes: 42 additions & 0 deletions Readme/scream-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,45 @@ The Scream receiver program performs the following key functions:
The receivers are designed to be very lightweight and have minimal processing overhead to maintain the low latency of the Scream system.

By using raw PCM data and a simple protocol, Scream achieves very low latency audio streaming over a LAN, typically under 10ms. This makes it suitable for applications like virtual sound cards in virtual machines or streaming audio between rooms in a house.


## Installation on Windows 10 (version 1607 and newer)

### Prerequisites
- To install the Scream driver the system clock must be set before July 7, 2023, which is the certificate's expiration date.

### Configuring the OS
Either

1) Disable Secure Boot in BIOS

Or

2) Set a special registry value to allow cross-signed drivers with Secure Boot enabled:
```
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\CI\Policy]
"UpgradedSystem"=dword:00000001
```
* These steps are necessary due to Microsoft's stricter rules for signing kernel drivers on newer Windows 10 installations.
### Configuring Unicast IPv4 IP and Port for Scream Audio Driver
The Scream Audio Driver needs to be pointing at ScreamRouter over unicast to port 16401 to work.
To set a specific Unicast IPv4 IP address and port for the Scream Audio Driver:
1. Open the Registry Editor by typing `regedit` in the Windows search bar and running it as administrator.
2. Navigate to the following registry key:
`HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Scream\Options`
3. Look for the `UnicastIP` value. If it doesn't exist, create a new String Value (REG_SZ) with this name.
4. Double-click on `UnicastIP` and set its value to the desired IPv4 address (e.g., "172.23.1.27").
5. To set the port, look for the `UnicastPort` value. If it doesn't exist, create a new DWORD (32-bit) Value with this name.
6. Double-click on `UnicastPort` and set its value to the desired port number in decimal format (e.g., 16401).
7. Close the Registry Editor and reboot your system for the changes to take effect.
2 changes: 1 addition & 1 deletion site/dialog_views/equalizer.html.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@
{{ equalizer_band(11840, 'b16') }}
{{ equalizer_band(16744, 'b17') }}
{{ equalizer_band(20000, 'b18') }}<BR />
{{- buttons.button("dialogSubmitNoClose", 'Update Equalizer' , "dialog-button", {}, "Apply Changes")}}
{{- buttons.button("dialogSubmitNoClose", 'Apply' , "dialog-button", {}, "Apply Changes")}}
{{- buttons.button("dialogEqualizerDefault", 'Default' , "dialog-button", {}, "Default Equalizer Settings")}}
{{- buttons.button("dialogCancel", 'Close' , "dialog-button", {}, "Close Equalizer")}}

0 comments on commit 9bf66c2

Please sign in to comment.