Add a file for bitstream filters documentation.

Based on a patch by Nicolas George
<@var{name}.@var{surname}@@normalesup.@code{org}>.

Originally committed as revision 25709 to svn://svn.ffmpeg.org/ffmpeg/trunk

diff --git a/Makefile b/Makefile
index e9d9854..e52d5c5 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -115,7 +115,7 @@ documentation: $(addprefix doc/, developer.html faq.html general.html libavfilte
 
 $(HTMLPAGES) $(MANPAGES): doc/fftools-common-opts.texi
 
-doc/ffmpeg.pod doc/ffmpeg-doc.html: doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi
+doc/ffmpeg.pod doc/ffmpeg-doc.html: doc/bitstream_filters.texi doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi
 doc/ffplay.pod doc/ffplay-doc.html: doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi
 doc/ffprobe.pod doc/ffprobe-doc.html: doc/indevs.texi doc/protocols.texi
 

diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
new file mode 100644 (file)
index 0000000..0bcb6c7
--- /dev/null
+++ b/doc/bitstream_filters.texi
@@ -0,0 +1,40 @@
+@chapter Bitstream Filters
+@c man begin BITSTREAM FILTERS
+
+When you configure your FFmpeg build, all the supported bitstream
+filters are enabled by default. You can list all available ones using
+the configure option @code{--list-bsfs}.
+
+You can disable all the bitstream filters using the configure option
+@code{--disable-bsfs}, and selectively enable any bitstream filter using
+the option @code{--enable-bsf=BSF}, or you can disable a particular
+bitstream filter using the option @code{--disable-bsf=BSF}.
+
+The option @code{-bsfs} of the ff* tools will display the list of
+all the supported bitstream filters included in your build.
+
+Below is a description of the currently available bitstream filters.
+
+@section aac_adtstoasc
+
+@section chomp
+
+@section dump_extradata
+
+@section h264_mp4toannexb
+
+@section imx_dump_header
+
+@section mjpega_dump_header
+
+@section movsub
+
+@section mp3_header_compress
+
+@section mp3_header_decompress
+
+@section noise
+
+@section remove_extradata
+
+@c man end BITSTREAM FILTERS

diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
index 4d707ea..b33ea5e 100644 (file)
--- a/doc/ffmpeg-doc.texi
+++ b/doc/ffmpeg-doc.texi
@@ -937,6 +937,7 @@ file to which you want to add them.
 @include indevs.texi
 @include outdevs.texi
 @include protocols.texi
+@include bitstream_filters.texi
 @include filters.texi
 
 @ignore