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

[Timothy Gu]

On Wed, Aug 28, 2013 at 2:59 PM, Stefano Sabatini <stefasab at gmail.com> wrote:
>
> On date Monday 2013-08-26 16:48:19 -0700, Timothy Gu encoded:
> > On Friday, August 16, 2013, Stefano Sabatini wrote:
> > > On date Wednesday 2013-08-14 17:51:38 -0700, Timothy Gu encoded:
> > > > +
> > > > +The @option{b} and @option{q} are mutually exclusive, as they
> > > > +both set the quality, but refer to two different encoding modes:
> > > > +CBR and VBR. The default is CBR mode (i.e. @option{b} is set).
> > > > +This also applies to @option{bit_rate} and @option{global_quality}.
> > >
> > > This also seems a bit redundant in this specific context since it's
> > > more related to the way the library works in general.
> > >
> >
> > So you mean that this is better off in the shared options chapter?
>
> Ideally we could have a dedicated section explaining the
> bitrate/quality parameters.
>
> > + at item b (@emph{-b})
> > +Set bitrate expressed in bits/s for CBR. LAME @code{bitrate} is
> > +expressed in kilobits/s.
>
> > This option is valid only using the + at command{ffmpeg} command-line
> > tool.
>
> That's not correct, this can be set via libavcodec with
> av_opt_set(avctx, "b", "100k", ...); -> remove

Oops, forgot to remove.

>
>
>
> > +
> > + at item bit_rate (@emph{-b})
> > +Set bitrate expressed in bits/s for CBR. LAME @code{bitrate} is
> > +expressed in kilobits/s. This option is valid only using
> > + at samp{libavcodec} library interface.
>
> Please remove this part altogether, for the reasons I already
> expressed (bit_rate is an AVCodecContext field, but we are only
> documenting AVOption options, which are (mostly) the same for av_opt()
> programmatic interface and the command line).

Oops x 2.

>
>
> > +
> > + at item q (@emph{-V})
> > +Set constant quality setting for VBR.
>
> => This option is valid only using the @command{ffmpeg} command-line tool.

Oops x3.

[...]

Timothy
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-doc-encoders-Reformat-libmp3lame-doc.patch
Type: application/octet-stream
Size: 2456 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130829/374981ee/attachment.obj>