more small audiod cleanups.
[paraslash.git] / README
diff --git a/README b/README
index f0b7779..017bc0c 100644 (file)
--- a/README
+++ b/README
@@ -8,11 +8,12 @@ It contains the following programs:
 
 - para_server (obligatory):
 
-       This server listens on a tcp port and accepts commands such as
-       play, stop, pause, next from authenticated clients.
+       This server supports audio streaming of mp3, ogg vorbis and
+       aac files.  It listens on a tcp port and accepts commands
+       such as play, stop, pause, next from authenticated clients.
 
-       For audio streaming, at least one of the three supported senders
-       of para_server  must be activated:
+       The audio stream may be sent over the network by three
+       different senders:
 
        The http sender is recommended for public streams that can
        be played by any player like mpg123, xmms, winamp...
@@ -24,10 +25,8 @@ It contains the following programs:
        private streams that require authentication.
 
        It is possible to activate more than one sender simultaneously.
-       All senders have the same set of commands that allow to
-       control the access permissions of the stream.
 
-       para_server needs an  "audio file selector" to work, mainly
+       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,
@@ -51,15 +50,16 @@ It contains the following programs:
        stdout. This one is independent from the rest of paraslash,
        so it might be useful also for different purposes.
 
-       para_filter combines an mp3 decoder an oggvorbis decoder
+       para_filter combines several decoders (mp3, oggvorbis, aac)
        and a volume normalzer. New filters can be added easily due
        to the modular design. If more than one filter is specified,
        the given filters are 'piped' together in-memory, i.e. without
        calling any of the read(2)/write(2)/select(2) etc. functions.
 
-- para_play (optional)
+- para_write (obligatory)
 
-       A small wav/raw player for alsa.
+       A modular audio stream writer. It supports a simple file
+       writer output plugin and an optional wav/raw player for alsa.
        Debian package: libasound2-dev
 
 - para_audiod (optional, but recommended):
@@ -130,11 +130,8 @@ REQUIREMENTS:
 ~~~~~~~~~~~~~
 In any case you need
 
-       - gcc, the gnu compiler collection (shipped with distro): gcc-3
-       or newer is prefered, but gcc-2.95 is still supported. Note
-       that gcc-2.95 may spit out many warnings like unused function
-       parameters and missing initializers. These are all harmless
-       and may be ignored.
+       - gcc, the gnu compiler collection (shipped with distro): gcc-3.3
+       or newer is required.
 
        - openssl (needed by server, client): usually shipped with
        distro, but you might have to install the "development"
@@ -163,15 +160,19 @@ make sure to install the corresponding development package as well.
 If you want to stream ogg vorbis files you'll need:
 
        - libogg, libvorbis, libvorbisfile, and a command line ogg vorbis
-               player, e.g. para_filter or ogg123.
+       decoder, e.g. para_filter or ogg123.
 
                http://www.xiph.org/downloads/
 
 Debian packages: libogg-dev libvorbis-dev
 
-Note that para_audiod still works even if neither mp3 nor ogg support
-was compiled in. You'll have to use the --no_default_filters option
-in this case (and e.g. "mpg123 -" as the stream write command).
+For aac files (m4a) you'll need libfaad. Get it at
+
+       http://www.audiocoding.com/modules/wiki/?page=AAC
+
+Note that para_audiod still works even if no audio file support was
+compiled in. You'll have to use the --no_default_filters option in this
+case (and e.g. "mpg123 -" as the stream write command for mp3 streams).
 
 If you intend to use the optional ortp streamer:
 
@@ -212,12 +213,6 @@ LICENSE:
 ~~~~~~~~
 Distribution of paraslash is covered by the GNU GPL. See file COPYING.
 
-LIMITATIONS:
-~~~~~~~~~~~~
-The mysql selector assumes that the basenames of your audio files are
-unique. If this is not the case, don't use this selector, rename your
-files, or create your own one.
-
 THE AUTHOR:
 ~~~~~~~~~~~
 Author: Andre Noll <maan@systemlinux.org>