doc: document cutoff option to ac3 and adjust the option's global documentation
authorMoritz Barsnick <barsnick@gmx.net>
Fri, 30 Dec 2016 17:08:14 +0000 (18:08 +0100)
committerMichael Niedermayer <michael@niedermayer.cc>
Sat, 31 Dec 2016 16:20:06 +0000 (17:20 +0100)
cutoff is implemented as an option global to lavc, but supported only
by a few encoders. This fact is now reflected in its documentation. ac3's
support of this option is added for completeness.

Signed-off-by: Moritz Barsnick <barsnick@gmx.net>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
doc/codecs.texi
doc/encoders.texi

index 9a3a56d..6093605 100644 (file)
@@ -138,7 +138,8 @@ Set audio sampling rate (in Hz).
 Set number of audio channels.
 
 @item cutoff @var{integer} (@emph{encoding,audio})
-Set cutoff bandwidth.
+Set cutoff bandwidth. (Supported only by selected encoders, see
+their respective documentation sections.)
 
 @item frame_size @var{integer} (@emph{encoding,audio})
 Set audio frame size.
index 5e311cb..8137465 100644 (file)
@@ -488,6 +488,10 @@ is an optional AC-3 feature that increases quality by selectively encoding
 the left/right channels as mid/side. This option is enabled by default, and it
 is highly recommended that it be left as enabled except for testing purposes.
 
+@item cutoff @var{frequency}
+Set lowpass cutoff frequency. If unspecified, the encoder selects a default
+determined by various other encoding parameters.
+
 @end table
 
 @subsection Floating-Point-Only AC-3 Encoding Options