doc/bitstream_filters: correct dump_extra bsfs docs.
[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 @table @option
54 @item freq
55 The additional argument specifies which packets should be filtered.
56 It accepts the values:
57 @table @samp
58 @item k
59 @item keyframe
60 add extradata to all key packets
61
62 @item e
63 @item all
64 add extradata to all packets
65 @end table
66 @end table
67
68 If not specified it is assumed @samp{e}.
69
70 For example the following @command{ffmpeg} command forces a global
71 header (thus disabling individual packet headers) in the H.264 packets
72 generated by the @code{libx264} encoder, but corrects them by adding
73 the header stored in extradata to the key packets:
74 @example
75 ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
76 @end example
77
78 @section extract_extradata
79
80 Extract the in-band extradata.
81
82 Certain codecs allow the long-term headers (e.g. MPEG-2 sequence headers,
83 or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either "in-band" (i.e. as a part
84 of the bitstream containing the coded frames) or "out of band" (e.g. on the
85 container level). This latter form is called "extradata" in FFmpeg terminology.
86
87 This bitstream filter detects the in-band headers and makes them available as
88 extradata.
89
90 @table @option
91 @item remove
92 When this option is enabled, the long-term headers are removed from the
93 bitstream after extraction.
94 @end table
95
96 @section h264_metadata
97
98 Modify metadata embedded in an H.264 stream.
99
100 @table @option
101 @item aud
102 Insert or remove AUD NAL units in all access units of the stream.
103
104 @table @samp
105 @item insert
106 @item remove
107 @end table
108
109 @item sample_aspect_ratio
110 Set the sample aspect ratio of the stream in the VUI parameters.
111
112 @item video_format
113 @item video_full_range_flag
114 Set the video format in the stream (see H.264 section E.2.1 and
115 table E-2).
116
117 @item colour_primaries
118 @item transfer_characteristics
119 @item matrix_coefficients
120 Set the colour description in the stream (see H.264 section E.2.1
121 and tables E-3, E-4 and E-5).
122
123 @item chroma_sample_loc_type
124 Set the chroma sample location in the stream (see H.264 section
125 E.2.1 and figure E-1).
126
127 @item tick_rate
128 Set the tick rate (num_units_in_tick / time_scale) in the VUI
129 parameters.  This is the smallest time unit representable in the
130 stream, and in many cases represents the field rate of the stream
131 (double the frame rate).
132 @item fixed_frame_rate_flag
133 Set whether the stream has fixed framerate - typically this indicates
134 that the framerate is exactly half the tick rate, but the exact
135 meaning is dependent on interlacing and the picture structure (see
136 H.264 section E.2.1 and table E-6).
137
138 @item crop_left
139 @item crop_right
140 @item crop_top
141 @item crop_bottom
142 Set the frame cropping offsets in the SPS.  These values will replace
143 the current ones if the stream is already cropped.
144
145 These fields are set in pixels.  Note that some sizes may not be
146 representable if the chroma is subsampled or the stream is interlaced
147 (see H.264 section 7.4.2.1.1).
148
149 @item sei_user_data
150 Insert a string as SEI unregistered user data.  The argument must
151 be of the form @emph{UUID+string}, where the UUID is as hex digits
152 possibly separated by hyphens, and the string can be anything.
153
154 For example, @samp{086f3693-b7b3-4f2c-9653-21492feee5b8+hello} will
155 insert the string ``hello'' associated with the given UUID.
156
157 @item delete_filler
158 Deletes both filler NAL units and filler SEI messages.
159
160 @end table
161
162 @section h264_mp4toannexb
163
164 Convert an H.264 bitstream from length prefixed mode to start code
165 prefixed mode (as defined in the Annex B of the ITU-T H.264
166 specification).
167
168 This is required by some streaming formats, typically the MPEG-2
169 transport stream format (muxer @code{mpegts}).
170
171 For example to remux an MP4 file containing an H.264 stream to mpegts
172 format with @command{ffmpeg}, you can use the command:
173
174 @example
175 ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
176 @end example
177
178 Please note that this filter is auto-inserted for MPEG-TS (muxer
179 @code{mpegts}) and raw H.264 (muxer @code{h264}) output formats.
180
181 @section h264_redundant_pps
182
183 This applies a specific fixup to some Blu-ray streams which contain
184 redundant PPSs modifying irrelevant parameters of the stream which
185 confuse other transformations which require correct extradata.
186
187 A new single global PPS is created, and all of the redundant PPSs
188 within the stream are removed.
189
190 @section hevc_metadata
191
192 Modify metadata embedded in an HEVC stream.
193
194 @table @option
195 @item aud
196 Insert or remove AUD NAL units in all access units of the stream.
197
198 @table @samp
199 @item insert
200 @item remove
201 @end table
202
203 @item sample_aspect_ratio
204 Set the sample aspect ratio in the stream in the VUI parameters.
205
206 @item video_format
207 @item video_full_range_flag
208 Set the video format in the stream (see H.265 section E.3.1 and
209 table E.2).
210
211 @item colour_primaries
212 @item transfer_characteristics
213 @item matrix_coefficients
214 Set the colour description in the stream (see H.265 section E.3.1
215 and tables E.3, E.4 and E.5).
216
217 @item chroma_sample_loc_type
218 Set the chroma sample location in the stream (see H.265 section
219 E.3.1 and figure E.1).
220
221 @item tick_rate
222 Set the tick rate in the VPS and VUI parameters (num_units_in_tick /
223 time_scale).  Combined with @option{num_ticks_poc_diff_one}, this can
224 set a constant framerate in the stream.  Note that it is likely to be
225 overridden by container parameters when the stream is in a container.
226
227 @item num_ticks_poc_diff_one
228 Set poc_proportional_to_timing_flag in VPS and VUI and use this value
229 to set num_ticks_poc_diff_one_minus1 (see H.265 sections 7.4.3.1 and
230 E.3.1).  Ignored if @option{tick_rate} is not also set.
231
232 @item crop_left
233 @item crop_right
234 @item crop_top
235 @item crop_bottom
236 Set the conformance window cropping offsets in the SPS.  These values
237 will replace the current ones if the stream is already cropped.
238
239 These fields are set in pixels.  Note that some sizes may not be
240 representable if the chroma is subsampled (H.265 section 7.4.3.2.1).
241
242 @end table
243
244 @section hevc_mp4toannexb
245
246 Convert an HEVC/H.265 bitstream from length prefixed mode to start code
247 prefixed mode (as defined in the Annex B of the ITU-T H.265
248 specification).
249
250 This is required by some streaming formats, typically the MPEG-2
251 transport stream format (muxer @code{mpegts}).
252
253 For example to remux an MP4 file containing an HEVC stream to mpegts
254 format with @command{ffmpeg}, you can use the command:
255
256 @example
257 ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
258 @end example
259
260 Please note that this filter is auto-inserted for MPEG-TS (muxer
261 @code{mpegts}) and raw HEVC/H.265 (muxer @code{h265} or
262 @code{hevc}) output formats.
263
264 @section imxdump
265
266 Modifies the bitstream to fit in MOV and to be usable by the Final Cut
267 Pro decoder. This filter only applies to the mpeg2video codec, and is
268 likely not needed for Final Cut Pro 7 and newer with the appropriate
269 @option{-tag:v}.
270
271 For example, to remux 30 MB/sec NTSC IMX to MOV:
272
273 @example
274 ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
275 @end example
276
277 @section mjpeg2jpeg
278
279 Convert MJPEG/AVI1 packets to full JPEG/JFIF packets.
280
281 MJPEG is a video codec wherein each video frame is essentially a
282 JPEG image. The individual frames can be extracted without loss,
283 e.g. by
284
285 @example
286 ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
287 @end example
288
289 Unfortunately, these chunks are incomplete JPEG images, because
290 they lack the DHT segment required for decoding. Quoting from
291 @url{http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml}:
292
293 Avery Lee, writing in the rec.video.desktop newsgroup in 2001,
294 commented that "MJPEG, or at least the MJPEG in AVIs having the
295 MJPG fourcc, is restricted JPEG with a fixed -- and *omitted* --
296 Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2,
297 and it must use basic Huffman encoding, not arithmetic or
298 progressive. . . . You can indeed extract the MJPEG frames and
299 decode them with a regular JPEG decoder, but you have to prepend
300 the DHT segment to them, or else the decoder won't have any idea
301 how to decompress the data. The exact table necessary is given in
302 the OpenDML spec."
303
304 This bitstream filter patches the header of frames extracted from an MJPEG
305 stream (carrying the AVI1 header ID and lacking a DHT segment) to
306 produce fully qualified JPEG images.
307
308 @example
309 ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
310 exiftran -i -9 frame*.jpg
311 ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
312 @end example
313
314 @section mjpegadump
315
316 Add an MJPEG A header to the bitstream, to enable decoding by
317 Quicktime.
318
319 @anchor{mov2textsub}
320 @section mov2textsub
321
322 Extract a representable text file from MOV subtitles, stripping the
323 metadata header from each subtitle packet.
324
325 See also the @ref{text2movsub} filter.
326
327 @section mp3decomp
328
329 Decompress non-standard compressed MP3 audio headers.
330
331 @section mpeg2_metadata
332
333 Modify metadata embedded in an MPEG-2 stream.
334
335 @table @option
336 @item display_aspect_ratio
337 Set the display aspect ratio in the stream.
338
339 The following fixed values are supported:
340 @table @option
341 @item 4/3
342 @item 16/9
343 @item 221/100
344 @end table
345 Any other value will result in square pixels being signalled instead
346 (see H.262 section 6.3.3 and table 6-3).
347
348 @item frame_rate
349 Set the frame rate in the stream.  This is constructed from a table
350 of known values combined with a small multiplier and divisor - if
351 the supplied value is not exactly representable, the nearest
352 representable value will be used instead (see H.262 section 6.3.3
353 and table 6-4).
354
355 @item video_format
356 Set the video format in the stream (see H.262 section 6.3.6 and
357 table 6-6).
358
359 @item colour_primaries
360 @item transfer_characteristics
361 @item matrix_coefficients
362 Set the colour description in the stream (see H.262 section 6.3.6
363 and tables 6-7, 6-8 and 6-9).
364
365 @end table
366
367 @section mpeg4_unpack_bframes
368
369 Unpack DivX-style packed B-frames.
370
371 DivX-style packed B-frames are not valid MPEG-4 and were only a
372 workaround for the broken Video for Windows subsystem.
373 They use more space, can cause minor AV sync issues, require more
374 CPU power to decode (unless the player has some decoded picture queue
375 to compensate the 2,0,2,0 frame per packet style) and cause
376 trouble if copied into a standard container like mp4 or mpeg-ps/ts,
377 because MPEG-4 decoders may not be able to decode them, since they are
378 not valid MPEG-4.
379
380 For example to fix an AVI file containing an MPEG-4 stream with
381 DivX-style packed B-frames using @command{ffmpeg}, you can use the command:
382
383 @example
384 ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
385 @end example
386
387 @section noise
388
389 Damages the contents of packets or simply drops them without damaging the
390 container. Can be used for fuzzing or testing error resilience/concealment.
391
392 Parameters:
393 @table @option
394 @item amount
395 A numeral string, whose value is related to how often output bytes will
396 be modified. Therefore, values below or equal to 0 are forbidden, and
397 the lower the more frequent bytes will be modified, with 1 meaning
398 every byte is modified.
399 @item dropamount
400 A numeral string, whose value is related to how often packets will be dropped.
401 Therefore, values below or equal to 0 are forbidden, and the lower the more
402 frequent packets will be dropped, with 1 meaning every packet is dropped.
403 @end table
404
405 The following example applies the modification to every byte but does not drop
406 any packets.
407 @example
408 ffmpeg -i INPUT -c copy -bsf noise[=1] output.mkv
409 @end example
410
411 @section null
412 This bitstream filter passes the packets through unchanged.
413
414 @section remove_extra
415
416 Remove extradata from packets.
417
418 It accepts the following parameter:
419 @table @option
420 @item freq
421 Set which frame types to remove extradata from.
422
423 @table @samp
424 @item k
425 Remove extradata from non-keyframes only.
426
427 @item keyframe
428 Remove extradata from keyframes only.
429
430 @item e, all
431 Remove extradata from all frames.
432
433 @end table
434 @end table
435
436 @anchor{text2movsub}
437 @section text2movsub
438
439 Convert text subtitles to MOV subtitles (as used by the @code{mov_text}
440 codec) with metadata headers.
441
442 See also the @ref{mov2textsub} filter.
443
444 @section trace_headers
445
446 Log trace output containing all syntax elements in the coded stream
447 headers (everything above the level of individual coded blocks).
448 This can be useful for debugging low-level stream issues.
449
450 Supports H.264, H.265 and MPEG-2.
451
452 @section vp9_superframe
453
454 Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This
455 fixes merging of split/segmented VP9 streams where the alt-ref frame
456 was split from its visible counterpart.
457
458 @section vp9_superframe_split
459
460 Split VP9 superframes into single frames.
461
462 @section vp9_raw_reorder
463
464 Given a VP9 stream with correct timestamps but possibly out of order,
465 insert additional show-existing-frame packets to correct the ordering.
466
467 @c man end BITSTREAM FILTERS