[FFmpeg-devel] [PATCH] doc/encoders: Add libopus encoder doc

Stefano Sabatini stefasab at gmail.com
Wed Jul 3 14:33:48 CEST 2013


On date Tuesday 2013-07-02 08:20:43 -0700, Timothy Gu encoded:
> On Tue, Jul 2, 2013 at 1:04 AM, Stefano Sabatini <stefasab at gmail.com> wrote:
> > On date Monday 2013-07-01 13:24:29 -0700, Timothy Gu encoded:
[...]
> >> http://ffmpeg.org/pipermail/ffmpeg-devel/2013-May/144286.html
> >>
> >> Try to actually build the HTML and you will see that this renders better
> >> than you think. Either way I will send a separate patch to normalize all
> >> the behaviors.
> >
> > Looking for example at the libx264 option mapping I see:
> >
> > b       bitrate FFmpeg b option is expressed in bits/s, x264 bitrate in kilobits/s.
> > bf      bframes Maximum number of B-frames.
> >
> > here it is not very clear where the second column terminates and the
> > description starts.
> 
> Exactly. That's why I use 3-column design to limit the width of the
> description column, comparing to the 2-column design used in libx264
> doc.
> 
> > The man output looks a bit better, since the
> > description is put on a separate line. Also what happens if the
> > description can't be contained in the same line?
> 

> You didn't actually did texi2html, did you? I don't want to type all
> the words. The attachment is ffmpeg-codecs.html generated by
> texi2html, see for yourself.

I did, and checked the man and HTML output (in firefox) and what I see
is messy (check attachments). That's why I suggest to keep the syntax
simple, to avoid to confuse the very limited tools in our toolchain.

[...]
> > The second form is not used anywhere, and is probably rendered the
> > same way as the first one but is more verbose, thus I prefer the first
> > form.
> 
> Compare libtwolame, libx264, and my libopus, and decide.

I dislike them all, libtwolame looks the sanest but then I'd prefer to
keep the equivalent option on the same line, rather than (confusingly)
at the beginning of the description.

> a {
>     color: #2D6198;
> }
> 
> a:visited {
>     color: #884488;
> }
> 
> #banner {
>     background-color: white;
>     position: relative;
>     text-align: center;
> }

Why should I read this?
-- 
FFmpeg = Furious Free Maxi Philosofic Elitarian Gargoyle
-------------- next part --------------
A non-text attachment was scrubbed...
Name: snapshot-man.png
Type: image/png
Size: 123857 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130703/9799a116/attachment.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: snapshot-html.jpg
Type: image/jpeg
Size: 30358 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130703/9799a116/attachment.jpg>


More information about the ffmpeg-devel mailing list