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

[Stefano Sabatini]

On date Tuesday 2013-05-28 13:16:46 -0700, Timothy Gu encoded:
> ---
>  doc/encoders.texi | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 61 insertions(+)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index a2c5eb0..6e63edf 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -441,6 +441,67 @@ 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. (Default: 128k.)

Please check how it is done in the libmp3lame and libx264 sections, in
order to keep some consistency in the document.

> +
> + at item q
> +(V) Set quality for experimental VBR support. Maximum value range is -50
> +to 50 but useful range is -10 to 10.

Maximum value range is from -50 to 50, useful range is from -10 to 10.

sounds slightly better to my non native ears. Also you may mention
what is the direction of the quality values (e.g. higher values will
set a higher quality).

> +
> + at item mode

> +(mode) Set MPEG mode. Available options:

nit: Available options -> 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
> +
> + 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. Default: 3.

Default value is 3 (contracted forms are not easier to read,
especially for readers with no much English familiarity). Same below.

> +
> + at item energy_levels
> +(energy) Set argument to 1 to enable energy levels extensions, and 0
> +to disable it. Default: 0 (disabled).
> +
> + at item error_protection
> +(protect) Set argument to 1 to enable CRC error protection, and 0 to
> +disable it. Default: 0 (disabled).
> +
> + at item copyright
> +(copyright) Set argument to 1 to set MPEG audio copyright flag.
> +Default: 0 (disabled).
> +
> + at item original
> +(original) Set argument to 1 to set MPEG audio original flag.
> +Default: 0 (disabled).
[...]
-- 
FFmpeg = Fundamental Faithless Mournful Peaceful Enchanting Game