Merge branch 't/uptime_cleanup'
[paraslash.git] / ggo / audiod.m4
index 29bce10..628188d 100644 (file)
@@ -12,6 +12,7 @@ include(loglevel.m4)
 include(color.m4)
 include(config_file.m4)
 include(logfile.m4)
+include(log_timing.m4)
 include(daemon.m4)
 include(user.m4)
 include(group.m4)
@@ -103,7 +104,7 @@ details="
        Check the clock difference between the host running para_server
        and the local host running para_audiod that many times before
        starting any stream I/0. Set this to non-zero for non-local
-       setups if the clocks of these two hosts are not syncronized
+       setups if the clocks of these two hosts are not synchronized
        by ntp or similar.
 "
 
@@ -119,38 +120,49 @@ default="http"
 optional
 multiple
 details="
-       This option may be given multiple times, once for each
-       supported audio format. The \"receiver_spec\" consists of
-       an audio format and the receiver name, separated by a colon,
-       and any options for that receiver, seperated by whitespace.
-       If any receiver options are present, the whole receiver
-       argument must be quoted.
+       This option may be given multiple times, for each audio format
+       separately. If multiple definitions for an audio format are
+       given, the first one is selected.
+
+       The \"receiver_spec\" consists of an audio format specifier
+       and one or more receiver arguments, separated by a colon.
+
+       The audio format specifier is a regular expression which
+       specifies the set of audio formats for which this option
+       should apply.
 
-       Example:
+       If any receiver options are present, the whole receiver
+       argument must be quoted:
 
                -r 'mp3:http -i my.host.org -p 8009'
+
+       Since a single dot '.' matches the name of any audio format,
+       specifying '.' instead of 'mp3' above activates the http
+       receiver for all audio formats.
+
 "
 
 option "no_default_filters" D
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Configure filters manually"
 flag off
-details="
+details = "
        If (and only if) this option is set, the --filter options
-       (see below) take effect. Otherwise, the compiled-in default
-       filters mp3dec, oggdec and aacdec are activated for mp3, ogg,
-       aac streams respectively.
-
-       You have to configure filters manually if you want to use
-       the amp filter or the compress filter which are not activated
-       by default.
-
-       Playing udp streams also requires manual filter configuration
-       because the output of the udp receiver must be fed into the
-       fecdec filter first to produce a stream which can be decoded
-       by the appropriate decoder (mp3dec, oggdec, aacdec). In other
-       words, the fecdec filter must be specified as the first filter
-       of the filter chain for any udp stream.
+       (see below) take effect. Otherwise, the compiled-in defaults
+       apply.  These defaults depend on the receiver being used as
+       described below.
+
+       For http streams, only a single filter per audio format,
+       the decoder for that format, is activated. On the other hand,
+       since udp and dccp streams are sent fec-encoded by para_server,
+       the client side must feed the output of the receiver into
+       the fecdec filter first. Therefore the default for udp and
+       dccp streams is to activate the fecdec filter, followed by
+       the appropriate decoder.
+
+       You must give this option if you want to use any other filter,
+       for example the amp or the compress filter.
+
 "
 
 option "filter" f
@@ -162,14 +174,17 @@ multiple
 dependon="no_default_filters"
 details="
        This option may be given multiple times. The \"filter_spec\"
-       consists of an audio format, the name of the filter, and any
-       options for that filter. Note that order matters.
+       consists of an audio format specifier (see above), the name
+       of the filter, and any options for that filter. Note that
+       order matters.
 
        Examples:
 
                --filter 'mp3:mp3dec'
 
-               --filter 'mp3:compress --inertia 5 --damp 2'
+               --filter 'mp3|aac:compress --inertia 5 --damp 2'
+
+               --filter '.:fecdec'
 
 "
 
@@ -184,7 +199,7 @@ details="
        audio format.  Default value is \"alsa\" for all supported
        audio formats. Example:
 
-               --writer 'aac:osx'
+               --writer 'aac|wma:oss'
 
 "