[FFmpeg-devel] [PATCH] doc/encoders: Add documentation for libmp3lame

[Timothy Gu]

On Fri, May 24, 2013 at 12:28 PM, Timothy Gu <timothygu99 at gmail.com> wrote:
> ---
>  doc/encoders.texi | 29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 79a13ee..a2c5eb0 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -412,6 +412,35 @@ Selected by Encoder (default)
>
>  @end table
>
> + at section libmp3lame
> +
> +LAME (Lame Ain't an MP3 Encoder) MP3 encoder wrapper
> +
> +Requires the presence of the libmp3lame headers and library during
> +configuration. You need to explicitly configure the build with
> + at code{--enable-libmp3lame}.
> +
> + at subsection Option Mapping
> +
> +The following options are supported by the libmp3lame wrapper,
> +the LAME-equivalent options follow the FFmpeg ones.
> +
> + at multitable @columnfractions .2 .2
> + at item FFmpeg            @tab LAME
> + at item b                 @tab b
> +FFmpeg @code{b} option is expressed in bits/s, lame @code{bitrate}
> +in kilobits/s.
> + at item q                 @tab V
> +Quality setting for VBR.
> + at item compression_level @tab q
> +Algorithm quality. Valid options are integers from 0-9.
> + at item reservoir         @tab N.A.
> +Enable use of bit reservoir. LAME has this enabled by default.
> + at item joint_stereo      @tab -m j
> +Enables the the encoder to use (on a frame by frame basis) either L/R
> +stereo or mid/side stereo.
> + at end multitable
> +
>  @c man end AUDIO ENCODERS
>
>  @chapter Video Encoders
> --
> 1.8.1.2
>

Is this patch okay or do I need some extra work? (Or should I open a
new thread?)
I have no experiences in working with git or sending patches to open
source software mailing lists, so sorry if I did something wrong.

Timothy G