node-av / constants / CodecContextOptions

Interface: CodecContextOptions

Auto-generated codec private-option types. Generated from FFmpeg codec AVOption sources (see scripts/generate-options-source.js). DO NOT EDIT MANUALLY.

Properties

ab?

optional ab?: number

Defined in: src/constants/options.ts:11

set bitrate (in bits/s)

alpha_mode?

optional alpha_mode?: "unknown" | "unspecified" | "premultiplied" | "straight"

Defined in: src/constants/options.ts:304

alpha mode

apply_cropping?

optional apply_cropping?: boolean

Defined in: src/constants/options.ts:320

ar?

optional ar?: number

Defined in: src/constants/options.ts:55

set audio sampling rate (in Hz)

aspect?

optional aspect?: string | number

Defined in: src/constants/options.ts:145

sample aspect ratio

audio_service_type?

optional audio_service_type?: "ma" | "ef" | "vi" | "hi" | "di" | "co" | "em" | "vo" | "ka"

Defined in: src/constants/options.ts:312

audio service type

b?

optional b?: number

Defined in: src/constants/options.ts:9

set bitrate (in bits/s)

b_qfactor?

optional b_qfactor?: number

Defined in: src/constants/options.ts:74

QP factor between P- and B-frames

b_qoffset?

optional b_qoffset?: number

Defined in: src/constants/options.ts:97

QP offset between P- and B-frames

bf?

optional bf?: number

Defined in: src/constants/options.ts:72

set maximum number of B-frames between non-B-frames

bidir_refine?

optional bidir_refine?: number

Defined in: src/constants/options.ts:218

refine the two motion vectors used in bidirectional macroblocks

bits_per_coded_sample?

optional bits_per_coded_sample?: number

Defined in: src/constants/options.ts:143

bits_per_raw_sample?

optional bits_per_raw_sample?: number

Defined in: src/constants/options.ts:227

block_align?

optional block_align?: number

Defined in: src/constants/options.ts:101

bt?

optional bt?: number

Defined in: src/constants/options.ts:13

Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate tolerance specifies how far

bufsize?

optional bufsize?: number

Defined in: src/constants/options.ts:108

set ratecontrol buffer size (in bits)

bug?

optional bug?: string & object | "autodetect" | "xvid_ilace" | "ump4" | "no_padding" | "amv" | "qpel_chroma" | "std_qpel" | "qpel_chroma2" | "direct_blocksize" | "edge" | "hpel_chroma" | "dc_clip" | "ms" | "trunc" | "iedge"

Defined in: src/constants/options.ts:77

work around not autodetected encoder bugs

ch_layout?

optional ch_layout?: string

Defined in: src/constants/options.ts:228

chroma_sample_location?

optional chroma_sample_location?: "unknown" | "unspecified" | "left" | "center" | "topleft" | "top" | "bottomleft" | "bottom"

Defined in: src/constants/options.ts:302

chroma sample location

cmp?

optional cmp?: "psnr" | "rd" | "sad" | "sse" | "satd" | "dct" | "bit" | "zero" | "vsad" | "vsse" | "nsse" | "w53" | "w97" | "dctmax" | "chroma" | "msad"

Defined in: src/constants/options.ts:198

full-pel ME compare function

codec_tag?

optional codec_tag?: number

Defined in: src/constants/options.ts:75

codec_whitelist?

optional codec_whitelist?: string

Defined in: src/constants/options.ts:328

List of decoders that are allowed to be used

color_primaries?

optional color_primaries?: "unknown" | "bt709" | "bt470m" | "bt470bg" | "smpte170m" | "smpte240m" | "film" | "bt2020" | "smpte428" | "smpte428_1" | "smpte431" | "smpte432" | "jedec-p22" | "ebu3213" | "unspecified"

Defined in: src/constants/options.ts:232

color primaries

color_range?

optional color_range?: "unknown" | "unspecified" | "tv" | "pc" | "mpeg" | "jpeg" | "limited" | "full"

Defined in: src/constants/options.ts:300

color range

color_trc?

optional color_trc?: "unknown" | "bt709" | "smpte170m" | "smpte240m" | "smpte428" | "smpte428_1" | "unspecified" | "gamma22" | "gamma28" | "linear" | "log100" | "log316" | "iec61966-2-4" | "bt1361e" | "iec61966-2-1" | "bt2020-10" | "bt2020-12" | "smpte2084" | "arib-std-b67" | "log" | "log_sqrt" | "iec61966_2_4" | "bt1361" | "iec61966_2_1" | "bt2020_10bit" | "bt2020_12bit"

Defined in: src/constants/options.ts:249

color transfer characteristics

colorspace?

