-RTP Streaming
-=============
+* Introduction
-DisOrder is now capable to transmitting RTP streams over a suitable network.
-To enable this make sure that allplayers use the speaker process, i.e. execraw
+This file describes DisOrder's relationship to several different things that
+get called 'streams'.
+
+* RTP Streaming
+
+DisOrder is capable of transmitting RTP streams over a suitable network.
+
+** Server Setup
+
+To enable this make sure that all players use the speaker process, i.e. execraw
rather than exec (or it won't work properly) and configure the network speaker
backend:
- speaker_backend network
+ api network
broadcast 172.17.207.255 9003
broadcast_from 172.17.207.2 9002
-The destination address doesn't have to be a broadcast address.
-broadcast_from is optional but may be convenient for some cases.
+The destination address (broadcast) can be:
+ - a broadcast address for a local network
+ - a multicast address
+
+The source address (broadcast_from) is optional but may be convenient in some
+cases.
+
+If the destination is a multicast address then you should set the TTL, for
+instance:
+
+ multicast_ttl 10
+
+(The destination can also be a unicast address but that's not a tested
+configuration.)
+
+scripts/setup now knows how to do basic setup for network play.
+
+** Playing The Stream
-To play, use the disorder-playrtp client.
+To play, use the disorder-playrtp client. If the destination address was a
+unicast or broadcast address then:
- disorder-playrtp 0.0.0.0 9003
+ disorder-playrtp 9003
+
+If the destination address was a multicast address then you must specify that,
+for instance:
+
+ disorder-playrtp 224.2.3.4 9003
+
+If the client machine has a DisOrder configuration file allowing disorder(1) to
+connect to the server then the parameters are unnecessary: disorder-playrtp
+will figure out the details automatically.
+
+** Disobedience
+
+Disobedience is capable of running disorder-playrtp in the background (provided
+it is installed); look for the speaker icon. If it detects that the server is
+using network play then its volume control will apply to the local volume, not
+the server's volume.
+
+If you run into trouble look for *.log files in the ~/.disorder directory.
+
+** Limitations
Currently only 16-bit 44100Hz stereo is supported, which requires about
-1.4Mbit/s. Possibly other lower-quality but lower-bandwidth encodings will be
-supported in future.
+1.4Mbit/s. At the time of writing I've found this to work fine on 100Mbit/s
+ethernet and had reports of success with 10Mbit/s ethernet, but have not had
+any success with wireless.
-If you have a too-recent version of sox you may need to set the sox_generation
-option.
+Possibly other lower-quality but lower-bandwidth encodings will be supported in
+future.
-There is now (not well tested) multicast support.
+If you have a very recent version of sox you may need to set the sox_generation
+option. See disorder_config(5).
-Icecast Streaming
-=================
+* Icecast Streaming
This can be achieved using the speaker_command option and Icecast (see
http://www.icecast.org/). It will only work if you use the speaker process,
<loglevel>4</loglevel>
<consolelog>0</consolelog>
<stream>
- <metadata>
- <name>lyonesse</name>
- <genre>Various</genre>
- <description>lyonesse disorder output</description>
- </metadata>
- <input>
- <module>stdinpcm</module>
- <param name="rate">44100</param>
- <param name="channels">2</param>
- <param name="metadata">1</param>
- <param name="metadatafilename">/var/disorder/icedata</param>
- </input>
- <instance>
- <hostname>lyonesse.anjou.terraraq.org.uk</hostname>
- <port>8000</port>
- <password>SOURCE PASSWORD HERE</password>
- <mount>/disorder.ogg</mount>
- <reconnectdelay>2</reconnectdelay>
- <reconnectattempts>5</reconnectattempts>
- <maxqueuelength>80</maxqueuelength>
- <encode>
- <nominal-bitrate>64000</nominal-bitrate>
- <samplerate>44100</samplerate>
- <channels>2</channels>
- <flush-samples>8820</flush-samples>
- </encode>
- </instance>
-
- </stream>
+ <metadata>
+ <name>lyonesse</name>
+ <genre>Various</genre>
+ <description>lyonesse disorder output</description>
+ </metadata>
+ <input>
+ <module>stdinpcm</module>
+ <param name="rate">44100</param>
+ <param name="channels">2</param>
+ <param name="metadata">1</param>
+ <param name="metadatafilename">/var/disorder/icedata</param>
+ </input>
+ <instance>
+ <hostname>lyonesse.anjou.terraraq.org.uk</hostname>
+ <port>8000</port>
+ <password>SOURCE PASSWORD HERE</password>
+ <mount>/disorder.ogg</mount>
+ <reconnectdelay>2</reconnectdelay>
+ <reconnectattempts>5</reconnectattempts>
+ <maxqueuelength>80</maxqueuelength>
+ <encode>
+ <nominal-bitrate>64000</nominal-bitrate>
+ <samplerate>44100</samplerate>
+ <channels>2</channels>
+ <flush-samples>8820</flush-samples>
+ </encode>
+ </instance>
+ </stream>
</ices>
This doesn't seem to get on very well with pausing but you're unlikely to want
If you have a too-recent version of sox you may need to set the sox_generation
option.
+Mark Wooding contributed the original support for this but it's been modified
+enough that he probably shouldn't be blamed for any bugs in the current code.
+
-DisOrder and Republishing Internet Streams
-==========================================
+* DisOrder and Republishing Internet Streams
DisOrder doesn't have any built-in support for playing streams but you can make
it do so. I use the following in my configuration file:
Local Variables:
-mode:text
+mode:outline
fill-column:79
End:
~mdw / disorder / blobdiff