audiod: Deprecate the --no_default_filters option.
[paraslash.git] / ggo / audiod.m4
index 2659b93..1bc5db1 100644 (file)
@@ -104,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
        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.
 "
 
        by ntp or similar.
 "
 
@@ -120,58 +120,68 @@ default="http"
 optional
 multiple
 details="
 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.
 
 
-       Example:
+       The audio format specifier is a regular expression which
+       specifies the set of audio formats for which this option
+       should apply.
+
+       If any receiver options are present, the whole receiver
+       argument must be quoted:
 
                -r 'mp3:http -i my.host.org -p 8009'
 
                -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
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 "
 
 option "no_default_filters" D
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-"Configure filters manually"
+"deprecated"
 flag off
 details = "
 flag off
 details = "
-       If (and only if) this option is set, the --filter options
-       (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.
-
+       This option is was deprecated in paraslash-0.4.10 and has no
+       effect any more. It will be removed in the next version.
 "
 
 option "filter" f
 #~~~~~~~~~~~~~~~~
 "
 
 option "filter" f
 #~~~~~~~~~~~~~~~~
-"Use non-default filters"
-string typestr="filter_spec"
+"Specify the filter configuration."
+string typestr = "filter_spec"
 optional
 multiple
 optional
 multiple
-dependon="no_default_filters"
-details="
+details = "
        This option may be given multiple times. The \"filter_spec\"
        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.
+
+       The compiled-in defaults apply to all audio formats for which
+       no --filter option was given. These defaults depend on the
+       receiver being used.
+
+       For HTTP streams, only the decoder for the current audio
+       format is activated. UDP and DCCP streams, on the other
+       hand, are sent FEC-encoded by para_server. In order to play
+       such streams, the receiver output must be FEC-decoded first,
+       i.e. fed to the fecdec filter. Therefore the default for UDP
+       and DCCP streams is to activate the fecdec filter, followed
+       by the decoding filter for the audio format.
 
        Examples:
 
                --filter 'mp3:mp3dec'
 
 
        Examples:
 
                --filter 'mp3:mp3dec'
 
-               --filter 'mp3:compress --inertia 5 --damp 2'
+               --filter 'mp3|aac:compress --inertia 5 --damp 2'
+
+               --filter '.:fecdec'
 
 "
 
 
 "
 
@@ -186,7 +196,7 @@ details="
        audio format.  Default value is \"alsa\" for all supported
        audio formats. Example:
 
        audio format.  Default value is \"alsa\" for all supported
        audio formats. Example:
 
-               --writer 'aac:osx'
+               --writer 'aac|wma:oss'
 
 "
 
 
 "
 
@@ -201,7 +211,7 @@ details="
        announced by para_server and do not send data to the writer
        before that time (modulo clock difference).
 
        announced by para_server and do not send data to the writer
        before that time (modulo clock difference).
 
-       This is useful mainly for syncronizing the audio output of
+       This is useful mainly for synchronizing the audio output of
        different clients.
 "
 </qu>
        different clients.
 "
 </qu>