[FFmpeg-devel] [PATCH] doc/encoders: Add libtwolame doc

[Stefano Sabatini]

On date Tuesday 2013-05-28 15:53:25 -0700, Timothy Gu encoded:
> ---
>  doc/encoders.texi | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 63 insertions(+)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index a2c5eb0..20ec849 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -441,6 +441,69 @@ Enables the the encoder to use (on a frame by frame basis) either L/R
>  stereo or mid/side stereo.
>  @end multitable
>  
> + at section libtwolame
> +
> +TwoLAME MP2 encoder wrapper
> +
> +Requires the presence of the libtwolame headers and library during
> +configuration. You need to explicitly configure the build with
> + at code{--enable-libtwolame}.
> +
> + at subsection Options Mapping
> +
> +The following options are supported by the libtwolame wrapper. The
> +FFmpeg options are in quotation marks, while the TwoLAME options are
> +in parentheses.
> +

> + at table @option
> + at item b
> +(b) Set bitrate in bits/s. Note that FFmpeg @code{b} option is

I'd still prefer the form used in libmp3lame:
@item b                 @tab b

> +expressed in bits/s, twolame @code{bb} in kilobits/s. (The default
> +value is 128k.)
> +
> + at item q
> +(V) Set quality for experimental VBR support. Maximum value range is
> +from -50 to 50, useful range is from -10 to 10.
> +
> + at item mode
> +(mode) Set MPEG mode. Available values:
> +
> + at table @samp
> + at item auto
> +Choose mode automatically based on the input. (This is the default.)
> + at item stereo

> +Stereo.
> + at item joint_stereo
> +Joint stereo.
> + at item dual_channel
> +Dual channel.
> + at item mono
> +Mono.
> + at end table

Nit: for non complete sentences the trailing dot can be skipped

> +
> + at item psymodel
> +(psyc-mode) Set psychoacoustic model to use in encoding. The argument
> +must be an integer between -1 and 4, inclusive. The higher the value,
> +the better the quality. The default value is 3.
> +

> + at item energy_levels
> +(energy) Set argument to 1 to enable energy levels extensions, and 0
> +to disable it. The default value is 0 (disabled).

Set argument to 1 to enable energy levels extensions...

=> This form is providing instructions for using the option, rather
than describing what the option does. While it is not incorrect, it is
not consistent with the other descriptions.

A shorter variant:
Enable energy levels extensions when set to 1. The default value is 0
(disabled).

Same below.

> +
> + at item error_protection
> +(protect) Set argument to 1 to enable CRC error protection, and 0 to
> +disable it. The default value is 0 (disabled).
> +
> + at item copyright
> +(copyright) Set argument to 1 to set MPEG audio copyright flag.
> +The default value is 0 (disabled).
> +
> + at item original
> +(original) Set argument to 1 to set MPEG audio original flag.
> +The default value is 0 (disabled).
[...]

No more comments from me. Thank you.
-- 
FFmpeg = Fast and Friendly Murdering Practical Ecumenical God