summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>2010-09-25 01:56:58 +0000
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2010-09-25 01:56:58 +0000
commit1ee410f330d3b57b0ea1ccb915977f2ba4d99815 (patch)
tree735cbaa2b222cd3e8231fad931d2294266f9a527 /doc
parent6afd569e1df3cb02f89f85d9bc70e53edc1d23c6 (diff)
Add asrc_anullsrc - null audio source.
Based on a patch by "S.N. Hemanth Meenakshisundaram" smeenaks!ucsd!edu. Originally committed as revision 25188 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 1dc222a119..e6e187dec0 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -14,6 +14,40 @@ Pass the audio source unchanged to the output.
@c man end AUDIO FILTERS
+@chapter Audio Sources
+@c man begin AUDIO SOURCES
+
+Below is a description of the currently available audio sources.
+
+@section anullsrc
+
+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}.
+
+@var{sample_rate} 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.
+
+Check the channel_layout_map definition in
+@file{libavcodec/audioconvert.c} for the correspondance between string
+and channel layout values.
+
+Follow some examples:
+@example
+# set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO.
+anullsrc=48000:4
+
+# same as
+anullsrc=48000:mono
+@end example
+
+@c man end AUDIO SOURCES
+
@chapter Video Filters
@c man begin VIDEO FILTERS