optional colorspace?: "unknown" | "bt709" | "bt470bg" | "smpte170m" | "smpte240m" | "unspecified" | "rgb" | "fcc" | "ycgco" | "bt2020nc" | "bt2020c" | "smpte2085" | "chroma-derived-nc" | "chroma-derived-c" | "ictcp" | "ipt-c2" | "ycocg" | "ycgco-re" | "ycgco-ro" | "bt2020_ncl" | "bt2020_cl"

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

color space

compression_level?

optional compression_level?: number

Defined in: src/constants/options.ts:226

cutoff?

optional cutoff?: number

Defined in: src/constants/options.ts:57

set cutoff bandwidth

dark_mask?

optional dark_mask?: number

Defined in: src/constants/options.ts:124

compresses dark areas stronger than medium ones

dc?

optional dc?: number

Defined in: src/constants/options.ts:185

deprecated; use intra_dc_precision for MPEG-2 instead

dct?

optional dct?: "auto" | "fastint" | "int" | "mmx" | "altivec" | "faan" | "neon"

Defined in: src/constants/options.ts:114

DCT algorithm

debug?

optional debug?: string & object | "bitstream" | "pict" | "rc" | "mb_type" | "qp" | "dct_coeff" | "green_metadata" | "skip" | "startcode" | "er" | "mmco" | "bugs" | "buffers" | "thread_ops" | "nomc"

Defined in: src/constants/options.ts:149

print specific debug info

delay?

optional delay?: number

Defined in: src/constants/options.ts:60

dia_size?

optional dia_size?: number

Defined in: src/constants/options.ts:167

diamond type & size for motion estimation

discard_damaged_percentage?

optional discard_damaged_percentage?: number

Defined in: src/constants/options.ts:341

Percentage of damaged samples to discard a frame

dump_separator?

optional dump_separator?: string

Defined in: src/constants/options.ts:326

set information dump field separator

ec?

optional ec?: string & object | "guess_mvs" | "deblock" | "favor_inter"

Defined in: src/constants/options.ts:142

set error concealment strategy

err_detect?

optional err_detect?: string & object | "crccheck" | "bitstream" | "buffer" | "explode" | "ignore_err" | "careful" | "compliant" | "aggressive"

Defined in: src/constants/options.ts:99

set error detection flags

export_side_data?

optional export_side_data?: string & object | "mvs" | "prft" | "venc_params" | "film_grain" | "enhancements"

Defined in: src/constants/options.ts:50

Export metadata as side data

extra_hw_frames?

optional extra_hw_frames?: number

Defined in: src/constants/options.ts:339

Number of extra hardware frames to allocate for the user

field_order?

optional field_order?: "progressive" | "tt" | "bb" | "tb" | "bt"

Defined in: src/constants/options.ts:324

Field order

flags?

optional flags?: string & object | "unaligned" | "mv4" | "qpel" | "loop" | "qscale" | "recon_frame" | "copy_opaque" | "frame_duration" | "pass1" | "pass2" | "gray" | "psnr" | "ildct" | "low_delay" | "global_header" | "bitexact" | "aic" | "ilme" | "cgop" | "output_corrupt"

Defined in: src/constants/options.ts:14

flags2?

optional flags2?: string & object | "fast" | "noout" | "ignorecrop" | "local_header" | "chunks" | "showall" | "export_mvs" | "skip_manual" | "ass_ro_flush_noop" | "icc_profiles" | "fixed_frame_size"

Defined in: src/constants/options.ts:36

frame_number?

optional frame_number?: number

Defined in: src/constants/options.ts:59

frame_size?

optional frame_size?: number

Defined in: src/constants/options.ts:58

g?

optional g?: number

Defined in: src/constants/options.ts:53

set the group of picture (GOP) size

global_quality?

optional global_quality?: number

Defined in: src/constants/options.ts:176

has_b_frames?

optional has_b_frames?: number

Defined in: src/constants/options.ts:100

hwaccel_flags?

optional hwaccel_flags?: string & object | "ignore_level" | "allow_high_depth" | "allow_profile_mismatch" | "unsafe_output" | "low_priority"

Defined in: src/constants/options.ts:337

i_qfactor?

optional i_qfactor?: number

Defined in: src/constants/options.ts:110

QP factor between P- and I-frames

i_qoffset?

optional i_qoffset?: number

Defined in: src/constants/options.ts:112

QP offset between P- and I-frames

idct?

optional idct?: "auto" | "int" | "altivec" | "simple" | "simplemmx" | "arm" | "simplearm" | "simplearmv5te" | "simplearmv6" | "simpleneon" | "xvid" | "xvidmmx" | "faani" | "simpleauto"

Defined in: src/constants/options.ts:126

select IDCT implementation

ildctcmp?

optional ildctcmp?: "psnr" | "rd" | "sad" | "sse" | "satd" | "dct" | "bit" | "zero" | "vsad" | "vsse" | "nsse" | "w53" | "w97" | "dctmax" | "chroma" | "msad"

