aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2011-09-17 12:31:21 +0200
committerStefano Sabatini <stefasab@gmail.com>2011-09-18 12:30:01 +0200
commit44ab77db9efaa41f968b9e90aa8b58e9d416a48a (patch)
treecad55148554ac543563885fa86607367a70e7f5e /doc
parent07631deeeeb4ee805714444c3a0bf9fb4941f8b5 (diff)
downloadffmpeg-44ab77db9efaa41f968b9e90aa8b58e9d416a48a.tar.gz
asrc_anullsrc: extend syntax to make it accept a non positional list of arguments
The new syntax is more extensible and more user-friendly. This breaks the previous syntax, should not be an issue as possibly no-one is already using anullsrc.
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi26
1 files changed, 17 insertions, 9 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index a8600a57c1..d65d45ada8 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -312,26 +312,34 @@ value is "-1".
Null audio source, never return audio frames. It is mainly useful as a
template and to be employed in analysis / debugging tools.
-It accepts as optional parameter a string of the form
-@var{sample_rate}:@var{channel_layout}.
+It accepts an optional sequence of @var{key}=@var{value} pairs,
+separated by ":".
+
+The description of the accepted options follows.
-@var{sample_rate} specify the sample rate, and defaults to 44100.
+@table @option
+
+@item sample_rate, s
+Specify the sample rate, and defaults to 44100.
-@var{channel_layout} specify the channel layout, and can be either an
-integer or a string representing a channel layout. The default value
-of @var{channel_layout} is 3, which corresponds to CH_LAYOUT_STEREO.
+@item channel_layout, cl
+
+Specify the channel layout, and can be either an integer or a string
+representing a channel layout. The default value of @var{channel_layout}
+is "stereo".
Check the channel_layout_map definition in
@file{libavcodec/audioconvert.c} for the mapping between strings and
channel layout values.
+@end table
Follow some examples:
@example
-# set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO.
-anullsrc=48000:4
+# set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
+anullsrc=r=48000:cl=4
# same as
-anullsrc=48000:mono
+anullsrc=r=48000:cl=mono
@end example
@c man end AUDIO SOURCES