summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2012-05-06 09:00:53 +0200
committerAnton Khirnov <anton@khirnov.net>2012-05-14 21:36:11 +0200
commitfb604ae8500d4ee7de6af61387c11618b3dea25b (patch)
treee7b0a3f698797c26f6335a1be0ed975c9056b22c /doc
parenta2cd9be212fca02dd3d6ee65cb6ab9f84c5e28e5 (diff)
lavfi: add aformat filter
Based on a patch by Mina Nagy Zaki <mnzaki@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 0314bfaf20..f066657add 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -107,6 +107,32 @@ build.
Below is a description of the currently available audio filters.
+@section aformat
+
+Convert the input audio to one of the specified formats. The framework will
+negotiate the most appropriate format to minimize conversions.
+
+The filter accepts the following named parameters:
+@table @option
+
+@item sample_fmts
+A comma-separated list of requested sample formats.
+
+@item sample_rates
+A comma-separated list of requested sample rates.
+
+@item channel_layouts
+A comma-separated list of requested channel layouts.
+
+@end table
+
+If a parameter is omitted, all values are allowed.
+
+For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
+@example
+aformat=sample_fmts\=u8\,s16:channel_layouts\=stereo
+@end example
+
@section anull
Pass the audio source unchanged to the output.