Skip to content

node-av / constants / BsfOptionsMap

Interface: BsfOptionsMap

Defined in: src/constants/bsf-options.ts:66

Properties

apv_metadata

apv_metadata: object

Defined in: src/constants/bsf-options.ts:70

color_primaries?

optional color_primaries?: number

Set color primaries (section 5.3.5)

full_range_flag?

optional full_range_flag?: "tv" | "pc"

Set full range flag flag (section 5.3.5)

matrix_coefficients?

optional matrix_coefficients?: number

Set matrix coefficients (section 5.3.5)

transfer_characteristics?

optional transfer_characteristics?: number

Set transfer characteristics (section 5.3.5)

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#apv_005fmetadata


av1_metadata

av1_metadata: object

Defined in: src/constants/bsf-options.ts:83

chroma_sample_position?

optional chroma_sample_position?: "unknown" | "vertical" | "colocated"

Set chroma sample position (section 6.4.2)

color_primaries?

optional color_primaries?: number

Set color primaries (section 6.4.2)

color_range?

optional color_range?: "tv" | "pc"

Set color range flag (section 6.4.2)

delete_padding?

optional delete_padding?: boolean

Delete all Padding OBUs

matrix_coefficients?

optional matrix_coefficients?: number

Set matrix coefficients (section 6.4.2)

num_ticks_per_picture?

optional num_ticks_per_picture?: number

Set display ticks per picture for CFR streams

td?

optional td?: "pass" | "insert" | "remove"

Temporal Delimiter OBU

tick_rate?

optional tick_rate?: string | number

Set display tick rate (time_scale / num_units_in_display_tick)

transfer_characteristics?

optional transfer_characteristics?: number

Set transfer characteristics (section 6.4.2)

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#av1_005fmetadata


dovi_rpu

dovi_rpu: object

Defined in: src/constants/bsf-options.ts:106

compression?

optional compression?: "none" | "limited" | "extended"

DV metadata compression mode

strip?

optional strip?: boolean

Strip Dolby Vision metadata

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#dovi_005frpu


dovi_split

dovi_split: object

Defined in: src/constants/bsf-options.ts:115

mode?

optional mode?: "bl" | "bl_rpu" | "el" | "el_rpu"

Which Dolby Vision components to keep in the output bitstream

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#dovi_005fsplit


dump_extra

dump_extra: object

Defined in: src/constants/bsf-options.ts:122

freq?

optional freq?: "all" | "k" | "keyframe" | "e"

When to dump extradata

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#dump_005fextra


dv_error_marker

dv_error_marker: object

Defined in: src/constants/bsf-options.ts:129

color?

optional color?: string

set color

sta?

optional sta?: string & object | "a" | "b" | "ok" | "Aa" | "Ba" | "Ca" | "erri" | "erru" | "err" | "Ab" | "Bb" | "Cb" | "A" | "B" | "C" | "res" | "notok" | "notres"

specify which error status value to match

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#dv_005ferror_005fmarker


eia608_to_smpte436m

eia608_to_smpte436m: object

Defined in: src/constants/bsf-options.ts:138

cdp_frame_rate?

optional cdp_frame_rate?: string | number

set the cdp_frame_rate fields

initial_cdp_sequence_cntr?

optional initial_cdp_sequence_cntr?: number

initial cdp_*_sequence_cntr value

line_number?

optional line_number?: number

line number -- you probably want 9 or 11

sample_coding?

optional sample_coding?: "8bit_luma" | "8bit_color_diff" | "8bit_luma_and_color_diff" | "10bit_luma" | "10bit_color_diff" | "10bit_luma_and_color_diff" | "8bit_luma_parity_error" | "8bit_color_diff_parity_error" | "8bit_luma_and_color_diff_parity_error"

payload sample coding

wrapping_type?

optional wrapping_type?: "vanc_frame" | "vanc_field_1" | "vanc_field_2" | "vanc_progressive_frame"

wrapping type

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#eia608_005fto_005fsmpte436m


extract_extradata

extract_extradata: object

Defined in: src/constants/bsf-options.ts:162

remove?

optional remove?: number

remove the extradata from the bitstream

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#extract_005fextradata


filter_units

filter_units: object

Defined in: src/constants/bsf-options.ts:169

discard?

optional discard?: "none" | "default" | "bidir" | "all" | "nonref" | "nonintra" | "nonkey"

Remove the selected frames

discard_flags?

optional discard_flags?: string & object | "keep_non_vcl"

flags to control the discard frame behavior

pass_types?

optional pass_types?: string

List of unit types to pass through the filter.

remove_types?

optional remove_types?: string

List of unit types to remove in the filter.

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#filter_005funits


h264_metadata

h264_metadata: object

Defined in: src/constants/bsf-options.ts:182

aud?

optional aud?: "pass" | "insert" | "remove"

Access Unit Delimiter NAL units

chroma_sample_loc_type?

optional chroma_sample_loc_type?: number

Set chroma sample location type (figure E-1)

colour_primaries?

optional colour_primaries?: number

Set colour primaries (table E-3)

crop_bottom?

optional crop_bottom?: number

Set bottom border crop offset

crop_left?

optional crop_left?: number

Set left border crop offset

crop_right?

optional crop_right?: number

Set right border crop offset

crop_top?

optional crop_top?: number

Set top border crop offset

delete_filler?

optional delete_filler?: number

Delete all filler (both NAL and SEI)

display_orientation?

optional display_orientation?: "pass" | "insert" | "remove" | "extract"

Display orientation SEI

fixed_frame_rate_flag?

optional fixed_frame_rate_flag?: number

Set VUI fixed frame rate flag

flip?

optional flip?: string & object | "vertical" | "horizontal"

Set flip in display orientation SEI

level?

optional level?: "1" | "auto" | "2.1" | "2.2" | "3.1" | "3.2" | "4.1" | "4.2" | "5.1" | "5.2" | "6.1" | "6.2" | "2" | "3" | "4" | "5" | "6" | "1.1" | "1.2" | "1.3" | "1b"

Set level (table A-1)

matrix_coefficients?

optional matrix_coefficients?: number

Set matrix coefficients (table E-5)

overscan_appropriate_flag?

optional overscan_appropriate_flag?: number

Set VUI overscan appropriate flag

rotate?

optional rotate?: number

Set rotation in display orientation SEI (anticlockwise angle in degrees)

sample_aspect_ratio?

optional sample_aspect_ratio?: string | number

Set sample aspect ratio (table E-1)

sei_user_data?

optional sei_user_data?: string

Insert SEI user data (UUID+string)

tick_rate?

optional tick_rate?: string | number

Set VUI tick rate (time_scale / num_units_in_tick)

transfer_characteristics?

optional transfer_characteristics?: number

Set transfer characteristics (table E-4)

video_format?

optional video_format?: number

Set video format (table E-2)

video_full_range_flag?

optional video_full_range_flag?: number

Set video full range flag

zero_new_constraint_set_flags?

optional zero_new_constraint_set_flags?: boolean

Set constraint_set4_flag / constraint_set5_flag to zero

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#h264_005fmetadata


hapqa_extract

hapqa_extract: object

Defined in: src/constants/bsf-options.ts:231

texture?

optional texture?: "color" | "alpha"

texture to keep

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#hapqa_005fextract


hevc_metadata

hevc_metadata: object

Defined in: src/constants/bsf-options.ts:238

aud?

optional aud?: "pass" | "insert" | "remove"

Access Unit Delimiter NAL units

chroma_sample_loc_type?

optional chroma_sample_loc_type?: number

Set chroma sample location type (figure E-1)

colour_primaries?

optional colour_primaries?: number

Set colour primaries (table E-3)

crop_bottom?

optional crop_bottom?: number

Set bottom border crop offset

crop_left?

optional crop_left?: number

Set left border crop offset

crop_right?

optional crop_right?: number

Set right border crop offset

crop_top?

optional crop_top?: number

Set top border crop offset

height?

optional height?: number

Set height after crop

level?

optional level?: "1" | "auto" | "2.1" | "3.1" | "4.1" | "5.1" | "5.2" | "6.1" | "6.2" | "2" | "3" | "4" | "5" | "6" | "8.5"

Set level (tables A.6 and A.7)

matrix_coefficients?

optional matrix_coefficients?: number

Set matrix coefficients (table E-5)

num_ticks_poc_diff_one?

optional num_ticks_poc_diff_one?: number

Set VPS and VUI number of ticks per POC increment

sample_aspect_ratio?

optional sample_aspect_ratio?: string | number

Set sample aspect ratio (table E-1)

tick_rate?

optional tick_rate?: string | number

Set VPS and VUI tick rate (time_scale / num_units_in_tick)

transfer_characteristics?

optional transfer_characteristics?: number

Set transfer characteristics (table E-4)

video_format?

optional video_format?: number

Set video format (table E-2)

video_full_range_flag?

optional video_full_range_flag?: number

Set video full range flag

width?

optional width?: number

Set width after crop

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#hevc_005fmetadata


lcevc_metadata

lcevc_metadata: object

Defined in: src/constants/bsf-options.ts:277

chroma_sample_loc_type?

optional chroma_sample_loc_type?: number

Set chroma sample location type (figure E-1)

colour_primaries?

optional colour_primaries?: number

Set colour primaries (table E-3)

delete_filler?

optional delete_filler?: boolean

Delete all filler

matrix_coefficients?

optional matrix_coefficients?: number

Set matrix coefficients (table E-5)

overscan_appropriate_flag?

optional overscan_appropriate_flag?: boolean

Set VUI overscan appropriate flag

transfer_characteristics?

optional transfer_characteristics?: number

Set transfer characteristics (table E-4)

video_format?

optional video_format?: number

Set video format (table E-2)

video_full_range_flag?

optional video_full_range_flag?: boolean

Set video full range flag

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#lcevc_005fmetadata


mpeg2_metadata

mpeg2_metadata: object

Defined in: src/constants/bsf-options.ts:298

colour_primaries?

optional colour_primaries?: number

Set colour primaries (table 6-7)

display_aspect_ratio?

optional display_aspect_ratio?: string | number

Set display aspect ratio (table 6-3)

frame_rate?

optional frame_rate?: string | number

Set frame rate

matrix_coefficients?

optional matrix_coefficients?: number

Set matrix coefficients (table 6-9)

transfer_characteristics?

optional transfer_characteristics?: number

Set transfer characteristics (table 6-8)

video_format?

optional video_format?: number

Set video format (table 6-6)

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#mpeg2_005fmetadata


noise

noise: object

Defined in: src/constants/bsf-options.ts:315

amount?

optional amount?: string

drop?

optional drop?: string

dropamount?

optional dropamount?: number

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#noise


opus_metadata

opus_metadata: object

Defined in: src/constants/bsf-options.ts:323

gain?

optional gain?: number

Gain, actual amplification is pow(10, gain/(20.0*256))

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#opus_005fmetadata


pcm_rechunk

pcm_rechunk: object

Defined in: src/constants/bsf-options.ts:330

frame_rate?

optional frame_rate?: string | number

set number of packets per second

n?

optional n?: number

set the number of per-packet output samples

nb_out_samples?

optional nb_out_samples?: number

set the number of per-packet output samples

p?

optional p?: boolean

pad last packet with zeros

pad?

optional pad?: boolean

pad last packet with zeros

r?

optional r?: string | number

set number of packets per second

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#pcm_005frechunk


prores_metadata

prores_metadata: object

Defined in: src/constants/bsf-options.ts:347

color_primaries?

optional color_primaries?: "unknown" | "auto" | "bt709" | "bt470bg" | "smpte170m" | "bt2020" | "smpte431" | "smpte432"

select color primaries

color_trc?

optional color_trc?: "unknown" | "auto" | "bt709" | "smpte2084" | "arib-std-b67"

select color transfer

colorspace?

optional colorspace?: "unknown" | "auto" | "bt709" | "smpte170m" | "bt2020nc"

select colorspace

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#prores_005fmetadata


remove_extra

remove_extra: object

Defined in: src/constants/bsf-options.ts:358

freq?

optional freq?: "all" | "k" | "keyframe" | "e"

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#remove_005fextra


setts

setts: object

Defined in: src/constants/bsf-options.ts:364

dts?

optional dts?: string

set expression for packet DTS

duration?

optional duration?: string

set expression for packet duration

prescale?

optional prescale?: boolean

convert to output timebase before evaluation

pts?

optional pts?: string

set expression for packet PTS

time_base?

optional time_base?: string | number

set output timebase

ts?

optional ts?: string

set expression for packet PTS and DTS

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#setts


vp9_metadata

vp9_metadata: object

Defined in: src/constants/bsf-options.ts:381

color_range?

optional color_range?: "tv" | "pc"

Set colour range (section 7.2.2)

color_space?

optional color_space?: "unknown" | "bt709" | "bt2020" | "rgb" | "bt601" | "smpte170" | "smpte240"

Set colour space (section 7.2.2)

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#vp9_005fmetadata


vvc_metadata

vvc_metadata: object

Defined in: src/constants/bsf-options.ts:390

aud?

optional aud?: "pass" | "insert" | "remove"

Access Unit Delimiter NAL units

See

https://ffmpeg.org/ffmpeg-bitstream-filters.html#vvc_005fmetadata