From: Richard Kettlewell Date: Sat, 24 Nov 2007 15:58:13 +0000 (+0000) Subject: expand streaming instructions X-Git-Tag: 1.5.99+dev10~58 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/commitdiff_plain/da6f76931a7991d6b1537765a71ca6dc9f07b64c expand streaming instructions --- diff --git a/README b/README index ec5b97f..28cbcc7 100644 --- a/README +++ b/README @@ -117,15 +117,18 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades. * edit the 'scratch' commands to supply scratch sounds (or delete them if you don't want any). * edit the 'trust' command to reflect the user the web interface will - eventually run as. - * edit the 'url' command to give the URL of the web interface. + eventually run as (see below). + * edit the 'url' command to give the URL of the web interface (see below). * add or remove 'stopword' entries as necessary (these words won't take part in track name searches from the web interface). See disorder_config(5) for more details. - See README.raw for details on setting up "raw format" players, which allow - for pausing and gapless play. + See README.streams for how to set up network play. + + If adding new 'player' commands, see README.raw for details on setting up + "raw format" players. Non-raw players are still supported but not in all + configurations and they cannot support pausing and gapless play. 5. Make sure the server is started at boot time. diff --git a/README.streams b/README.streams index 1356b78..0a2676c 100644 --- a/README.streams +++ b/README.streams @@ -1,8 +1,15 @@ -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 various things that get called +'streams'. + +* RTP Streaming + +DisOrder is capable to 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: @@ -10,25 +17,59 @@ backend: 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 unicast address if you only want to talk to one client + - a broadcast address for a local network + - a multicast address + +The source address (broadcast_from) is optional but may be convenient in som +ecases. -To play, use the disorder-playrtp client. +If the destination is a multicast address then you should set the TTL, for +instance: + + multicast_ttl 10 + +** Playing The Stream + +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 +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 ~/.disorder. + +** 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 too-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, @@ -88,8 +129,7 @@ If you have a too-recent version of sox you may need to set the sox_generation option. -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: @@ -117,6 +157,6 @@ normal play by scratching the stream. Local Variables: -mode:text +mode:outline fill-column:79 End: