1FFMPEG-BITSTREAM-FILTERS(1) FFMPEG-BITSTREAM-FILTERS(1)
2
6 ffmpeg-bitstream-filters - FFmpeg bitstream filters
7
9 This document describes the bitstream filters provided by the
10 libavcodec library.
11 A bitstream filter operates on the encoded stream data, and performs
13 bitstream level modifications without performing decoding.
14
16 When you configure your FFmpeg build, all the supported bitstream
17 filters are enabled by default. You can list all available ones using
18 the configure option "--list-bsfs".
19 You can disable all the bitstream filters using the configure option
21 "--disable-bsfs", and selectively enable any bitstream filter using the
22 option "--enable-bsf=BSF", or you can disable a particular bitstream
23 filter using the option "--disable-bsf=BSF".
24 The option "-bsfs" of the ff* tools will display the list of all the
26 supported bitstream filters included in your build.
27 The ff* tools have a -bsf option applied per stream, taking a comma-
29 separated list of filters, whose parameters follow the filter name
30 after a '='.
31 ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT
33 Below is a description of the currently available bitstream filters,
35 with their parameters, if any.
36 aac_adtstoasc
38 Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration
39 bitstream.
40 This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4 ADTS
42 header and removes the ADTS header.
43 This filter is required for example when copying an AAC stream from a
45 raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or
46 to MOV/MP4 files and related formats such as 3GP or M4A. Please note
47 that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats.
48 av1_metadata
50 Modify metadata embedded in an AV1 stream.
51 td Insert or remove temporal delimiter OBUs in all temporal units of
53 the stream.
54 insert
56 Insert a TD at the beginning of every TU which does not already
57 have one.
58 remove
60 Remove the TD from the beginning of every TU which has one.
61 color_primaries
63 transfer_characteristics
64 matrix_coefficients
65 Set the color description fields in the stream (see AV1 section
66 6.4.2).
67 color_range
69 Set the color range in the stream (see AV1 section 6.4.2; note that
70 this cannot be set for streams using BT.709 primaries, sRGB
71 transfer characteristic and identity (RGB) matrix coefficients).
72 tv Limited range.
74 pc Full range.
76 chroma_sample_position
78 Set the chroma sample location in the stream (see AV1 section
79 6.4.2). This can only be set for 4:2:0 streams.
80 vertical
82 Left position (matching the default in MPEG-2 and H.264).
83 colocated
85 Top-left position.
86 tick_rate
88 Set the tick rate (time_scale / num_units_in_display_tick) in the
89 timing info in the sequence header.
90 num_ticks_per_picture
92 Set the number of ticks in each picture, to indicate that the
93 stream has a fixed framerate. Ignored if tick_rate is not also
94 set.
95 delete_padding
97 Deletes Padding OBUs.
98 chomp
100 Remove zero padding at the end of a packet.
101 dca_core
103 Extract the core from a DCA/DTS stream, dropping extensions such as
104 DTS-HD.
105 dump_extra
107 Add extradata to the beginning of the filtered packets except when said
108 packets already exactly begin with the extradata that is intended to be
109 added.
110 freq
112 The additional argument specifies which packets should be filtered.
113 It accepts the values:
114 k
116 keyframe
117 add extradata to all key packets
118 e
120 all add extradata to all packets
121 If not specified it is assumed k.
123 For example the following ffmpeg command forces a global header (thus
125 disabling individual packet headers) in the H.264 packets generated by
126 the "libx264" encoder, but corrects them by adding the header stored in
127 extradata to the key packets:
128 ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
130 eac3_core
132 Extract the core from a E-AC-3 stream, dropping extra channels.
133 extract_extradata
135 Extract the in-band extradata.
136 Certain codecs allow the long-term headers (e.g. MPEG-2 sequence
138 headers, or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either "in-
139 band" (i.e. as a part of the bitstream containing the coded frames) or
140 "out of band" (e.g. on the container level). This latter form is called
141 "extradata" in FFmpeg terminology.
142 This bitstream filter detects the in-band headers and makes them
144 available as extradata.
145 remove
147 When this option is enabled, the long-term headers are removed from
148 the bitstream after extraction.
149 filter_units
151 Remove units with types in or not in a given set from the stream.
152 pass_types
154 List of unit types or ranges of unit types to pass through while
155 removing all others. This is specified as a '|'-separated list of
156 unit type values or ranges of values with '-'.
157 remove_types
159 Identical to pass_types, except the units in the given set removed
160 and all others passed through.
161 Extradata is unchanged by this transformation, but note that if the
163 stream contains inline parameter sets then the output may be unusable
164 if they are removed.
165 For example, to remove all non-VCL NAL units from an H.264 stream:
167 ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=pass_types=1-5' OUTPUT
169 To remove all AUDs, SEI and filler from an H.265 stream:
171 ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=35|38-40' OUTPUT
173 hapqa_extract
175 Extract Rgb or Alpha part of an HAPQA file, without recompression, in
176 order to create an HAPQ or an HAPAlphaOnly file.
177 texture
179 Specifies the texture to keep.
180 color
182 alpha
183 Convert HAPQA to HAPQ
185 ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=color -tag:v HapY -metadata:s:v:0 encoder="HAPQ" hapq_file.mov
187 Convert HAPQA to HAPAlphaOnly
189 ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=alpha -tag:v HapA -metadata:s:v:0 encoder="HAPAlpha Only" hapalphaonly_file.mov
191 h264_metadata
193 Modify metadata embedded in an H.264 stream.
194 aud Insert or remove AUD NAL units in all access units of the stream.
196 insert
198 remove
199 sample_aspect_ratio
200 Set the sample aspect ratio of the stream in the VUI parameters.
201 overscan_appropriate_flag
203 Set whether the stream is suitable for display using overscan or
204 not (see H.264 section E.2.1).
205 video_format
207 video_full_range_flag
208 Set the video format in the stream (see H.264 section E.2.1 and
209 table E-2).
210 colour_primaries
212 transfer_characteristics
213 matrix_coefficients
214 Set the colour description in the stream (see H.264 section E.2.1
215 and tables E-3, E-4 and E-5).
216 chroma_sample_loc_type
218 Set the chroma sample location in the stream (see H.264 section
219 E.2.1 and figure E-1).
220 tick_rate
222 Set the tick rate (time_scale / num_units_in_tick) in the VUI
223 parameters. This is the smallest time unit representable in the
224 stream, and in many cases represents the field rate of the stream
225 (double the frame rate).
226 fixed_frame_rate_flag
228 Set whether the stream has fixed framerate - typically this
229 indicates that the framerate is exactly half the tick rate, but the
230 exact meaning is dependent on interlacing and the picture structure
231 (see H.264 section E.2.1 and table E-6).
232 zero_new_constraint_set_flags
234 Zero constraint_set4_flag and constraint_set5_flag in the SPS.
235 These bits were reserved in a previous version of the H.264 spec,
236 and thus some hardware decoders require these to be zero. The
237 result of zeroing this is still a valid bitstream.
238 crop_left
240 crop_right
241 crop_top
242 crop_bottom
243 Set the frame cropping offsets in the SPS. These values will
244 replace the current ones if the stream is already cropped.
245 These fields are set in pixels. Note that some sizes may not be
247 representable if the chroma is subsampled or the stream is
248 interlaced (see H.264 section 7.4.2.1.1).
249 sei_user_data
251 Insert a string as SEI unregistered user data. The argument must
252 be of the form UUID+string, where the UUID is as hex digits
253 possibly separated by hyphens, and the string can be anything.
254 For example, 086f3693-b7b3-4f2c-9653-21492feee5b8+hello will insert
256 the string ``hello'' associated with the given UUID.
257 delete_filler
259 Deletes both filler NAL units and filler SEI messages.
260 level
262 Set the level in the SPS. Refer to H.264 section A.3 and tables
263 A-1 to A-5.
264 The argument must be the name of a level (for example, 4.2), a
266 level_idc value (for example, 42), or the special name auto
267 indicating that the filter should attempt to guess the level from
268 the input stream properties.
269 h264_mp4toannexb
271 Convert an H.264 bitstream from length prefixed mode to start code
272 prefixed mode (as defined in the Annex B of the ITU-T H.264
273 specification).
274 This is required by some streaming formats, typically the MPEG-2
276 transport stream format (muxer "mpegts").
277 For example to remux an MP4 file containing an H.264 stream to mpegts
279 format with ffmpeg, you can use the command:
280 ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
282 Please note that this filter is auto-inserted for MPEG-TS (muxer
284 "mpegts") and raw H.264 (muxer "h264") output formats.
285 h264_redundant_pps
287 This applies a specific fixup to some Blu-ray streams which contain
288 redundant PPSs modifying irrelevant parameters of the stream which
289 confuse other transformations which require correct extradata.
290 A new single global PPS is created, and all of the redundant PPSs
292 within the stream are removed.
293 hevc_metadata
295 Modify metadata embedded in an HEVC stream.
296 aud Insert or remove AUD NAL units in all access units of the stream.
298 insert
300 remove
301 sample_aspect_ratio
302 Set the sample aspect ratio in the stream in the VUI parameters.
303 video_format
305 video_full_range_flag
306 Set the video format in the stream (see H.265 section E.3.1 and
307 table E.2).
308 colour_primaries
310 transfer_characteristics
311 matrix_coefficients
312 Set the colour description in the stream (see H.265 section E.3.1
313 and tables E.3, E.4 and E.5).
314 chroma_sample_loc_type
316 Set the chroma sample location in the stream (see H.265 section
317 E.3.1 and figure E.1).
318 tick_rate
320 Set the tick rate in the VPS and VUI parameters (time_scale /
321 num_units_in_tick). Combined with num_ticks_poc_diff_one, this can
322 set a constant framerate in the stream. Note that it is likely to
323 be overridden by container parameters when the stream is in a
324 container.
325 num_ticks_poc_diff_one
327 Set poc_proportional_to_timing_flag in VPS and VUI and use this
328 value to set num_ticks_poc_diff_one_minus1 (see H.265 sections
329 7.4.3.1 and E.3.1). Ignored if tick_rate is not also set.
330 crop_left
332 crop_right
333 crop_top
334 crop_bottom
335 Set the conformance window cropping offsets in the SPS. These
336 values will replace the current ones if the stream is already
337 cropped.
338 These fields are set in pixels. Note that some sizes may not be
340 representable if the chroma is subsampled (H.265 section
341 7.4.3.2.1).
342 level
344 Set the level in the VPS and SPS. See H.265 section A.4 and tables
345 A.6 and A.7.
346 The argument must be the name of a level (for example, 5.1), a
348 general_level_idc value (for example, 153 for level 5.1), or the
349 special name auto indicating that the filter should attempt to
350 guess the level from the input stream properties.
351 hevc_mp4toannexb
353 Convert an HEVC/H.265 bitstream from length prefixed mode to start code
354 prefixed mode (as defined in the Annex B of the ITU-T H.265
355 specification).
356 This is required by some streaming formats, typically the MPEG-2
358 transport stream format (muxer "mpegts").
359 For example to remux an MP4 file containing an HEVC stream to mpegts
361 format with ffmpeg, you can use the command:
362 ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
364 Please note that this filter is auto-inserted for MPEG-TS (muxer
366 "mpegts") and raw HEVC/H.265 (muxer "h265" or "hevc") output formats.
367 imxdump
369 Modifies the bitstream to fit in MOV and to be usable by the Final Cut
370 Pro decoder. This filter only applies to the mpeg2video codec, and is
371 likely not needed for Final Cut Pro 7 and newer with the appropriate
372 -tag:v.
373 For example, to remux 30 MB/sec NTSC IMX to MOV:
375 ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
377 mjpeg2jpeg
379 Convert MJPEG/AVI1 packets to full JPEG/JFIF packets.
380 MJPEG is a video codec wherein each video frame is essentially a JPEG
382 image. The individual frames can be extracted without loss, e.g. by
383 ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
385 Unfortunately, these chunks are incomplete JPEG images, because they
387 lack the DHT segment required for decoding. Quoting from
388 <http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml>:
389 Avery Lee, writing in the rec.video.desktop newsgroup in 2001,
391 commented that "MJPEG, or at least the MJPEG in AVIs having the MJPG
392 fourcc, is restricted JPEG with a fixed -- and *omitted* -- Huffman
393 table. The JPEG must be YCbCr colorspace, it must be 4:2:2, and it must
394 use basic Huffman encoding, not arithmetic or progressive. . . . You
395 can indeed extract the MJPEG frames and decode them with a regular JPEG
396 decoder, but you have to prepend the DHT segment to them, or else the
397 decoder won't have any idea how to decompress the data. The exact table
398 necessary is given in the OpenDML spec."
399 This bitstream filter patches the header of frames extracted from an
401 MJPEG stream (carrying the AVI1 header ID and lacking a DHT segment) to
402 produce fully qualified JPEG images.
403 ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
405 exiftran -i -9 frame*.jpg
406 ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
407 mjpegadump
409 Add an MJPEG A header to the bitstream, to enable decoding by
410 Quicktime.
411 mov2textsub
413 Extract a representable text file from MOV subtitles, stripping the
414 metadata header from each subtitle packet.
415 See also the text2movsub filter.
417 mp3decomp
419 Decompress non-standard compressed MP3 audio headers.
420 mpeg2_metadata
422 Modify metadata embedded in an MPEG-2 stream.
423 display_aspect_ratio
425 Set the display aspect ratio in the stream.
426 The following fixed values are supported:
428 4/3
430 16/9
431 221/100
432 Any other value will result in square pixels being signalled
434 instead (see H.262 section 6.3.3 and table 6-3).
435 frame_rate
437 Set the frame rate in the stream. This is constructed from a table
438 of known values combined with a small multiplier and divisor - if
439 the supplied value is not exactly representable, the nearest
440 representable value will be used instead (see H.262 section 6.3.3
441 and table 6-4).
442 video_format
444 Set the video format in the stream (see H.262 section 6.3.6 and
445 table 6-6).
446 colour_primaries
448 transfer_characteristics
449 matrix_coefficients
450 Set the colour description in the stream (see H.262 section 6.3.6
451 and tables 6-7, 6-8 and 6-9).
452 mpeg4_unpack_bframes
454 Unpack DivX-style packed B-frames.
455 DivX-style packed B-frames are not valid MPEG-4 and were only a
457 workaround for the broken Video for Windows subsystem. They use more
458 space, can cause minor AV sync issues, require more CPU power to decode
459 (unless the player has some decoded picture queue to compensate the
460 2,0,2,0 frame per packet style) and cause trouble if copied into a
461 standard container like mp4 or mpeg-ps/ts, because MPEG-4 decoders may
462 not be able to decode them, since they are not valid MPEG-4.
463 For example to fix an AVI file containing an MPEG-4 stream with DivX-
465 style packed B-frames using ffmpeg, you can use the command:
466 ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
468 noise
470 Damages the contents of packets or simply drops them without damaging
471 the container. Can be used for fuzzing or testing error
472 resilience/concealment.
473 Parameters:
475 amount
477 Accepts an expression whose evaluation per-packet determines how
478 often bytes in that packet will be modified. A value below 0 will
479 result in a variable frequency. Default is 0 which results in no
480 modification. However, if neither amount nor drop is specified,
481 amount will be set to -1. See below for accepted variables.
482 drop
484 Accepts an expression evaluated per-packet whose value determines
485 whether that packet is dropped. Evaluation to a positive value
486 results in the packet being dropped. Evaluation to a negative value
487 results in a variable chance of it being dropped, roughly inverse
488 in proportion to the magnitude of the value. Default is 0 which
489 results in no drops. See below for accepted variables.
490 dropamount
492 Accepts a non-negative integer, which assigns a variable chance of
493 it being dropped, roughly inverse in proportion to the value.
494 Default is 0 which results in no drops. This option is kept for
495 backwards compatibility and is equivalent to setting drop to a
496 negative value with the same magnitude i.e. "dropamount=4" is the
497 same as "drop=-4". Ignored if drop is also specified.
498 Both "amount" and "drop" accept expressions containing the following
500 variables:
501 n The index of the packet, starting from zero.
503 tb The timebase for packet timestamps.
505 pts Packet presentation timestamp.
507 dts Packet decoding timestamp.
509 nopts
511 Constant representing AV_NOPTS_VALUE.
512 startpts
514 First non-AV_NOPTS_VALUE PTS seen in the stream.
515 startdts
517 First non-AV_NOPTS_VALUE DTS seen in the stream.
518 duration
520 d Packet duration, in timebase units.
521 pos Packet position in input; may be -1 when unknown or not set.
523 size
525 Packet size, in bytes.
526 key Whether packet is marked as a keyframe.
528 state
530 A pseudo random integer, primarily derived from the content of
531 packet payload.
532 Examples
534 Apply modification to every byte but don't drop any packets.
536 ffmpeg -i INPUT -c copy -bsf noise=1 output.mkv
538 Drop every video packet not marked as a keyframe after timestamp 30s
540 but do not modify any of the remaining packets.
541 ffmpeg -i INPUT -c copy -bsf:v noise=drop='gt(t\,30)*not(key)' output.mkv
543 Drop one second of audio every 10 seconds and add some random noise to
545 the rest.
546 ffmpeg -i INPUT -c copy -bsf:a noise=amount=-1:drop='between(mod(t\,10)\,9\,10)' output.mkv
548 null
550 This bitstream filter passes the packets through unchanged.
551 pcm_rechunk
553 Repacketize PCM audio to a fixed number of samples per packet or a
554 fixed packet rate per second. This is similar to the asetnsamples audio
555 filter but works on audio packets instead of audio frames.
556 nb_out_samples, n
558 Set the number of samples per each output audio packet. The number
559 is intended as the number of samples per each channel. Default
560 value is 1024.
561 pad, p
563 If set to 1, the filter will pad the last audio packet with
564 silence, so that it will contain the same number of samples (or
565 roughly the same number of samples, see frame_rate) as the previous
566 ones. Default value is 1.
567 frame_rate, r
569 This option makes the filter output a fixed number of packets per
570 second instead of a fixed number of samples per packet. If the
571 audio sample rate is not divisible by the frame rate then the
572 number of samples will not be constant but will vary slightly so
573 that each packet will start as close to the frame boundary as
574 possible. Using this option has precedence over nb_out_samples.
575 You can generate the well known 1602-1601-1602-1601-1602 pattern of
577 48kHz audio for NTSC frame rate using the frame_rate option.
578 ffmpeg -f lavfi -i sine=r=48000:d=1 -c pcm_s16le -bsf pcm_rechunk=r=30000/1001 -f framecrc -
580 prores_metadata
582 Modify color property metadata embedded in prores stream.
583 color_primaries
585 Set the color primaries. Available values are:
586 auto
588 Keep the same color primaries property (default).
589 unknown
591 bt709
592 bt470bg
593 BT601 625
594 smpte170m
596 BT601 525
597 bt2020
599 smpte431
600 DCI P3
601 smpte432
603 P3 D65
604 transfer_characteristics
606 Set the color transfer. Available values are:
607 auto
609 Keep the same transfer characteristics property (default).
610 unknown
612 bt709
613 BT 601, BT 709, BT 2020
614 smpte2084
616 SMPTE ST 2084
617 arib-std-b67
619 ARIB STD-B67
620 matrix_coefficients
622 Set the matrix coefficient. Available values are:
623 auto
625 Keep the same colorspace property (default).
626 unknown
628 bt709
629 smpte170m
630 BT 601
631 bt2020nc
633 Set Rec709 colorspace for each frame of the file
635 ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt709:color_trc=bt709:colorspace=bt709 output.mov
637 Set Hybrid Log-Gamma parameters for each frame of the file
639 ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt2020:color_trc=arib-std-b67:colorspace=bt2020nc output.mov
641 remove_extra
643 Remove extradata from packets.
644 It accepts the following parameter:
646 freq
648 Set which frame types to remove extradata from.
649 k Remove extradata from non-keyframes only.
651 keyframe
653 Remove extradata from keyframes only.
654 e, all
656 Remove extradata from all frames.
657 setts
659 Set PTS and DTS in packets.
660 It accepts the following parameters:
662 ts
664 pts
665 dts Set expressions for PTS, DTS or both.
666 The expressions are evaluated through the eval API and can contain the
668 following constants:
669 N The count of the input packet. Starting from 0.
671 TS The demux timestamp in input in case of "ts" or "dts" option or
673 presentation timestamp in case of "pts" option.
674 POS The original position in the file of the packet, or undefined if
676 undefined for the current packet
677 DTS The demux timestamp in input.
679 PTS The presentation timestamp in input.
681 STARTDTS
683 The DTS of the first packet.
684 STARTPTS
686 The PTS of the first packet.
687 PREV_INDTS
689 The previous input DTS.
690 PREV_INPTS
692 The previous input PTS.
693 PREV_OUTDTS
695 The previous output DTS.
696 PREV_OUTPTS
698 The previous output PTS.
699 TB The timebase of stream packet belongs.
701 SR The sample rate of stream packet belongs.
703 NOPTS
705 The AV_NOPTS_VALUE constant.
706 text2movsub
708 Convert text subtitles to MOV subtitles (as used by the "mov_text"
709 codec) with metadata headers.
710 See also the mov2textsub filter.
712 trace_headers
714 Log trace output containing all syntax elements in the coded stream
715 headers (everything above the level of individual coded blocks). This
716 can be useful for debugging low-level stream issues.
717 Supports AV1, H.264, H.265, (M)JPEG, MPEG-2 and VP9, but depending on
719 the build only a subset of these may be available.
720 truehd_core
722 Extract the core from a TrueHD stream, dropping ATMOS data.
723 vp9_metadata
725 Modify metadata embedded in a VP9 stream.
726 color_space
728 Set the color space value in the frame header. Note that any frame
729 set to RGB will be implicitly set to PC range and that RGB is
730 incompatible with profiles 0 and 2.
731 unknown
733 bt601
734 bt709
735 smpte170
736 smpte240
737 bt2020
738 rgb
739 color_range
740 Set the color range value in the frame header. Note that any value
741 imposed by the color space will take precedence over this value.
742 tv
744 pc
745 vp9_superframe
747 Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This
748 fixes merging of split/segmented VP9 streams where the alt-ref frame
749 was split from its visible counterpart.
750 vp9_superframe_split
752 Split VP9 superframes into single frames.
753 vp9_raw_reorder
755 Given a VP9 stream with correct timestamps but possibly out of order,
756 insert additional show-existing-frame packets to correct the ordering.
757
759 ffmpeg(1), ffplay(1), ffprobe(1), libavcodec(3)
760
762 The FFmpeg developers.
763 For details about the authorship, see the Git history of the project
765 (git://source.ffmpeg.org/ffmpeg), e.g. by typing the command git log in
766 the FFmpeg source directory, or browsing the online repository at
767 <http://source.ffmpeg.org>.
768 Maintainers for the specific components are listed in the file
770 MAINTAINERS in the source code tree.
771 FFMPEG-BITSTREAM-FILTERS(1)