Browse code

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

Stefano Sabatini authored on 2010/11/08 23:27:16
Showing 3 changed files
... ...
@@ -115,7 +115,7 @@ documentation: $(addprefix doc/, developer.html faq.html general.html libavfilte
115 115
 
116 116
 $(HTMLPAGES) $(MANPAGES): doc/fftools-common-opts.texi
117 117
 
118
-doc/ffmpeg.pod doc/ffmpeg-doc.html: doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi
118
+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
119 119
 doc/ffplay.pod doc/ffplay-doc.html: doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi
120 120
 doc/ffprobe.pod doc/ffprobe-doc.html: doc/indevs.texi doc/protocols.texi
121 121
 
122 122
new file mode 100644
... ...
@@ -0,0 +1,40 @@
0
+@chapter Bitstream Filters
1
+@c man begin BITSTREAM FILTERS
2
+
3
+When you configure your FFmpeg build, all the supported bitstream
4
+filters are enabled by default. You can list all available ones using
5
+the configure option @code{--list-bsfs}.
6
+
7
+You can disable all the bitstream filters using the configure option
8
+@code{--disable-bsfs}, and selectively enable any bitstream filter using
9
+the option @code{--enable-bsf=BSF}, or you can disable a particular
10
+bitstream filter using the option @code{--disable-bsf=BSF}.
11
+
12
+The option @code{-bsfs} of the ff* tools will display the list of
13
+all the supported bitstream filters included in your build.
14
+
15
+Below is a description of the currently available bitstream filters.
16
+
17
+@section aac_adtstoasc
18
+
19
+@section chomp
20
+
21
+@section dump_extradata
22
+
23
+@section h264_mp4toannexb
24
+
25
+@section imx_dump_header
26
+
27
+@section mjpega_dump_header
28
+
29
+@section movsub
30
+
31
+@section mp3_header_compress
32
+
33
+@section mp3_header_decompress
34
+
35
+@section noise
36
+
37
+@section remove_extradata
38
+
39
+@c man end BITSTREAM FILTERS
... ...
@@ -937,6 +937,7 @@ file to which you want to add them.
937 937
 @include indevs.texi
938 938
 @include outdevs.texi
939 939
 @include protocols.texi
940
+@include bitstream_filters.texi
940 941
 @include filters.texi
941 942
 
942 943
 @ignore