[FFmpeg-devel] [PATCH 1/2] doc/encoders: Reformat libmp3lame doc

[Stefano Sabatini]

On date Saturday 2013-08-03 16:56:41 -0700, Timothy Gu encoded:
> ---
>  doc/encoders.texi | 38 +++++++++++++++++++++++---------------
>  1 file changed, 23 insertions(+), 15 deletions(-)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 727549f..cdbe0bf 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -420,26 +420,34 @@ Requires the presence of the libmp3lame headers and library during
>  configuration. You need to explicitly configure the build with
>  @code{--enable-libmp3lame}.
>  
> - at subsection Option Mapping
> + at subsection Options
>  
> -The following options are supported by the libmp3lame wrapper,
> -the LAME-equivalent options follow the FFmpeg ones.

> +The following options are supported by the libmp3lame wrapper. The 

Trailing space.

> + at command{lame}-equivalent of the options are listed in parentheses.
>  
> - at multitable @columnfractions .2 .2
> - at item FFmpeg            @tab LAME
> - at item b                 @tab b
> + at table @option
> + at item b (@emph{-b})
>  Set bitrate expressed in bits/s, LAME @code{bitrate} is expressed in
>  kilobits/s.
> - at item q                 @tab V
> -Set quality setting for VBR.
> - at item compression_level @tab q
> -Set algorithm quality. Valid arguments are integers in the 0-9 range.
> - at item reservoir         @tab N.A.
> -Enable use of bit reservoir. LAME has this enabled by default.
> - at item joint_stereo      @tab -m j
> +

> + at item q (@emph{-V})
> +Set constant quality setting for VBR.

I see no "q" option in libmp3lame, maybe it's better to use the
libavcodec equivalent option (q is an ffmpeg tool specific option,
this documentation strives to be generic enough for the library user).

> +
> + at item compression_level (@emph{-q})
> +Set algorithm quality. Valid arguments are integers in the 0-9 range,
> +with 0 meaning highest quality but slowest, and 9 meaning fastest
> +while producing the worst quality.
> +

> + at item reservoir
> +Enable use of bit reservoir when set to 1. Default is enabled. LAME

Default value is 1.

More explicit, less confusing.

> +has this enabled by default, but can be overriden by use
> + at option{--nores} option.
> +
> + at item joint_stereo (@emph{-m j})
>  Enable the encoder to use (on a frame by frame basis) either L/R
> -stereo or mid/side stereo.
> - at end multitable
> +stereo or mid/side stereo. Default is enabled.

Default value is 1.

> +
> + at end table

LGTM otherwise, thanks.
-- 
FFmpeg = Free Forgiving Multimedia Portable Eccentric Geisha