[FFmpeg-devel] [PATCH 1/3] doc/encoders/libx264: review and extend option description

[Stefano Sabatini]

On date Wednesday 2023-09-06 11:04:49 +0530, Gyan Doshi wrote:
[...]

Sorry for the slow reply.

> > -Argument is a list of @var{key}=@var{value} couples separated by
> > -":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
> > -themselves, use "," instead. They accept it as well since long ago but this
> > -is kept undocumented for some reason.
> > + at option{x264-param} is functionally the same as the @option{x264opts},
> > +but is duplicated for compatibility with the Libav fork.
> 
> There is a difference, in that x264opts accepts boolean args without a
> value.

Right.

> > +
> > +The argument for both options is a list of @var{key}=@var{value}
> > +couples separated by ":". In @var{filter} and @var{psy-rd} options
> > +that use ":" as a separator themselves, use "," instead. They accept
> > +it as well since long ago but this is kept undocumented for some
> > +reason.
> > +
> > +For example, the options might be provided as:
> > + at example
> > +level=30:bframes=0:weightp=0:cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:no-fast-pskip=1:subq=6:8x8dct=0:trellis=0
> > + at end example
> >   For example to specify libx264 encoding options with @command{ffmpeg}:
> >   @example
> >   ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
> >   @end example
> > +To get the complete list of the libx264 options, invoke the command
> > + at command{x264 --fullhelp} or consult the libx264 documentation.
> 

> May want to make it clear that x264 refers to the standalone CLI tool.

Isn't that clear enough? (we use the same formula in other places,
e.g. in x265 docs).

-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-doc-encoders-libx264-review-and-extend-option-descri.patch
Type: text/x-diff
Size: 6214 bytes
Desc: not available
URL: <https://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20231104/bb9b4134/attachment.patch>