aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Zern <jzern@google.com>2011-02-11 16:02:45 -0800
committerJanne Grunau <janne-ffmpeg@jannau.net>2011-02-17 00:04:31 +0100
commit0fa904c9d845d4a47372e619067e21991bb39b06 (patch)
tree90243a98ce289eed8f2a8de30711bb71005230eb
parent009026efb1e3b3a5f05fd9934019a6300b25f364 (diff)
downloadffmpeg-0fa904c9d845d4a47372e619067e21991bb39b06.tar.gz
documentation: add encoders chapter
Signed-off-by: Janne Grunau <janne-ffmpeg@jannau.net>
-rw-r--r--doc/encoders.texi20
-rw-r--r--doc/ffmpeg.texi1
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/encoders.texi b/doc/encoders.texi
new file mode 100644
index 0000000000..cab98fb0bd
--- /dev/null
+++ b/doc/encoders.texi
@@ -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
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 8b8e42f1f6..f0f3b65084 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -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