[FFmpeg-devel,2/2] doc/encoders: remove mentions of the x264opts AVOption

Submitted by Jan Ekström on March 6, 2017, 10:20 p.m.

Details

Message ID 20170306222021.17917-3-jeebjp@gmail.com
State New
Headers show

Commit Message

Jan Ekström March 6, 2017, 10:20 p.m.
---
 doc/encoders.texi | 25 ++++++-------------------
 1 file changed, 6 insertions(+), 19 deletions(-)

Comments

Marton Balint March 6, 2017, 10:44 p.m.
On Tue, 7 Mar 2017, Jan Ekström wrote:

> ---
> doc/encoders.texi | 25 ++++++-------------------
> 1 file changed, 6 insertions(+), 19 deletions(-)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 594c612..ee28b9b 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1762,9 +1762,9 @@ for detail retention (adaptive quantization, psy-RD, psy-trellis).
> 
> Many libx264 encoder options are mapped to FFmpeg global codec
> options, while unique encoder options are provided through private
> -options. Additionally the @option{x264opts} and @option{x264-params}
> -private options allows one to pass a list of key=value tuples as accepted
> -by the libx264 @code{x264_param_parse} function.
> +options. Additionally the @option{x264-params} private option allows one
> +to pass a list of key=value tuples as accepted by the libx264
> +@code{x264_param_parse} function.
> 
> The x264 project website is at
> @url{http://www.videolan.org/developers/x264.html}.
> @@ -2094,19 +2094,6 @@ 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.
> -
> -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.
> -
> -For example to specify libx264 encoding options with @command{ffmpeg}:
> -@example
> -ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
> -@end example
> -
> @item a53cc @var{boolean}
> Import closed captions (which must be ATSC compatible format) into output.
> Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
> @@ -2115,11 +2102,11 @@ Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
> Override the x264 configuration using a :-separated list of key=value
> parameters.
> 
> -This option is functionally the same as the @option{x264opts}, but is
> -duplicated for compatibility with the Libav fork.
> -
> For example to specify libx264 encoding options with @command{ffmpeg}:
> @example
> +ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv

I guess you meant to convert this to -x264-params as well, no?

Thanks,
Marton
Jan Ekström March 6, 2017, 10:52 p.m.
On Tue, Mar 7, 2017 at 12:44 AM, Marton Balint <cus@passwd.hu> wrote:
> I guess you meant to convert this to -x264-params as well, no?
>
> Thanks,
> Marton

Yup, welcome to doing things after midnight.

Jan

Patch hide | download patch | download mbox

diff --git a/doc/encoders.texi b/doc/encoders.texi
index 594c612..ee28b9b 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1762,9 +1762,9 @@  for detail retention (adaptive quantization, psy-RD, psy-trellis).
 
 Many libx264 encoder options are mapped to FFmpeg global codec
 options, while unique encoder options are provided through private
-options. Additionally the @option{x264opts} and @option{x264-params}
-private options allows one to pass a list of key=value tuples as accepted
-by the libx264 @code{x264_param_parse} function.
+options. Additionally the @option{x264-params} private option allows one
+to pass a list of key=value tuples as accepted by the libx264
+@code{x264_param_parse} function.
 
 The x264 project website is at
 @url{http://www.videolan.org/developers/x264.html}.
@@ -2094,19 +2094,6 @@  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.
-
-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.
-
-For example to specify libx264 encoding options with @command{ffmpeg}:
-@example
-ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
-@end example
-
 @item a53cc @var{boolean}
 Import closed captions (which must be ATSC compatible format) into output.
 Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
@@ -2115,11 +2102,11 @@  Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
 Override the x264 configuration using a :-separated list of key=value
 parameters.
 
-This option is functionally the same as the @option{x264opts}, but is
-duplicated for compatibility with the Libav fork.
-
 For example to specify libx264 encoding options with @command{ffmpeg}:
 @example
+ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
+@end example
+@example
 ffmpeg -i INPUT -c:v libx264 -x264-params 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 OUTPUT