X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=README;h=f0b77799449975703db4c8ec8633ff0d89349464;hp=70c91445fe5254f98d647051194996106a011e66;hb=a4dbed1c3c7fb8b1b334aa62edcd8d673b3d18b2;hpb=1d84285b710b37d0996862f710369526cd270203 diff --git a/README b/README index 70c91445..f0b77799 100644 --- a/README +++ b/README @@ -9,14 +9,17 @@ It contains the following programs: - para_server (obligatory): This server listens on a tcp port and accepts commands such as - play, stop, pause, next. However, there are many more commands. + play, stop, pause, next from authenticated clients. - For audio streaming, at least one sender must be activated. - At the moment, paraslash contains two internal senders: + For audio streaming, at least one of the three supported senders + of para_server must be activated: The http sender is recommended for public streams that can be played by any player like mpg123, xmms, winamp... + The dccp sender is experimental and requires kernel support + for the rather new datagram congestion control protocol. + The ortp sender is recommended for LAN streaming and for private streams that require authentication. @@ -27,7 +30,7 @@ It contains the following programs: para_server needs an "audio file selector" to work, mainly to determine which song to stream next. There are three selectors available: random, playlist and mysql. The former - chooses audio files randomly and playlist can handle, well, + chooses audio files randomly and playlist can handle, well, playlists. Both are always supported. The optional mysql selector connects to a mysql server which @@ -40,11 +43,11 @@ It contains the following programs: - para_recv (optional) - A command line http/ortp stream grabber. + A command line http/dccp/rtp stream grabber. - para_filter (optional) - An filter program that converts from stdin and writes to + A filter program that converts from stdin and writes to stdout. This one is independent from the rest of paraslash, so it might be useful also for different purposes. @@ -61,37 +64,37 @@ It contains the following programs: - para_audiod (optional, but recommended): - The local daemon that starts playback and collects information - from para_server to be forwarded to local clients. - - para_audiod reads the audio stream from the network if - para_server indicates that there is a stream available. It may - be sent through any of the supported filters (see para_filter - above) before the result is fed to the output software - (default: para_play) which must be capable of reading from - stdin, but is not restricted otherwise. + The local daemon that collects information from para_server. It + starts an appropriate receiver, filter and player as soon + as para_server announces the availability (and the type) of + an audio stream. para_audiod listens on a local socket and + sends status information about para_server and para_audiod + to local clients on request. - para_audioc (optional, but recommended) - A small client that can talk to para_audiod. Used to control - para_audiod and to receive status info. It can also be used to - grab the stream at any point in the filter chain. para_audioc - is needed by para_gui, para_sdl_gui and para_krell, see below. + The client program which talks with para_audiod. Used to + control para_audiod, to receive status info, or to grab the + stream at any point in the filter chain. + + para_audioc (hence para_audiod) is needed by para_gui, + para_sdl_gui and para_krell, see below. -- para_gui (optional, but recommended): +- para_gui (optional): - Themable ncurses-based gui. It calls para_audioc and presents - the obtained information in an ncurses window. para_gui - provides key-bindings for the most common commands and new - key-bindings can be added easily. + Themable ncurses-based gui. It calls para_audioc and presents + the obtained information in an ncurses window. para_gui + provides key-bindings for the most common commands and new + key-bindings can be added easily. - para_sdl_gui (optional): - SDL-based gui. Similar to para_gui but presents its output in - an X window (fullscreen mode is also available) and can display - jpg images on a per song basis. para_sdl_gui provides an input - prompt to enter arbitrary commands. However, it can also be used - non-interactively (e.g. as a screen saver) via the -i switch. + SDL-based gui. Similar to para_gui but presents its output + in an X window (fullscreen mode is also available) and can + display jpg images on a per song basis. para_sdl_gui provides + an input prompt to enter arbitrary commands. However, it + can also be used non-interactively (e.g. as a screen saver) + via the -i switch. - para_krell (optional, only useful in conjunction with the mysql selector):