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

[Timothy Gu]

On May 28, 2013 9:48 AM, "Stefano Sabatini" <stefasab at gmail.com> wrote:
>
> On date Sunday 2013-05-26 14:27:30 -0700, Timothy Gu encoded:
> > ---
> >  doc/encoders.texi | 79
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 79 insertions(+)
> >
> > diff --git a/doc/encoders.texi b/doc/encoders.texi
> > index a2c5eb0..acbdcd7 100644
> > --- a/doc/encoders.texi
> > +++ b/doc/encoders.texi
> > @@ -441,6 +441,85 @@ 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
>
> "It requires" or "This encoder requires" ...
>
> > +configuration. You need to explicitly configure the build with
> > + at code{--enable-libtwolame}.
> > +
> > + at subsection Options Mapping
> > +
>
> > +The following public options are supported by the libtwolame
> > +wrapper. The FFmpeg options are in parantheses, while the TwoLAME
> > +options are under the FFmpeg options.
>
> This is confusing, also what parentheses?

I mean quotation marks.

>
> I suggest to show the supported options in a single list, including
> overriden shared options and private ones. You could show the name of
> corresponding libtwolame option in parentheses, like in:
>
> @item q (V)
>
> > +
> > + at table @option
>
> > + at item b
> > +b
> > +
> > +FFmpeg @code{b} option is expressed in bits/s, twolame @code{bitrate}
> > +in kilobits/s.
> > +
>
> It is not very clear what this option really accepts (bits/s or
> kilobits/s?).
>
> > + at item q
> > +V
> > +
> > +Quality setting for experimental VBR support. Maximum value range is
>
> Use verbal form to describe what an option *does*, not what the
> parameter *is*. In this case:
>
> Set quality setting for ...
>
> > +-50 to 50 but useful rage is -10 to 10.
>
> range
>
> > +
> > + at end table
> > +
> > +The following private options are supported by the libtwolame
> > +wrapper.
> > +
> > + at table @option
> > + at item mode
> > +mode
> > +
>
> > +MPEG mode. Available options:
>
> Set MPEG mode. ...
>
> > +
> > + at table @samp
> > + at item auto
> > +Choose mode automatically based on the input
>
> missing dot
>
> > + 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
> > +
>
> > +Psychoacoustic model. Valid argument: -1 to 4. The higher the
> > +value, the better the quality.
>
> Set psychoacoustic model. The argument must be an integer value from
> -1 to 4. The higher the value, the better the quality.
>
> > +
> > + at item energy_levels
> > +energy
> > +
> > +Enable energy levels extensions.
>
> What's the argument?
>
> > +
> > + at item error_protection
> > +protect
> > +
> > +Enable CRC error protection.
> > +
> > + at item copyright
> > +copyright
> > +
> > +Set MPEG audio copyright flag.
> > +
> > + at item original
> > +original
> > +
> > +Set MPEG audio original flag.
>
> Same here, what are the supported arguments? Are they 1/0.
>
> [...]
>
> Thanks.

OK, I'll fix these problems when I have time.

Timothy