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

[Stefano Sabatini]

On date Saturday 2023-11-04 22:26:27 +0100, Stefano Sabatini wrote:
> 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).
> 

> From a11eafe5a61a572f4e9ab9e4ab9907bba98300e4 Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Sat, 26 Aug 2023 01:10:09 +0200
> Subject: [PATCH] doc/encoders/libx264: review and extend option description
> 
> Also, merge x264opts and x264-opts option docs to avoid duplication
> and make it clearer that they provide mostly the same functionality.
> ---
>  doc/encoders.texi | 65 ++++++++++++++++++++++++++---------------------
>  1 file changed, 36 insertions(+), 29 deletions(-)

Will apply in a few days if I see no comments.