[FFmpeg-devel] [PATCH] doc/encoders: Add libopus encoder doc

[Stefano Sabatini]

On date Thursday 2013-07-04 19:20:46 -0700, Timothy Gu encoded:
> ---
>  doc/encoders.texi | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 73 insertions(+)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index afe4952..350648d 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -600,6 +600,79 @@ default value is 0 (disabled).
>  
>  @end table
>  
> + at section libopus
> +
> +libopus Opus Interactive Audio Codec encoder wrapper.
> +
> +Requires the presence of the libopus headers and library during
> +configuration. You need to explicitly configure the build with
> + at code{--enable-libopus}.
> +
> + at subsection Option Mapping
> +
> +Most libopus options are modeled after the @command{opusenc} utility from
> +opus-tools. The following is an option mapping chart describing options
> +supported by the libopus wrapper, and their @command{opusenc}-equivalent
> +in parentheses.
> +
> + at table
> +
> + at item @option{b} (@emph{bitrate})
> +Set the bit rate in bits/s.  FFmpeg's @option{b} option is
> +expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
> +kilobits/s.
> +
> + at item @option{vbr} (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
> +Set VBR mode. The FFmpeg @option{vbr} option has the following
> +valid arguments, with the their @command{opusenc} equivalent in
> +parentheses:
> +

> + at table
> + at item @samp{off} (@emph{hard-cbr})
> +Use constant bit rate encoding.
> +
> + at item @samp{on} (@emph{vbr})
> +Use variable bit rate encoding (the default).
> +
> + at item @samp{constrained} (@emph{cvbr})
> +Use constrained variable bit rate encoding.
> + at end table

@table @samp
@item off (@emph{hard-cbr})
...

[...]

Looks nice otherwise, thanks.
-- 
FFmpeg = Furious Fundamental Minimalistic Portentous Exciting Genius