ffmpeg: take bsf arguments from the command line
[ffmpeg.git] / doc / bitstream_filters.texi
1 @chapter Bitstream Filters
2 @c man begin BITSTREAM FILTERS
3
4 When you configure your FFmpeg build, all the supported bitstream
5 filters are enabled by default. You can list all available ones using
6 the configure option @code{--list-bsfs}.
7
8 You can disable all the bitstream filters using the configure option
9 @code{--disable-bsfs}, and selectively enable any bitstream filter using
10 the option @code{--enable-bsf=BSF}, or you can disable a particular
11 bitstream filter using the option @code{--disable-bsf=BSF}.
12
13 The option @code{-bsfs} of the ff* tools will display the list of
14 all the supported bitstream filters included in your build.
15
16 The ff* tools have a -bsf option applied per stream, taking a
17 comma-separated list of filters, whose parameters follow the filter
18 name after a '='.
19
20 @example
21 ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1/opt2=str2][,filter2] OUTPUT
22 @end example
23
24 Below is a description of the currently available bitstream filters.
25
26 @section aac_adtstoasc
27
28 Convert MPEG-2/4 AAC ADTS to MPEG-4 Audio Specific Configuration
29 bitstream filter.
30
31 This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4
32 ADTS header and removes the ADTS header.
33
34 This is required for example when copying an AAC stream from a raw
35 ADTS AAC container to a FLV or a MOV/MP4 file.
36
37 @section chomp
38
39 Remove zero padding at the end of a packet.
40
41 @section dump_extra
42
43 Add extradata to the beginning of the filtered packets.
44
45 The additional argument specifies which packets should be filtered.
46 It accepts the values:
47 @table @samp
48 @item a
49 add extradata to all key packets, but only if @var{local_header} is
50 set in the @option{flags2} codec context field
51
52 @item k
53 add extradata to all key packets
54
55 @item e
56 add extradata to all packets
57 @end table
58
59 If not specified it is assumed @samp{k}.
60
61 For example the following @command{ffmpeg} command forces a global
62 header (thus disabling individual packet headers) in the H.264 packets
63 generated by the @code{libx264} encoder, but corrects them by adding
64 the header stored in extradata to the key packets:
65 @example
66 ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
67 @end example
68
69 @section h264_mp4toannexb
70
71 Convert an H.264 bitstream from length prefixed mode to start code
72 prefixed mode (as defined in the Annex B of the ITU-T H.264
73 specification).
74
75 This is required by some streaming formats, typically the MPEG-2
76 transport stream format ("mpegts").
77
78 For example to remux an MP4 file containing an H.264 stream to mpegts
79 format with @command{ffmpeg}, you can use the command:
80
81 @example
82 ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
83 @end example
84
85 @section imxdump
86
87 Modifies the bitstream to fit in MOV and to be usable by the Final Cut
88 Pro decoder. This filter only applies to the mpeg2video codec, and is
89 likely not needed for Final Cut Pro 7 and newer with the appropriate
90 @option{-tag:v}.
91
92 For example, to remux 30 MB/sec NTSC IMX to MOV:
93
94 @example
95 ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
96 @end example
97
98 @section mjpeg2jpeg
99
100 Convert MJPEG/AVI1 packets to full JPEG/JFIF packets.
101
102 MJPEG is a video codec wherein each video frame is essentially a
103 JPEG image. The individual frames can be extracted without loss,
104 e.g. by
105
106 @example
107 ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
108 @end example
109
110 Unfortunately, these chunks are incomplete JPEG images, because
111 they lack the DHT segment required for decoding. Quoting from
112 @url{http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml}:
113
114 Avery Lee, writing in the rec.video.desktop newsgroup in 2001,
115 commented that "MJPEG, or at least the MJPEG in AVIs having the
116 MJPG fourcc, is restricted JPEG with a fixed -- and *omitted* --
117 Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2,
118 and it must use basic Huffman encoding, not arithmetic or
119 progressive. . . . You can indeed extract the MJPEG frames and
120 decode them with a regular JPEG decoder, but you have to prepend
121 the DHT segment to them, or else the decoder won't have any idea
122 how to decompress the data. The exact table necessary is given in
123 the OpenDML spec."
124
125 This bitstream filter patches the header of frames extracted from an MJPEG
126 stream (carrying the AVI1 header ID and lacking a DHT segment) to
127 produce fully qualified JPEG images.
128
129 @example
130 ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
131 exiftran -i -9 frame*.jpg
132 ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
133 @end example
134
135 @section mjpega_dump_header
136
137 @section movsub
138
139 @section mp3_header_decompress
140
141 @section noise
142
143 Damages the contents of packets without damaging the container. Can be
144 used for fuzzing or testing error resilience/concealment.
145
146 @example
147 ffmpeg -i INPUT -c copy -bsf noise output.mkv
148 @end example
149
150 @section remove_extra
151
152 @c man end BITSTREAM FILTERS