[FFmpeg-devel] [PATCH] encoders.texi: add documentation for the libx264 encoder

Stefano Sabatini stefano.sabatini-lala at poste.it
Thu May 19 21:30:46 CEST 2011


Also remov -x264opts item from the ffmpeg manual, since it belongs
to the encoders section.
---
 doc/encoders.texi |   63 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/ffmpeg.texi   |    7 ------
 2 files changed, 63 insertions(+), 7 deletions(-)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index a7193a6..9f9e9a9 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -370,3 +370,66 @@ is highly recommended that it be left as enabled except for testing purposes.
 @end table
 
 @c man end AUDIO ENCODERS
+
+ at chapter Video Encoders
+ at c man begin VIDEO ENCODERS
+
+A description of some of the currently available video encoders
+follows.
+
+ at section libx264
+
+H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 format supported through
+libx264.
+
+Requires the presence of the libx64 headers and library during
+configuration. You need to explicitely configure the build with
+ at code{--enable-libx264}.
+
+ at subsection Options
+
+ at table @option
+
+ at item preset @var{preset_name}
+Set the encoding preset.
+
+ at item tune @var{tune_name}
+Tune the encoding params.
+Deprecated in favor of @var{x264_opts}
+
+ at item fastfirstpass @var{bool}
+Use fast settings when encoding first pass, default value is 1.
+Deprecated in favor of @var{x264_opts}.
+
+ at item profile @var{profile_name}
+Set profile restrictions.
+Deprecated in favor of @var{x264_opts}.
+
+ at item level @var{level}
+Specify level (as defined by Annex A).
+Deprecated in favor of @var{x264_opts}.
+
+ at item passlogfile @var{filename}
+Specify filename for 2 pass stats.
+Deprecated in favor of @var{x264_opts}.
+
+ at item wpredp @var{wpred_type}
+Specify Weighted prediction for P-frames.
+Deprecated in favor of @var{x264_opts}.
+
+ at item x264opts @var{options}
+Allow to set any x264 option, see x264 manual for a list.
+
+ at var{options} is a list of @var{key}=@var{value} couples separated by
+":".
+ at end table
+
+For example to specify libx264 encoding options with @file{ffmpeg}:
+ at example
+ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
+ at end example
+
+For more information about libx264 and the supported options see:
+ at url{http://www.videolan.org/developers/x264.html}
+
+ at c man end VIDEO ENCODERS
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 8464251..3776e69 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -312,13 +312,6 @@ the input video.
 Use the option "-filters" to show all the available filters (including
 also sources and sinks).
 
- at item -x264opts @var{option}
-Allows you to set any x264 option, see x264 manual for a list.
- at example
-ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
- at end example
-
-
 @end table
 
 @section Advanced Video Options
-- 
1.7.2.3



More information about the ffmpeg-devel mailing list