lavc: Add h264_metadata bitstream filter
[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 with their parameters, if any.
26
27 @section aac_adtstoasc
28
29 Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration
30 bitstream.
31
32 This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4
33 ADTS header and removes the ADTS header.
34
35 This filter is required for example when copying an AAC stream from a
36 raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or
37 to MOV/MP4 files and related formats such as 3GP or M4A. Please note
38 that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats.
39
40 @section chomp
41
42 Remove zero padding at the end of a packet.
43
44 @section dca_core
45
46 Extract the core from a DCA/DTS stream, dropping extensions such as
47 DTS-HD.
48
49 @section dump_extra
50
51 Add extradata to the beginning of the filtered packets.
52
53 The additional argument specifies which packets should be filtered.
54 It accepts the values:
55 @table @samp
56 @item a
57 add extradata to all key packets, but only if @var{local_header} is
58 set in the @option{flags2} codec context field
59
60 @item k
61 add extradata to all key packets
62
63 @item e
64 add extradata to all packets
65 @end table
66
67 If not specified it is assumed @samp{k}.
68
69 For example the following @command{ffmpeg} command forces a global
70 header (thus disabling individual packet headers) in the H.264 packets
71 generated by the @code{libx264} encoder, but corrects them by adding
72 the header stored in extradata to the key packets:
73 @example
74 ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
75 @end example
76
77 @section extract_extradata
78
79 Extract the in-band extradata.
80
81 Certain codecs allow the long-term headers (e.g. MPEG-2 sequence headers,
82 or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either "in-band" (i.e. as a part
83 of the bitstream containing the coded frames) or "out of band" (e.g. on the
84 container level). This latter form is called "extradata" in FFmpeg terminology.
85
86 This bitstream filter detects the in-band headers and makes them available as
87 extradata.
88
89 @table @option
90 @item remove
91 When this option is enabled, the long-term headers are removed from the
92 bitstream after extraction.
93 @end table
94
95 @section h264_metadata
96
97 Modify metadata embedded in an H.264 stream.
98
99 @table @option
100 @item aud
101 Insert or remove AUD NAL units in all access units of the stream.
102
103 @table @samp
104 @item insert
105 @item remove
106 @end table
107
108 @item sample_aspect_ratio
109 Set the sample aspect ratio of the stream in the VUI parameters.
110
111 @item video_format
112 @item video_full_range_flag
113 Set the video format in the stream (see H.264 section E.2.1 and
114 table E-2).
115
116 @item colour_primaries
117 @item transfer_characteristics
118 @item matrix_coefficients
119 Set the colour description in the stream (see H.264 section E.2.1
120 and tables E-3, E-4 and E-5).
121
122 @item chroma_sample_loc_type
123 Set the chroma sample location in the stream (see H.264 section
124 E.2.1 and figure E-1).
125
126 @item tick_rate
127 Set the tick rate (num_units_in_tick / time_scale) in the VUI
128 parameters.  This is the smallest time unit representable in the
129 stream, and in many cases represents the field rate of the stream
130 (double the frame rate).
131 @item fixed_frame_rate_flag
132 Set whether the stream has fixed framerate - typically this indicates
133 that the framerate is exactly half the tick rate, but the exact
134 meaning is dependent on interlacing and the picture structure (see
135 H.264 section E.2.1 and table E-6).
136
137 @item crop_left
138 @item crop_right
139 @item crop_top
140 @item crop_bottom
141 Set the frame cropping offsets in the SPS.  These values will replace
142 the current ones if the stream is already cropped.
143
144 These fields are set in pixels.  Note that some sizes may not be
145 representable if the chroma is subsampled or the stream is interlaced
146 (see H.264 section 7.4.2.1.1).
147
148 @item sei_user_data
149 Insert a string as SEI unregistered user data.  The argument must
150 be of the form @emph{UUID+string}, where the UUID is as hex digits
151 possibly separated by hyphens, and the string can be anything.
152
153 For example, @samp{086f3693-b7b3-4f2c-9653-21492feee5b8+hello} will
154 insert the string ``hello'' associated with the given UUID.
155
156 @end table
157
158 @section h264_mp4toannexb
159
160 Convert an H.264 bitstream from length prefixed mode to start code
161 prefixed mode (as defined in the Annex B of the ITU-T H.264
162 specification).
163
164 This is required by some streaming formats, typically the MPEG-2
165 transport stream format (muxer @code{mpegts}).
166
167 For example to remux an MP4 file containing an H.264 stream to mpegts
168 format with @command{ffmpeg}, you can use the command:
169
170 @example
171 ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
172 @end example
173
174 Please note that this filter is auto-inserted for MPEG-TS (muxer
175 @code{mpegts}) and raw H.264 (muxer @code{h264}) output formats.
176
177 @section hevc_mp4toannexb
178
179 Convert an HEVC/H.265 bitstream from length prefixed mode to start code
180 prefixed mode (as defined in the Annex B of the ITU-T H.265
181 specification).
182
183 This is required by some streaming formats, typically the MPEG-2
184 transport stream format (muxer @code{mpegts}).
185
186 For example to remux an MP4 file containing an HEVC stream to mpegts
187 format with @command{ffmpeg}, you can use the command:
188
189 @example
190 ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
191 @end example
192
193 Please note that this filter is auto-inserted for MPEG-TS (muxer
194 @code{mpegts}) and raw HEVC/H.265 (muxer @code{h265} or
195 @code{hevc}) output formats.
196
197 @section imxdump
198
199 Modifies the bitstream to fit in MOV and to be usable by the Final Cut
200 Pro decoder. This filter only applies to the mpeg2video codec, and is
201 likely not needed for Final Cut Pro 7 and newer with the appropriate
202 @option{-tag:v}.
203
204 For example, to remux 30 MB/sec NTSC IMX to MOV:
205
206 @example
207 ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
208 @end example
209
210 @section mjpeg2jpeg
211
212 Convert MJPEG/AVI1 packets to full JPEG/JFIF packets.
213
214 MJPEG is a video codec wherein each video frame is essentially a
215 JPEG image. The individual frames can be extracted without loss,
216 e.g. by
217
218 @example
219 ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
220 @end example
221
222 Unfortunately, these chunks are incomplete JPEG images, because
223 they lack the DHT segment required for decoding. Quoting from
224 @url{http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml}:
225
226 Avery Lee, writing in the rec.video.desktop newsgroup in 2001,
227 commented that "MJPEG, or at least the MJPEG in AVIs having the
228 MJPG fourcc, is restricted JPEG with a fixed -- and *omitted* --
229 Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2,
230 and it must use basic Huffman encoding, not arithmetic or
231 progressive. . . . You can indeed extract the MJPEG frames and
232 decode them with a regular JPEG decoder, but you have to prepend
233 the DHT segment to them, or else the decoder won't have any idea
234 how to decompress the data. The exact table necessary is given in
235 the OpenDML spec."
236
237 This bitstream filter patches the header of frames extracted from an MJPEG
238 stream (carrying the AVI1 header ID and lacking a DHT segment) to
239 produce fully qualified JPEG images.
240
241 @example
242 ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
243 exiftran -i -9 frame*.jpg
244 ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
245 @end example
246
247 @section mjpegadump
248
249 Add an MJPEG A header to the bitstream, to enable decoding by
250 Quicktime.
251
252 @anchor{mov2textsub}
253 @section mov2textsub
254
255 Extract a representable text file from MOV subtitles, stripping the
256 metadata header from each subtitle packet.
257
258 See also the @ref{text2movsub} filter.
259
260 @section mp3decomp
261
262 Decompress non-standard compressed MP3 audio headers.
263
264 @section mpeg4_unpack_bframes
265
266 Unpack DivX-style packed B-frames.
267
268 DivX-style packed B-frames are not valid MPEG-4 and were only a
269 workaround for the broken Video for Windows subsystem.
270 They use more space, can cause minor AV sync issues, require more
271 CPU power to decode (unless the player has some decoded picture queue
272 to compensate the 2,0,2,0 frame per packet style) and cause
273 trouble if copied into a standard container like mp4 or mpeg-ps/ts,
274 because MPEG-4 decoders may not be able to decode them, since they are
275 not valid MPEG-4.
276
277 For example to fix an AVI file containing an MPEG-4 stream with
278 DivX-style packed B-frames using @command{ffmpeg}, you can use the command:
279
280 @example
281 ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
282 @end example
283
284 @section noise
285
286 Damages the contents of packets or simply drops them without damaging the
287 container. Can be used for fuzzing or testing error resilience/concealment.
288
289 Parameters:
290 @table @option
291 @item amount
292 A numeral string, whose value is related to how often output bytes will
293 be modified. Therefore, values below or equal to 0 are forbidden, and
294 the lower the more frequent bytes will be modified, with 1 meaning
295 every byte is modified.
296 @item dropamount
297 A numeral string, whose value is related to how often packets will be dropped.
298 Therefore, values below or equal to 0 are forbidden, and the lower the more
299 frequent packets will be dropped, with 1 meaning every packet is dropped.
300 @end table
301
302 The following example applies the modification to every byte but does not drop
303 any packets.
304 @example
305 ffmpeg -i INPUT -c copy -bsf noise[=1] output.mkv
306 @end example
307
308 @section null
309 This bitstream filter passes the packets through unchanged.
310
311 @section remove_extra
312
313 Remove extradata from packets.
314
315 It accepts the following parameter:
316 @table @option
317 @item freq
318 Set which frame types to remove extradata from.
319
320 @table @samp
321 @item k
322 Remove extradata from non-keyframes only.
323
324 @item keyframe
325 Remove extradata from keyframes only.
326
327 @item e, all
328 Remove extradata from all frames.
329
330 @end table
331 @end table
332
333 @anchor{text2movsub}
334 @section text2movsub
335
336 Convert text subtitles to MOV subtitles (as used by the @code{mov_text}
337 codec) with metadata headers.
338
339 See also the @ref{mov2textsub} filter.
340
341 @section trace_headers
342
343 Log trace output containing all syntax elements in the coded stream
344 headers (everything above the level of individual coded blocks).
345 This can be useful for debugging low-level stream issues.
346
347 Supports H.264, H.265 and MPEG-2.
348
349 @section vp9_superframe
350
351 Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This
352 fixes merging of split/segmented VP9 streams where the alt-ref frame
353 was split from its visible counterpart.
354
355 @section vp9_superframe_split
356
357 Split VP9 superframes into single frames.
358
359 @section vp9_raw_reorder
360
361 Given a VP9 stream with correct timestamps but possibly out of order,
362 insert additional show-existing-frame packets to correct the ordering.
363
364 @c man end BITSTREAM FILTERS