[FFmpeg-devel] [PATCH] doc/encoder: document the libfdk-aac wrapper

[Stefano Sabatini]

On date Tuesday 2013-10-29 15:57:31 -0700, Timothy Gu encoded:
> On Oct 29, 2013 1:51 PM, "Stefano Sabatini" <stefasab at gmail.com> wrote:
> >
> > Partially based on the https://trac.ffmpeg.org/wiki/AACEncodingGuide
> > guide.
> > ---
> >  doc/encoders.texi | 148
> +++++++++++++++++++++++++++++++++++++++++++++++++++++-
> >  1 file changed, 146 insertions(+), 2 deletions(-)
> 
> I wanted to do that a long time ago. +1
> 
> >
> > diff --git a/doc/encoders.texi b/doc/encoders.texi
> > index 67f2a39..a0a61f8 100644
> > --- a/doc/encoders.texi
> > +++ b/doc/encoders.texi
> > @@ -38,8 +38,8 @@ As this encoder is experimental, unexpected behavior
> may exist from time to
> >  time. For a more stable AAC encoder, see @ref{libvo-aacenc}. However, be
> warned
> >  that it has a worse quality reported by some users.
> >
> > - at c Comment this out until somebody writes the respective documentation.
> > - at c See also @ref{libfaac}, @ref{libaacplus}, and @ref{libfdk-aac-enc}.
> > + at c todo @ref{libfaac}, @ref{libaacplus}
> > +See also @ref{libfdk-aac-enc,,the libfdk_aac section}.
> >
> >  @subsection Options
> >
> > @@ -494,6 +494,150 @@ Selected by Encoder (default)
> >
> >  @end table
> >
> > + at anchor{libfdk-aac-enc}
> 
> Unrelated to this patch: Should @node is better for these cases? (But don't
> use node in this patch as it will mess up document structure)
> 
> > + at section libfdk_aac
> > +
> > +libfdk-aac AAC (Advanced Audio Coding) encoder wrapper.
> > +
> > +The library is based on the Fraunhofer FDK AAC code from Android
> > +library.
> 
> Android is not a library.
> ...from the Android project.
> 
> > +
> > +Requires the presence of the libfdk-aac headers and library during
> > +configuration. You need to explicitly configure the build with
> > + at code{--enable-libfdk-aac --enable-nonfree}.
> 
> fdk-aac itself is not non free, it's just incompatible to the GPL . You can
> do ./configure --enable-libfdk-aac or ./configure --enable-gpl
> --enable-nonfree --enable-libfdk-aac.

Updated.

[...]
> > +
> > +For SBR in other configurations, use the @option{profile} option.
> 
> Isn't other profiles clearer in this context?

I copied it from the help option message, indeed I don't think it is
very clear. Removed altogether.

[...]
> > + at item vbr
> > +Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty
> > +good) and 5 is highest quality. A value of 0 will disable VBR mode,
> 

> An idea of "still pretty good" should be added (avg bit rate).

Added the table from the wiki/Hydrogenaudio.

[...] 
> Rest looks OK. Nice job!

Thanks, patch updated.

Other changes: added a note that VBR only works with aac_low, removed
confusing flags +qscale / global_quality info, which should be
probably considered deprecated.
-- 
FFmpeg = Fundamentalist & Fast Marvellous Puristic Elegant Gnome
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-doc-encoder-document-the-libfdk-aac-wrapper.patch
Type: text/x-diff
Size: 4804 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20131030/e284aef2/attachment.bin>