Defined in: src/constants/options.ts:204

interlaced DCT compare function

keyint_min?

optional keyint_min?: number

Defined in: src/constants/options.ts:220

minimum interval between IDR-frames

last_pred?

optional last_pred?: number

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

amount of motion predictors from the previous frame

level?

optional level?: "unknown"

Defined in: src/constants/options.ts:194

encoding level, usually corresponding to the profile level, codec-specific

log_level_offset?

optional log_level_offset?: number

Defined in: src/constants/options.ts:306

set the log level offset

lowres?

optional lowres?: number

Defined in: src/constants/options.ts:196

decode at 1= 1/2, 2=1/4, 3=1/8 resolutions

lumi_mask?

optional lumi_mask?: number

Defined in: src/constants/options.ts:116

compresses bright areas stronger than medium ones

max_pixels?

optional max_pixels?: number

Defined in: src/constants/options.ts:334

Maximum number of pixels

max_samples?

optional max_samples?: number

Defined in: src/constants/options.ts:336

Maximum number of samples

maxrate?

optional maxrate?: number

Defined in: src/constants/options.ts:104

maximum bitrate (in bits/s). Used for VBV together with bufsize.

mbcmp?

optional mbcmp?: "psnr" | "rd" | "sad" | "sse" | "satd" | "dct" | "bit" | "zero" | "vsad" | "vsse" | "nsse" | "w53" | "w97" | "dctmax" | "chroma" | "msad"

Defined in: src/constants/options.ts:202

macroblock compare function

mbd?

optional mbd?: "simple" | "bits" | "rd"

Defined in: src/constants/options.ts:179

macroblock decision algorithm (high quality mode)

mblmax?

optional mblmax?: number

Defined in: src/constants/options.ts:210

maximum macroblock Lagrange factor (VBR)

mblmin?

optional mblmin?: number

Defined in: src/constants/options.ts:208

minimum macroblock Lagrange factor (VBR)

me_range?

optional me_range?: number

Defined in: src/constants/options.ts:175

limit motion vectors range (1023 for DivX player)

minrate?

optional minrate?: number

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

minimum bitrate (in bits/s). Most useful in setting up a CBR encode. It is of little use otherwise.

mv0_threshold?

optional mv0_threshold?: number

Defined in: src/constants/options.ts:225

nssew?

optional nssew?: number

Defined in: src/constants/options.ts:187

nsse weight

p_mask?

optional p_mask?: number

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

inter masking

pixel_format?

optional pixel_format?: string

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

set pixel format

pkt_timebase?

optional pkt_timebase?: string | number

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

pre_dia_size?

optional pre_dia_size?: number

Defined in: src/constants/options.ts:171

diamond type & size for motion estimation pre-pass

precmp?

optional precmp?: "psnr" | "rd" | "sad" | "sse" | "satd" | "dct" | "bit" | "zero" | "vsad" | "vsse" | "nsse" | "w53" | "w97" | "dctmax" | "chroma" | "msad"

Defined in: src/constants/options.ts:206

pre motion estimation compare function

profile?

optional profile?: "unknown" | "main10"

Defined in: src/constants/options.ts:192

qblur?

optional qblur?: number

Defined in: src/constants/options.ts:64

video quantizer scale blur (VBR)

qcomp?

optional qcomp?: number

Defined in: src/constants/options.ts:62

video quantizer scale compression (VBR). Constant of ratecontrol equation.

qdiff?

optional qdiff?: number

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

maximum difference between the quantizer scales (VBR)

qmax?

optional qmax?: number

Defined in: src/constants/options.ts:68

maximum video quantizer scale (VBR)

qmin?

optional qmin?: number

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

minimum video quantizer scale (VBR)

rc_init_occupancy?

optional rc_init_occupancy?: number

Defined in: src/constants/options.ts:181

number of bits which should be loaded into the rc buffer before decoding starts

rc_max_vbv_use?

optional rc_max_vbv_use?: number

Defined in: src/constants/options.ts:229

rc_min_vbv_use?

optional rc_min_vbv_use?: number

Defined in: src/constants/options.ts:230

rc_override_count?

optional rc_override_count?: number

Defined in: src/constants/options.ts:102

refs?

optional refs?: number

Defined in: src/constants/options.ts:222

reference frames to consider for motion compensation

request_sample_fmt?

optional request_sample_fmt?: string

Defined in: src/constants/options.ts:314

sample format audio decoders should prefer

sar?

optional sar?: string | number

Defined in: src/constants/options.ts:147

sample aspect ratio

scplx_mask?

optional scplx_mask?: number

Defined in: src/constants/options.ts:120

spatial complexity masking

side_data_prefer_packet?

