[FFmpeg-devel,2/2] doc: document cutoff option to ac3 and adjust the option's global documentation

Submitted by Moritz Barsnick on Dec. 30, 2016, 5:08 p.m.

Details

Message ID 29dcc737048bd133618c9ac16e7ad0f9665c808a.1483105395.git.barsnick@gmx.net
State Accepted
Commit 5dbce5120b4e05dd6d784e7ed9921c1f276acea3
Headers show

Commit Message

Moritz Barsnick Dec. 30, 2016, 5:08 p.m.
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>
---
 doc/codecs.texi   | 3 ++-
 doc/encoders.texi | 4 ++++
 2 files changed, 6 insertions(+), 1 deletion(-)

Comments

Steven Liu Jan. 1, 2017, 2:39 p.m.
2016-12-31 1:08 GMT+08:00 Moritz Barsnick <barsnick@gmx.net>:

> 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>
> ---
>  doc/codecs.texi   | 3 ++-
>  doc/encoders.texi | 4 ++++
>  2 files changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/doc/codecs.texi b/doc/codecs.texi
> index 9a3a56d..6093605 100644
> --- a/doc/codecs.texi
> +++ b/doc/codecs.texi
> @@ -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.
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 5e311cb..8137465 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -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
> --
> 2.7.4
>
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>

LTGM, Thanks!

Patch hide | download patch | download mbox

diff --git a/doc/codecs.texi b/doc/codecs.texi
index 9a3a56d..6093605 100644
--- a/doc/codecs.texi
+++ b/doc/codecs.texi
@@ -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.
diff --git a/doc/encoders.texi b/doc/encoders.texi
index 5e311cb..8137465 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -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