documentation: add encoders chapter
authorJames Zern <jzern@google.com>
Sat, 12 Feb 2011 00:02:45 +0000 (16:02 -0800)
committerJanne Grunau <janne-ffmpeg@jannau.net>
Wed, 16 Feb 2011 23:04:31 +0000 (00:04 +0100)
Signed-off-by: Janne Grunau <janne-ffmpeg@jannau.net>
doc/encoders.texi [new file with mode: 0644]
doc/ffmpeg.texi

diff --git a/doc/encoders.texi b/doc/encoders.texi
new file mode 100644 (file)
index 0000000..cab98fb
--- /dev/null
@@ -0,0 +1,20 @@
+@chapter Encoders
+@c man begin ENCODERS
+
+Encoders are configured elements in FFmpeg which allow the encoding of
+multimedia streams.
+
+When you configure your FFmpeg build, all the supported native encoders
+are enabled by default. Encoders requiring an external library must be enabled
+manually via the corresponding @code{--enable-lib} option. You can list all
+available encoders using the configure option @code{--list-encoders}.
+
+You can disable all the encoders with the configure option
+@code{--disable-encoders} and selectively enable / disable single encoders
+with the options @code{--enable-encoder=@var{ENCODER}} /
+@code{--disable-encoder=@var{ENCODER}}.
+
+The option @code{-codecs} of the ff* tools will display the list of
+enabled encoders.
+
+@c man end ENCODERS
index 8b8e42f..f0f3b65 100644 (file)
@@ -981,6 +981,7 @@ file to which you want to add them.
 @c man end EXAMPLES
 
 @include eval.texi
+@include encoders.texi
 @include demuxers.texi
 @include muxers.texi
 @include indevs.texi