optional side_data_prefer_packet?: "replaygain" | "displaymatrix" | "spherical" | "stereo3d" | "audio_service_type" | "mastering_display_metadata" | "content_light_level" | "icc_profile" | "exif"

Defined in: src/constants/options.ts:343

Comma-separated list of side data types for which user-supplied (container) data is preferred over coded bytestream

skip_alpha?

optional skip_alpha?: boolean

Defined in: src/constants/options.ts:322

Skip processing alpha

skip_bottom?

optional skip_bottom?: number

Defined in: src/constants/options.ts:191

number of macroblock rows at the bottom which are skipped

skip_frame?

optional skip_frame?: "none" | "default" | "noref" | "bidir" | "nointra" | "nokey" | "all"

Defined in: src/constants/options.ts:216

skip decoding for the selected frames

skip_idct?

optional skip_idct?: "none" | "default" | "noref" | "bidir" | "nointra" | "nokey" | "all"

Defined in: src/constants/options.ts:214

skip IDCT/dequantization for the selected frames

skip_loop_filter?

optional skip_loop_filter?: "none" | "default" | "noref" | "bidir" | "nointra" | "nokey" | "all"

Defined in: src/constants/options.ts:212

skip loop filtering process for the selected frames

skip_top?

optional skip_top?: number

Defined in: src/constants/options.ts:189

number of macroblock rows at the top which are skipped

slice_flags?

optional slice_flags?: number

Defined in: src/constants/options.ts:177

slices?

optional slices?: number

Defined in: src/constants/options.ts:308

set the number of slices, used in parallelized encoding

strict?

optional strict?: "very" | "strict" | "normal" | "unofficial" | "experimental"

Defined in: src/constants/options.ts:95

how strictly to follow the standards

sub_charenc?

optional sub_charenc?: string

Defined in: src/constants/options.ts:317

set input text subtitles character encoding

sub_charenc_mode?

optional sub_charenc_mode?: string & object | "auto" | "do_nothing" | "pre_decoder" | "ignore"

Defined in: src/constants/options.ts:319

set input text subtitles character encoding mode

subcmp?

optional subcmp?: "psnr" | "rd" | "sad" | "sse" | "satd" | "dct" | "bit" | "zero" | "vsad" | "vsse" | "nsse" | "w53" | "w97" | "dctmax" | "chroma" | "msad"

Defined in: src/constants/options.ts:200

sub-pel ME compare function

subq?

optional subq?: number

Defined in: src/constants/options.ts:173

sub-pel motion estimation quality

tcplx_mask?

optional tcplx_mask?: number

Defined in: src/constants/options.ts:118

temporal complexity masking

thread_type?

optional thread_type?: "slice" | string & object | "frame"

Defined in: src/constants/options.ts:310

select multithreading type

threads?

optional threads?: "auto"

Defined in: src/constants/options.ts:183

set the number of threads

time_base?

optional time_base?: string | number

Defined in: src/constants/options.ts:51

trellis?

optional trellis?: number

Defined in: src/constants/options.ts:224

rate-distortion optimal quantization

video_size?

optional video_size?: string

Defined in: src/constants/options.ts:332

set video size

Interface: CodecContextOptions ​

Properties ​

ab? ​

alpha_mode? ​

apply_cropping? ​

ar? ​

aspect? ​

audio_service_type? ​

b? ​

b_qfactor? ​

b_qoffset? ​

bf? ​

bidir_refine? ​

bits_per_coded_sample? ​

bits_per_raw_sample? ​

block_align? ​

bt? ​

bufsize? ​

bug? ​

ch_layout? ​

chroma_sample_location? ​

cmp? ​

codec_tag? ​

codec_whitelist? ​

color_primaries? ​

color_range? ​

color_trc? ​

colorspace? ​

compression_level? ​

cutoff? ​

dark_mask? ​

dc? ​

dct? ​

debug? ​

delay? ​

dia_size? ​

discard_damaged_percentage? ​

dump_separator? ​

ec? ​

err_detect? ​

export_side_data? ​

extra_hw_frames? ​

field_order? ​

flags? ​

flags2? ​

frame_number? ​

frame_size? ​

g? ​

global_quality? ​

has_b_frames? ​

hwaccel_flags? ​

i_qfactor? ​

i_qoffset? ​

idct? ​

ildctcmp? ​

keyint_min? ​

last_pred? ​

level? ​

log_level_offset? ​

lowres? ​

lumi_mask? ​

max_pixels? ​

max_samples? ​

maxrate? ​

mbcmp? ​

mbd? ​

mblmax? ​

mblmin? ​

me_range? ​

minrate? ​

mv0_threshold? ​

nssew? ​

p_mask? ​

pixel_format? ​

pkt_timebase? ​

pre_dia_size? ​

precmp? ​

profile? ​

qblur? ​

qcomp? ​