gui: Use variable-sized input buffer for the audiod pipe.
[paraslash.git] / README
diff --git a/README b/README
index 421e03f..6cf34f2 100644 (file)
--- a/README
+++ b/README
@@ -17,16 +17,16 @@ over local and/or remote networks. It listens on a tcp port and
 accepts commands such as play, stop, pause, next from authenticated
 clients. However, there are many more commands.
 
 accepts commands such as play, stop, pause, next from authenticated
 clients. However, there are many more commands.
 
-It supports three builtin network streaming methods (senders): http, dccp,
-or rtp.
+It supports three built-in network streaming methods (senders): http, dccp,
+or udp.
 
        * The http sender is recommended for public streams that can be played
          by any player like mpg123, xmms, itunes, winamp...
 
 
        * The http sender is recommended for public streams that can be played
          by any player like mpg123, xmms, itunes, winamp...
 
-       * The dccp sender requires kernel support for the rather new datagram
-         congestion control protocol.
+       * The dccp sender requires kernel support for the datagram congestion
+         control protocol.
 
 
-       * The ortp sender is recommended for multicast LAN streaming.
+       * The udp sender is recommended for multicast LAN streaming.
 
 It is possible to activate more than one sender simultaneously.
 
 
 It is possible to activate more than one sender simultaneously.
 
@@ -39,11 +39,11 @@ Its features include
 
        * attributes. Allow fine-grained audio file selection.
 
 
        * attributes. Allow fine-grained audio file selection.
 
-       * image table. For storage of e.g. album cover art.
+       * image table. For storing e.g. album cover art.
 
 
-       * lyrics table. For storage of lyrics.
+       * lyrics table. For storing lyrics.
 
 
-       * playlist table. Stores arbitrary many playlists.
+       * playlist table. Stores arbitrary many playlists for later use.
 
        * mood mode. Audio file selection works by specifying mood
          methods involving attributes, pattern matching for file names
 
        * mood mode. Audio file selection works by specifying mood
          methods involving attributes, pattern matching for file names
@@ -58,7 +58,7 @@ Its features include
 
 Despite of all these features, paraslash is lightweight. The
 stripped binary of para_server with all its features compiled in
 
 Despite of all these features, paraslash is lightweight. The
 stripped binary of para_server with all its features compiled in
-mp3/ogg/aac support, http/dccp/ortp support) is about 150K on i386
+mp3/ogg/aac support, http/dccp/udp support) is about 160K on i386
 under Linux. para_audiod (see below) is even smaller.
 
 -----------
 under Linux. para_audiod (see below) is even smaller.
 
 -----------
@@ -72,15 +72,15 @@ little programming effort.
 
 All connections between para_server and para_client are encrypted by
 default.  For each user of paraslash you must create a public/secret
 
 All connections between para_server and para_client are encrypted by
 default.  For each user of paraslash you must create a public/secret
-key pair for authentication. The (authenticated) connection is encrypted
-with a symmetric rc4 session key.
+RSA key pair for authentication. The authenticated connection is
+encrypted with a symmetric rc4 session key.
 
 ---------
 para_recv
 ---------
 
 
 ---------
 para_recv
 ---------
 
-A command line http/dccp/rtp stream grabber. The http mode of this tool
-can be used to receive data from any http streaming source.
+A command line http/dccp/udp stream grabber. The http mode of this
+tool can be used to receive data from any http streaming source.
 
 -----------
 para_filter
 
 -----------
 para_filter
@@ -90,19 +90,33 @@ A filter program that converts from stdin and writes to stdout.
 
 para_filter combines several decoders (mp3, oggvorbis, aac) and a
 volume normalizer. New filters can be added easily. It is possible
 
 para_filter combines several decoders (mp3, oggvorbis, aac) and a
 volume normalizer. New filters can be added easily. It is possible
-to "chain" any number of filters, like unix pipes.
+to "chain" any number of filters, like UNIX pipes.
 
 para_filter does not depend on other parts of paraslash, so it can
 
 para_filter does not depend on other parts of paraslash, so it can
-be used as a stand-alone command line tool for audio decoding.
+be used as a stand-alone command line tool for audio decoding and
+volume normalization.
+
+--------
+para_afh
+--------
+
+A small stand-alone program that prints tech info about the given
+audio file to stdout. It can be instructed to print a "chunk table",
+an array of offsets within the audio file or to write the content of
+the audio file in complete chunks 'just in time'.
+
+This allows third-party streaming software that is unaware of
+the particular audio format to send complete frames in real
+time. Currently, mp3, ogg vorbis and aac are supported.
 
 ----------
 para_write
 ----------
 
 A modular audio stream writer. It supports a simple file writer
 
 ----------
 para_write
 ----------
 
 A modular audio stream writer. It supports a simple file writer
-output plug-in and optional wav/raw players for alsa (linux-only,
-Debian package: libasound2-dev) and Mac OS. para_write can also be
-used as a stand-alone wav or raw audio player.
+output plug-in and optional wav/raw players for ALSA (Linux) and for
+coreaudio (Mac OS). para_write can also be used as a stand-alone wav
+or raw audio player.
 
 -----------
 para_audiod
 
 -----------
 para_audiod
@@ -111,10 +125,10 @@ para_audiod
 The local daemon that collects information from para_server.
 
 It runs on the client side and connects to para_server.  As soon as
 The local daemon that collects information from para_server.
 
 It runs on the client side and connects to para_server.  As soon as
-para_server announces the availability (and the type) of an audio
-stream, para_audiod starts an appropriate receiver, any number of
-filters and a paraslash writer to play the stream. It is possible to
-capture the stream at any position in the filter chain.
+para_server announces the availability of an audio stream, para_audiod
+starts an appropriate receiver, any number of filters and a paraslash
+writer to play the stream. It is possible to capture the stream at
+any position in the filter chain.
 
 Moreover, para_audiod listens on a local socket and sends status
 information about para_server and para_audiod to local clients on
 
 Moreover, para_audiod listens on a local socket and sends status
 information about para_server and para_audiod to local clients on
@@ -125,7 +139,7 @@ socket credentials, if available.
 para_audioc
 -----------
 
 para_audioc
 -----------
 
-The client program which talks with para_audiod. Used to control
+The client program which talks to para_audiod. Used to control
 para_audiod, to receive status info, or to grab the stream at any
 point in the filter chain.
 
 para_audiod, to receive status info, or to grab the stream at any
 point in the filter chain.
 
@@ -144,7 +158,7 @@ be added easily.
 para_fade
 ---------
 
 para_fade
 ---------
 
-A (Linux-only) alarm clock and volume-fader.
+A (oss-only) alarm clock and volume-fader.
 
 ---------------
 bash_completion
 
 ---------------
 bash_completion