Re: [FFmpeg-devel] [PATCH 1/3] doc/encoders/libx264: review and extend option description
On date Sunday 2023-11-19 12:34:09 +0100, Stefano Sabatini wrote: > On date Saturday 2023-11-04 22:26:27 +0100, Stefano Sabatini wrote: [...] > > From a11eafe5a61a572f4e9ab9e4ab9907bba98300e4 Mon Sep 17 00:00:00 2001 > > From: Stefano Sabatini > > 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. Applied. ___ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
Re: [FFmpeg-devel] [PATCH 1/3] doc/encoders/libx264: review and extend option description
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.
> > > +@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:
> > > +@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
> > > +@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
> > > +@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
> 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.
___
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
Re: [FFmpeg-devel] [PATCH 1/3] doc/encoders/libx264: review and extend option description
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.
> > +@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:
> > +@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
> > +@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
> > +@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
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(-)
diff --git a/doc/encoders.texi b/doc/encoders.texi
index 8b2ab937d1..f2aba10627 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -2421,6 +2421,10 @@ To get a more accurate and extensive documentation of the libx264
options, invoke the command @command{x264 --fullhelp} or consult
the libx264 documentation.
+In the list below, note that the @command{x264} option name is shown
+in parentheses after the libavcodec corresponding name, in case there
+is a direct mapping.
+
@table @option
@item b (@emph{bitrate})
Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
@@ -2428,17 +2432,19 @@ expressed in bits/s, while @command{x264}'s @option{bitrate} is in
kilobits/s.
@item bf (@emph{bframes})
+Number of B-frames between I and P-frames
@item g (@emph{keyint})
+Maximum GOP size
@item qmin (@emph{qpmin})
-Minimum quantizer scale.
+Minimum quantizer scale
@item qmax (@emph{qpmax})
-Maximum quantizer scale.
+Maximum quantizer scale
@item qdiff (@emph{qpstep})
-Maximum difference between quantizer scales.
+Maximum difference between quantizer scales
@item qblur (@emph{qblur})
Quantizer curve blur
@@ -2447,7 +2453,7 @@ Quantizer curve blur
Quantizer curve compression factor
@item refs (@emph{ref})
-Number of reference frames each P-frame can use. The range is from @var{0-16}.
+Number of reference frames each P-frame can use. The range is @var{0-16}.
@item level (@emph{level})
Set the @code{x264_param_t.i_level_idc} value in case the value is
@@ -2469,7 +2475,8 @@ Sets the threshold for the scene change detection.
@item trellis (@emph{trellis})
Performs Trellis quantization to increase efficiency. Enabled by default.
-@item nr (@emph{nr})
+@item nr (@emph{nr})
+Noise reduction
@item me_range (@emph{merange})
Maximum range of the motion search in pixels.
@@ -2550,6 +2557,7 @@ open GOP by setting it to @code{-cgop}. The result is similar to
the behavior of @command{x264}'s @option{--open-gop} option.
@item rc_init_occupancy (@emph{vbv-init})
+Initial VBV buffer occupancy
@item preset (@emph{preset})
Set the encoding preset.
@@ -2595,7 +2603,7 @@ Set AQ strength, reduce blocking and blurring in flat and textured areas.
Use psychovisual optimizations when set to 1. When set to 0, it has the
same effect as @command{x264}'s @option{--no-psy} option.
-@item psy-rd (@emph{psy-rd})
+@item psy-rd (@emph{psy-rd})
Set strength of psychovisual optimization, in
@var{psy-rd}:@var{psy-trellis} format.
@@ -2627,7 +2635,7 @@ to 1.
@item avcintra-class (@emph{class})
Configure the encoder to generate AVC-Intra.
-Valid values are 50,100 and 200
+Valid values are 50, 100 and 200
@item bluray-compat (@emph{bluray-compat})
Configure the encoder to be compatible with the bluray standard.
@@ -2678,8 +2686,8 @@ Set loop filter parameters, in @var{alpha}:@var{beta} form.
Set
Re: [FFmpeg-devel] [PATCH 1/3] doc/encoders/libx264: review and extend option description
On 2023-08-26 06:40 am, Stefano Sabatini wrote:
Also, merge x264opts and x264-opts option docs to avoid duplication
and make it even more clearer they provide the same functionality.
---
doc/encoders.texi | 66 ++-
1 file changed, 37 insertions(+), 29 deletions(-)
diff --git a/doc/encoders.texi b/doc/encoders.texi
index 6f8f5e127e..947b0c3320 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -2418,6 +2418,10 @@ To get a more accurate and extensive documentation of
the libx264
options, invoke the command @command{x264 --fullhelp} or consult
the libx264 documentation.
+In the list below, note that the @command{x264} option name is shown
+in parentheses after the libavcodec corresponding name, in case there
+is a direct mapping.
+
@table @option
@item b (@emph{bitrate})
Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
@@ -2425,17 +2429,19 @@ expressed in bits/s, while @command{x264}'s
@option{bitrate} is in
kilobits/s.
@item bf (@emph{bframes})
+Number of B-frames between I and P-frames
@item g (@emph{keyint})
+Maximum GOP size
@item qmin (@emph{qpmin})
-Minimum quantizer scale.
+Minimum quantizer scale
@item qmax (@emph{qpmax})
-Maximum quantizer scale.
+Maximum quantizer scale
@item qdiff (@emph{qpstep})
-Maximum difference between quantizer scales.
+Maximum difference between quantizer scales
@item qblur (@emph{qblur})
Quantizer curve blur
@@ -2444,7 +2450,7 @@ Quantizer curve blur
Quantizer curve compression factor
@item refs (@emph{ref})
-Number of reference frames each P-frame can use. The range is from @var{0-16}.
+Number of reference frames each P-frame can use. The allowed range is
@var{0-16}.
Allowed is implicit in the statement. Also, most statements of range
don't contain allow so prefer to keep it consistent.
@item sc_threshold (@emph{scenecut})
Sets the threshold for the scene change detection.
@@ -2452,7 +2458,8 @@ Sets the threshold for the scene change detection.
@item trellis (@emph{trellis})
Performs Trellis quantization to increase efficiency. Enabled by default.
-@item nr (@emph{nr})
+@item nr (@emph{nr})
+Noise reduction
@item me_range (@emph{merange})
Maximum range of the motion search in pixels.
@@ -2533,6 +2540,7 @@ open GOP by setting it to @code{-cgop}. The result is
similar to
the behavior of @command{x264}'s @option{--open-gop} option.
@item rc_init_occupancy (@emph{vbv-init})
+Initial VBV buffer occupancy
@item preset (@emph{preset})
Set the encoding preset.
@@ -2578,7 +2586,7 @@ Set AQ strength, reduce blocking and blurring in flat and
textured areas.
Use psychovisual optimizations when set to 1. When set to 0, it has the
same effect as @command{x264}'s @option{--no-psy} option.
-@item psy-rd (@emph{psy-rd})
+@item psy-rd (@emph{psy-rd})
Set strength of psychovisual optimization, in
@var{psy-rd}:@var{psy-trellis} format.
@@ -2610,7 +2618,7 @@ to 1.
@item avcintra-class (@emph{class})
Configure the encoder to generate AVC-Intra.
-Valid values are 50,100 and 200
+Valid values are 50, 100 and 200
@item bluray-compat (@emph{bluray-compat})
Configure the encoder to be compatible with the bluray standard.
@@ -2661,8 +2669,8 @@ Set loop filter parameters, in @var{alpha}:@var{beta}
form.
Set fluctuations reduction in QP (before curve compression).
@item partitions (@emph{partitions})
-Set partitions to consider as a comma-separated list of. Possible
-values in the list:
+Set partitions to consider as a comma-separated list of
+values. Possible values in the list:
@table @samp
@item p8x8
@@ -2718,19 +2726,33 @@ Variable bit rate.
Constant bit rate (not allowed in MP4 container).
@end table
-@item x264opts (N.A.)
-Set any x264 option, see @command{x264 --fullhelp} for a list.
+@item x264opts @var{opts}
+@item x264-params @var{opts}
+Override the x264 configuration using a :-separated list of key=value
+options.
-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.
+@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.
+
+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:
+@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
Re: [FFmpeg-devel] [PATCH 1/3] doc/encoders/libx264: review and extend option description
On date Saturday 2023-08-26 03:10:28 +0200, Stefano Sabatini wrote: > Also, merge x264opts and x264-opts option docs to avoid duplication > and make it even more clearer they provide the same functionality. > --- > doc/encoders.texi | 66 ++- > 1 file changed, 37 insertions(+), 29 deletions(-) Ping on the patchset. ___ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
[FFmpeg-devel] [PATCH 1/3] doc/encoders/libx264: review and extend option description
Also, merge x264opts and x264-opts option docs to avoid duplication
and make it even more clearer they provide the same functionality.
---
doc/encoders.texi | 66 ++-
1 file changed, 37 insertions(+), 29 deletions(-)
diff --git a/doc/encoders.texi b/doc/encoders.texi
index 6f8f5e127e..947b0c3320 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -2418,6 +2418,10 @@ To get a more accurate and extensive documentation of
the libx264
options, invoke the command @command{x264 --fullhelp} or consult
the libx264 documentation.
+In the list below, note that the @command{x264} option name is shown
+in parentheses after the libavcodec corresponding name, in case there
+is a direct mapping.
+
@table @option
@item b (@emph{bitrate})
Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
@@ -2425,17 +2429,19 @@ expressed in bits/s, while @command{x264}'s
@option{bitrate} is in
kilobits/s.
@item bf (@emph{bframes})
+Number of B-frames between I and P-frames
@item g (@emph{keyint})
+Maximum GOP size
@item qmin (@emph{qpmin})
-Minimum quantizer scale.
+Minimum quantizer scale
@item qmax (@emph{qpmax})
-Maximum quantizer scale.
+Maximum quantizer scale
@item qdiff (@emph{qpstep})
-Maximum difference between quantizer scales.
+Maximum difference between quantizer scales
@item qblur (@emph{qblur})
Quantizer curve blur
@@ -2444,7 +2450,7 @@ Quantizer curve blur
Quantizer curve compression factor
@item refs (@emph{ref})
-Number of reference frames each P-frame can use. The range is from @var{0-16}.
+Number of reference frames each P-frame can use. The allowed range is
@var{0-16}.
@item sc_threshold (@emph{scenecut})
Sets the threshold for the scene change detection.
@@ -2452,7 +2458,8 @@ Sets the threshold for the scene change detection.
@item trellis (@emph{trellis})
Performs Trellis quantization to increase efficiency. Enabled by default.
-@item nr (@emph{nr})
+@item nr (@emph{nr})
+Noise reduction
@item me_range (@emph{merange})
Maximum range of the motion search in pixels.
@@ -2533,6 +2540,7 @@ open GOP by setting it to @code{-cgop}. The result is
similar to
the behavior of @command{x264}'s @option{--open-gop} option.
@item rc_init_occupancy (@emph{vbv-init})
+Initial VBV buffer occupancy
@item preset (@emph{preset})
Set the encoding preset.
@@ -2578,7 +2586,7 @@ Set AQ strength, reduce blocking and blurring in flat and
textured areas.
Use psychovisual optimizations when set to 1. When set to 0, it has the
same effect as @command{x264}'s @option{--no-psy} option.
-@item psy-rd (@emph{psy-rd})
+@item psy-rd (@emph{psy-rd})
Set strength of psychovisual optimization, in
@var{psy-rd}:@var{psy-trellis} format.
@@ -2610,7 +2618,7 @@ to 1.
@item avcintra-class (@emph{class})
Configure the encoder to generate AVC-Intra.
-Valid values are 50,100 and 200
+Valid values are 50, 100 and 200
@item bluray-compat (@emph{bluray-compat})
Configure the encoder to be compatible with the bluray standard.
@@ -2661,8 +2669,8 @@ Set loop filter parameters, in @var{alpha}:@var{beta}
form.
Set fluctuations reduction in QP (before curve compression).
@item partitions (@emph{partitions})
-Set partitions to consider as a comma-separated list of. Possible
-values in the list:
+Set partitions to consider as a comma-separated list of
+values. Possible values in the list:
@table @samp
@item p8x8
@@ -2718,19 +2726,33 @@ Variable bit rate.
Constant bit rate (not allowed in MP4 container).
@end table
-@item x264opts (N.A.)
-Set any x264 option, see @command{x264 --fullhelp} for a list.
+@item x264opts @var{opts}
+@item x264-params @var{opts}
+Override the x264 configuration using a :-separated list of key=value
+options.
-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.
+@option{x264-param} is functionally the same as the @option{x264opts},
+but is duplicated for compatibility with the Libav fork.
+
+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:
+@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
+@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
+@command{x264 --fullhelp} or consult the libx264 documentation.
+
@item a53cc
