[FFmpeg-cvslog] r25709 - in trunk: Makefile doc/bitstream_filters.texi doc/ffmpeg-doc.texi

[stefano]

Author: stefano
Date: Mon Nov  8 15:27:16 2010
New Revision: 25709

Log:
Add a file for bitstream filters documentation.

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

Added:
   trunk/doc/bitstream_filters.texi
Modified:
   trunk/Makefile
   trunk/doc/ffmpeg-doc.texi

Modified: trunk/Makefile
==============================================================================
--- trunk/Makefile	Mon Nov  8 15:06:49 2010	(r25708)
+++ trunk/Makefile	Mon Nov  8 15:27:16 2010	(r25709)
@@ -115,7 +115,7 @@ documentation: $(addprefix doc/, develop
 
 $(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
 

Added: trunk/doc/bitstream_filters.texi
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ trunk/doc/bitstream_filters.texi	Mon Nov  8 15:27:16 2010	(r25709)
@@ -0,0 +1,40 @@
+ at chapter Bitstream Filters
+ at 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
+ at 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.
+
+ at section aac_adtstoasc
+
+ at section chomp
+
+ at section dump_extradata
+
+ at section h264_mp4toannexb
+
+ at section imx_dump_header
+
+ at section mjpega_dump_header
+
+ at section movsub
+
+ at section mp3_header_compress
+
+ at section mp3_header_decompress
+
+ at section noise
+
+ at section remove_extradata
+
+ at c man end BITSTREAM FILTERS

Modified: trunk/doc/ffmpeg-doc.texi
==============================================================================
--- trunk/doc/ffmpeg-doc.texi	Mon Nov  8 15:06:49 2010	(r25708)
+++ trunk/doc/ffmpeg-doc.texi	Mon Nov  8 15:27:16 2010	(r25709)
@@ -937,6 +937,7 @@ file to which you want to add them.
 @include indevs.texi
 @include outdevs.texi
 @include protocols.texi
+ at include bitstream_filters.texi
 @include filters.texi
 
 @ignore