node-av / constants / DecoderOptionsMap
Interface: DecoderOptionsMap
Defined in: src/constants/options.ts:3728
Properties
aac
aac:
object
Defined in: src/constants/options.ts:3733
AAC (Advanced Audio Coding)
channel_order?
optionalchannel_order?:"default"|"coded"
Order in which the channels are to be exported
dual_mono_mode?
optionaldual_mono_mode?:"auto"|"sub"|"main"|"both"
Select the channel to decode for dual mono
target_level?
optionaltarget_level?:number
Target output loudness in dBFS for xHE-AAC normalization (0 = disabled)
See
https://ffmpeg.org/ffmpeg-codecs.html#aac
aac_fixed
aac_fixed:
object
Defined in: src/constants/options.ts:3745
AAC (Advanced Audio Coding)
channel_order?
optionalchannel_order?:"default"|"coded"
Order in which the channels are to be exported
dual_mono_mode?
optionaldual_mono_mode?:"auto"|"sub"|"main"|"both"
Select the channel to decode for dual mono
target_level?
optionaltarget_level?:number
Target output loudness in dBFS for xHE-AAC normalization (0 = disabled)
See
https://ffmpeg.org/ffmpeg-codecs.html#aac_005ffixed
ac3
ac3:
object
Defined in: src/constants/options.ts:3757
ATSC A/52A (AC-3)
cons_noisegen?
optionalcons_noisegen?:boolean
enable consistent noise generation
dmix_mode?
optionaldmix_mode?:number
Preferred Stereo Downmix Mode
downmix?
optionaldownmix?:string
Request a specific channel layout from the decoder
drc_scale?
optionaldrc_scale?:number
percentage of dynamic range compression to apply
heavy_compr?
optionalheavy_compr?:boolean
enable heavy dynamic range compression
loro_cmixlev?
optionalloro_cmixlev?:number
Lo/Ro Center Mix Level
loro_surmixlev?
optionalloro_surmixlev?:number
Lo/Ro Surround Mix Level
ltrt_cmixlev?
optionalltrt_cmixlev?:number
Lt/Rt Center Mix Level
ltrt_surmixlev?
optionalltrt_surmixlev?:number
Lt/Rt Surround Mix Level
target_level?
optionaltarget_level?:number
target level in -dBFS (0 not applied)
See
https://ffmpeg.org/ffmpeg-codecs.html#ac3
ac3_fixed
ac3_fixed:
object
Defined in: src/constants/options.ts:3783
ATSC A/52A (AC-3)
cons_noisegen?
optionalcons_noisegen?:boolean
enable consistent noise generation
downmix?
optionaldownmix?:string
Request a specific channel layout from the decoder
drc_scale?
optionaldrc_scale?:number
percentage of dynamic range compression to apply
heavy_compr?
optionalheavy_compr?:boolean
enable heavy dynamic range compression
See
https://ffmpeg.org/ffmpeg-codecs.html#ac3_005ffixed
ac4
ac4:
object
Defined in: src/constants/options.ts:3797
Dolby AC-4
presentation?
optionalpresentation?:number
select presentation
See
https://ffmpeg.org/ffmpeg-codecs.html#ac4
alac
alac:
object
Defined in: src/constants/options.ts:3805
ALAC (Apple Lossless Audio Codec)
extra_bits_bug?
optionalextra_bits_bug?:boolean
Force non-standard decoding process
See
https://ffmpeg.org/ffmpeg-codecs.html#alac
als
als:
object
Defined in: src/constants/options.ts:3813
MPEG-4 Audio Lossless Coding (ALS)
max_order?
optionalmax_order?:number
Sets the maximum order (ALS simple profile allows max 15)
See
https://ffmpeg.org/ffmpeg-codecs.html#als
ape
ape:
object
Defined in: src/constants/options.ts:3821
Monkey's Audio
max_samples?
optionalmax_samples?:"all"
maximum number of samples decoded per call
See
https://ffmpeg.org/ffmpeg-codecs.html#ape
av1
av1:
object
Defined in: src/constants/options.ts:3829
Alliance for Open Media AV1
operating_point?
optionaloperating_point?:number
Select an operating point of the scalable bitstream
See
https://ffmpeg.org/ffmpeg-codecs.html#av1
cc_dec
cc_dec:
object
Defined in: src/constants/options.ts:3837
Closed Captions (EIA-608 / CEA-708)
data_field?
optionaldata_field?:"auto"|"first"|"second"
select data field
real_time?
optionalreal_time?:boolean
emit subtitle events as they are decoded for real-time display
real_time_latency_msec?
optionalreal_time_latency_msec?:number
minimum elapsed time between emitting real-time subtitle events
See
https://ffmpeg.org/ffmpeg-codecs.html#cc_005fdec
dca
dca:
object
Defined in: src/constants/options.ts:3849
DCA (DTS Coherent Acoustics)
channel_order?
optionalchannel_order?:"default"|"coded"
Order in which the channels are to be exported
core_only?
optionalcore_only?:boolean
Decode core only without extensions
downmix?
optionaldownmix?:string
Request a specific channel layout from the decoder
See
https://ffmpeg.org/ffmpeg-codecs.html#dca
dolby_e
dolby_e:
object
Defined in: src/constants/options.ts:3861
Dolby E
channel_order?
optionalchannel_order?:"default"|"coded"
Order in which the channels are to be exported
See
https://ffmpeg.org/ffmpeg-codecs.html#dolby_005fe
dvbsub
dvbsub:
object
Defined in: src/constants/options.ts:3869
DVB subtitles
compute_clut?
optionalcompute_clut?:boolean
compute clut when not available(-1) or only once (-2) or always(1) or never(0)
compute_edt?
optionalcompute_edt?:boolean
compute end of time using pts or timeout
dvb_substream?
optionaldvb_substream?:number
See
https://ffmpeg.org/ffmpeg-codecs.html#dvbsub
dvdsub
dvdsub:
object
Defined in: src/constants/options.ts:3880
DVD subtitles
forced_subs_only?
optionalforced_subs_only?:boolean
Only show forced subtitles
ifo_palette?
optionalifo_palette?:string
obtain the global palette from .IFO file
palette?
optionalpalette?:string
set the global palette
See
https://ffmpeg.org/ffmpeg-codecs.html#dvdsub
eac3
eac3:
object
Defined in: src/constants/options.ts:3892
ATSC A/52B (AC-3, E-AC-3)
cons_noisegen?
optionalcons_noisegen?:boolean
enable consistent noise generation
dmix_mode?
optionaldmix_mode?:number
Preferred Stereo Downmix Mode
downmix?
optionaldownmix?:string
Request a specific channel layout from the decoder
drc_scale?
optionaldrc_scale?:number
percentage of dynamic range compression to apply
heavy_compr?
optionalheavy_compr?:boolean
enable heavy dynamic range compression
loro_cmixlev?
optionalloro_cmixlev?:number
Lo/Ro Center Mix Level
loro_surmixlev?
optionalloro_surmixlev?:number
Lo/Ro Surround Mix Level
ltrt_cmixlev?
optionalltrt_cmixlev?:number
Lt/Rt Center Mix Level
ltrt_surmixlev?
optionalltrt_surmixlev?:number
Lt/Rt Surround Mix Level
target_level?
optionaltarget_level?:number
target level in -dBFS (0 not applied)
See
https://ffmpeg.org/ffmpeg-codecs.html#eac3
evrc
evrc:
object
Defined in: src/constants/options.ts:3918
EVRC (Enhanced Variable Rate Codec)
postfilter?
optionalpostfilter?:boolean
enable postfilter
See
https://ffmpeg.org/ffmpeg-codecs.html#evrc
exr
exr:
object
Defined in: src/constants/options.ts:3926
OpenEXR image
apply_trc?
optionalapply_trc?:"bt709"|"smpte170m"|"smpte240m"|"smpte428_1"|"gamma22"|"gamma28"|"linear"|"smpte2084"|"log"|"log_sqrt"|"iec61966_2_4"|"bt1361"|"iec61966_2_1"|"bt2020_10bit"|"bt2020_12bit"|"gamma"
color transfer characteristics to apply to EXR linear input (deprecated, use a scaler)
gamma?
optionalgamma?:number
Set the float gamma value when decoding (deprecated, use a scaler)
layer?
optionallayer?:string
Set the decoding layer
part?
optionalpart?:number
Set the decoding part
See
https://ffmpeg.org/ffmpeg-codecs.html#exr
fic
fic:
object
Defined in: src/constants/options.ts:3956
Mirillis FIC
skip_cursor?
optionalskip_cursor?:boolean
skip the cursor
See
https://ffmpeg.org/ffmpeg-codecs.html#fic
fits
fits:
object
Defined in: src/constants/options.ts:3964
Flexible Image Transport System
blank_value?
optionalblank_value?:number
value that is used to replace BLANK pixels in data array
See
https://ffmpeg.org/ffmpeg-codecs.html#fits
flac
flac:
object
Defined in: src/constants/options.ts:3972
FLAC (Free Lossless Audio Codec)
use_buggy_lpc?
optionaluse_buggy_lpc?:boolean
emulate old buggy lavc behavior
See
https://ffmpeg.org/ffmpeg-codecs.html#flac
frwu
frwu:
object
Defined in: src/constants/options.ts:3980
Forward Uncompressed
change_field_order?
optionalchange_field_order?:boolean
Change field order
See
https://ffmpeg.org/ffmpeg-codecs.html#frwu
g722
g722:
object
Defined in: src/constants/options.ts:3988
G.722 ADPCM
bits_per_codeword?
optionalbits_per_codeword?:number
Bits per G722 codeword
See
https://ffmpeg.org/ffmpeg-codecs.html#g722
g723_1
g723_1:
object
Defined in: src/constants/options.ts:3996
G.723.1
postfilter?
optionalpostfilter?:boolean
enable postfilter
See
https://ffmpeg.org/ffmpeg-codecs.html#g723_005f1
gif
gif:
object
Defined in: src/constants/options.ts:4004
GIF (Graphics Interchange Format)
trans_color?
optionaltrans_color?:number
color value (ARGB) that is used instead of transparent color
See
https://ffmpeg.org/ffmpeg-codecs.html#gif
h264
h264:
object
Defined in: src/constants/options.ts:4012
H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
enable_er?
optionalenable_er?:boolean
Enable error resilience on damaged frames (unsafe)
is_avc?
optionalis_avc?:boolean
is avc
nal_length_size?
optionalnal_length_size?:number
nal_length_size
noref_gray?
optionalnoref_gray?:boolean
Avoid using gray gap frames as references
skip_gray?
optionalskip_gray?:boolean
Do not return gray gap frames
x264_build?
optionalx264_build?:number
Assume this x264 version if no x264 version found in any SEI
See
https://ffmpeg.org/ffmpeg-codecs.html#h264
hevc
hevc:
object
Defined in: src/constants/options.ts:4030
HEVC (High Efficiency Video Coding)
apply_defdispwin?
optionalapply_defdispwin?:boolean
Apply default display window from VUI
strict-displaywin?
optionalstrict-displaywin?:boolean
strictly apply default display window size
view_ids?
optionalview_ids?:string
Array of view IDs that should be decoded and output; a single -1 to decode all views
view_ids_available?
optionalview_ids_available?:string
Array of available view IDs is exported here
view_pos_available?
optionalview_pos_available?:"unspecified"|"left"|"right"
Array of view positions for view_ids_available is exported here, as AVStereo3DView
See
https://ffmpeg.org/ffmpeg-codecs.html#hevc
jpeg2000
jpeg2000:
object
Defined in: src/constants/options.ts:4046
JPEG 2000
lowres?
optionallowres?:number
Lower the decoding resolution by a power of two
See
https://ffmpeg.org/ffmpeg-codecs.html#jpeg2000
libaribb24
libaribb24:
object
Defined in: src/constants/options.ts:4054
libaribb24 ARIB STD-B24 caption decoder
aribb24-base-path?
optionalaribb24-base-path?:string
set the base path for the libaribb24 library
aribb24-skip-ruby-text?
optionalaribb24-skip-ruby-text?:boolean
skip ruby text blocks during decoding
default_profile?
optionaldefault_profile?:"a"|"c"
default profile to use if not specified in the stream parameters
See
https://ffmpeg.org/ffmpeg-codecs.html#libaribb24
libaribcaption
libaribcaption:
object
Defined in: src/constants/options.ts:4066
ARIB STD-B24 caption decoder
ass_single_rect?
optionalass_single_rect?:boolean
workaround of ASS subtitle for players which can't handle multi-rectangle [ass]
canvas_size?
optionalcanvas_size?:string
set input video size (WxH or abbreviation) [bitmap]
caption_encoding?
optionalcaption_encoding?:"utf8"|"auto"|"jis"|"latin"
encoding scheme of subtitle text
font?
optionalfont?:string
comma-separated font family [ass, bitmap]
force_outline_text?
optionalforce_outline_text?:boolean
always render characters with outline [(ass), bitmap]
ignore_background?
optionalignore_background?:boolean
ignore rendering caption background [(ass), bitmap]
ignore_ruby?
optionalignore_ruby?:boolean
ignore ruby-like characters [ass, bitmap]
outline_width?
optionaloutline_width?:number
outline width of text [(ass), bitmap]
replace_drcs?
optionalreplace_drcs?:boolean
replace known DRCS [bitmap]
replace_msz_ascii?
optionalreplace_msz_ascii?:boolean
replace MSZ fullwidth alphanumerics with halfwidth alphanumerics [ass, bitmap]
replace_msz_glyph?
optionalreplace_msz_glyph?:boolean
replace MSZ characters with halfwidth glyphs [bitmap]
replace_msz_japanese?
optionalreplace_msz_japanese?:boolean
replace MSZ fullwidth Japanese with halfwidth [ass, bitmap]
sub_type?
optionalsub_type?:"none"|"bitmap"|"text"|"ass"
subtitle rendering type
See
https://ffmpeg.org/ffmpeg-codecs.html#libaribcaption
libdav1d
libdav1d:
object
Defined in: src/constants/options.ts:4098
dav1d AV1 decoder by VideoLAN
alllayers?
optionalalllayers?:boolean
Output all spatial layers
filmgrain?
optionalfilmgrain?:boolean
Apply Film Grain
max_frame_delay?
optionalmax_frame_delay?:number
Max frame delay
oppoint?
optionaloppoint?:number
Select an operating point of the scalable bitstream
See
https://ffmpeg.org/ffmpeg-codecs.html#libdav1d
libfdk_aac
libfdk_aac:
object
Defined in: src/constants/options.ts:4112
Fraunhofer FDK AAC
album_mode?
optionalalbum_mode?:number
Dynamic Range Control: album mode, where [0] is off and [1] is on
conceal?
optionalconceal?:"spectral"|"noise"|"energy"
Error concealment method
downmix?
optionaldownmix?:string
Request a specific channel layout from the decoder
drc_boost?
optionaldrc_boost?:number
Dynamic Range Control: boost, where [0] is none and [127] is max boost
drc_cut?
optionaldrc_cut?:number
Dynamic Range Control: attenuation factor, where [0] is none and [127] is max compression
drc_effect?
optionaldrc_effect?:number
Dynamic Range Control: effect type, where e.g. [0] is none and [6] is general
drc_heavy?
optionaldrc_heavy?:number
Dynamic Range Control: heavy compression, where [1] is on (RF mode) and [0] is off
drc_level?
optionaldrc_level?:number
Dynamic Range Control: reference level, quantized to 0.25dB steps where [0] is 0dB and [127] is -31.75dB, -1 for auto, and -2 for disabled
level_limit?
optionallevel_limit?:boolean
Signal level limiting
See
https://ffmpeg.org/ffmpeg-codecs.html#libfdk_005faac
libilbc
libilbc:
object
Defined in: src/constants/options.ts:4136
iLBC (Internet Low Bitrate Codec)
enhance?
optionalenhance?:number
Enhance the decoded audio (adds delay)
See
https://ffmpeg.org/ffmpeg-codecs.html#libilbc
libopus
libopus:
object
Defined in: src/constants/options.ts:4144
libopus Opus
apply_phase_inv?
optionalapply_phase_inv?:boolean
Apply intensity stereo phase inversion
See
https://ffmpeg.org/ffmpeg-codecs.html#libopus
librsvg
librsvg:
object
Defined in: src/constants/options.ts:4152
Librsvg rasterizer
height?
optionalheight?:number
Height to render to (0 for default)
keep_ar?
optionalkeep_ar?:boolean
Keep aspect ratio with custom width/height
width?
optionalwidth?:number
Width to render to (0 for default)
See
https://ffmpeg.org/ffmpeg-codecs.html#librsvg
libzvbi_teletextdec
libzvbi_teletextdec:
object
Defined in: src/constants/options.ts:4164
Libzvbi DVB teletext decoder
txt_chop_spaces?
optionaltxt_chop_spaces?:number
chops leading and trailing spaces from text
txt_chop_top?
optionaltxt_chop_top?:number
discards the top teletext line
txt_default_region?
optionaltxt_default_region?:number
default G0 character set used for decoding
txt_duration?
optionaltxt_duration?:number
display duration of teletext pages in msecs
txt_format?
optionaltxt_format?:"bitmap"|"text"|"ass"
format of the subtitles (bitmap or text or ass)
txt_left?
optionaltxt_left?:number
x offset of generated bitmaps
txt_opacity?
optionaltxt_opacity?:number
set opacity of the transparent background
txt_page?
optionaltxt_page?:string
page numbers to decode, subtitle for subtitles, * for all
txt_top?
optionaltxt_top?:number
y offset of generated bitmaps
txt_transparent?
optionaltxt_transparent?:number
force transparent background of the teletext
See
https://ffmpeg.org/ffmpeg-codecs.html#libzvbi_005fteletextdec
mjpeg
mjpeg:
object
Defined in: src/constants/options.ts:4190
MJPEG (Motion JPEG)
extern_huff?
optionalextern_huff?:boolean
Use external huffman table.
See
https://ffmpeg.org/ffmpeg-codecs.html#mjpeg
mlp
mlp:
object
Defined in: src/constants/options.ts:4198
MLP (Meridian Lossless Packing)
downmix?
optionaldownmix?:string
Request a specific channel layout from the decoder
See
https://ffmpeg.org/ffmpeg-codecs.html#mlp
mov_text
mov_text:
object
Defined in: src/constants/options.ts:4206
3GPP Timed Text subtitle
height?
optionalheight?:number
Frame height, usually video height
width?
optionalwidth?:number
Frame width, usually video width
See
https://ffmpeg.org/ffmpeg-codecs.html#mov_005ftext
mpeg2video
mpeg2video:
object
Defined in: src/constants/options.ts:4216
MPEG-2 video
cc_format?
optionalcc_format?:"auto"|"a53"|"scte20"|"dvd"|"dish"
extract a specific Closed Captions format
See
https://ffmpeg.org/ffmpeg-codecs.html#mpeg2video
mpeg4
mpeg4:
object
Defined in: src/constants/options.ts:4224
MPEG-4 part 2
divx_packed?
optionaldivx_packed?:boolean
divx style packed b frames
quarter_sample?
optionalquarter_sample?:boolean
1/4 subpel MC
See
https://ffmpeg.org/ffmpeg-codecs.html#mpeg4
opus
opus:
object
Defined in: src/constants/options.ts:4234
Opus
apply_phase_inv?
optionalapply_phase_inv?:boolean
Apply intensity stereo phase inversion
See
https://ffmpeg.org/ffmpeg-codecs.html#opus
pgssub
pgssub:
object
Defined in: src/constants/options.ts:4242
HDMV Presentation Graphic Stream subtitles
forced_subs_only?
optionalforced_subs_only?:boolean
Only show forced subtitles
See
https://ffmpeg.org/ffmpeg-codecs.html#pgssub
photocd
photocd:
object
Defined in: src/constants/options.ts:4250
Kodak Photo CD
lowres?
optionallowres?:number
Lower the decoding resolution by a power of two
See
https://ffmpeg.org/ffmpeg-codecs.html#photocd
pjs
pjs:
object
Defined in: src/constants/options.ts:4258
PJS subtitle
keep_ass_markup?
optionalkeep_ass_markup?:boolean
Set if ASS tags must be escaped
See
https://ffmpeg.org/ffmpeg-codecs.html#pjs
rasc
rasc:
object
Defined in: src/constants/options.ts:4266
RemotelyAnywhere Screen Capture
skip_cursor?
optionalskip_cursor?:boolean
skip the cursor
See
https://ffmpeg.org/ffmpeg-codecs.html#rasc
rawvideo
rawvideo:
object
Defined in: src/constants/options.ts:4274
raw video
top?
optionaltop?:boolean
top field first
See
https://ffmpeg.org/ffmpeg-codecs.html#rawvideo
s302m
s302m:
object
Defined in: src/constants/options.ts:4282
SMPTE 302M
non_pcm_mode?
optionalnon_pcm_mode?:"copy"|"drop"|"decode_copy"|"decode_drop"
Chooses what to do with NON-PCM
See
https://ffmpeg.org/ffmpeg-codecs.html#s302m
stl
stl:
object
Defined in: src/constants/options.ts:4290
Spruce subtitle format
keep_ass_markup?
optionalkeep_ass_markup?:boolean
Set if ASS tags must be escaped
See
https://ffmpeg.org/ffmpeg-codecs.html#stl
subviewer1
subviewer1:
object
Defined in: src/constants/options.ts:4298
SubViewer1 subtitle
keep_ass_markup?
optionalkeep_ass_markup?:boolean
Set if ASS tags must be escaped
See
https://ffmpeg.org/ffmpeg-codecs.html#subviewer1
text
text:
object
Defined in: src/constants/options.ts:4306
Raw text subtitle
keep_ass_markup?
optionalkeep_ass_markup?:boolean
Set if ASS tags must be escaped
See
https://ffmpeg.org/ffmpeg-codecs.html#text
tiff
tiff:
object
Defined in: src/constants/options.ts:4314
TIFF image
page?
optionalpage?:number
page number of multi-page image to decode (starting from 1)
subimage?
optionalsubimage?:boolean
decode subimage instead if available
thumbnail?
optionalthumbnail?:boolean
decode embedded thumbnail subimage instead if available
See
https://ffmpeg.org/ffmpeg-codecs.html#tiff
truehd
truehd:
object
Defined in: src/constants/options.ts:4326
TrueHD
downmix?
optionaldownmix?:string
Request a specific channel layout from the decoder
See
https://ffmpeg.org/ffmpeg-codecs.html#truehd
tta
tta:
object
Defined in: src/constants/options.ts:4334
TTA (True Audio)
password?
optionalpassword?:string
Set decoding password
See
https://ffmpeg.org/ffmpeg-codecs.html#tta
v210
v210:
object
Defined in: src/constants/options.ts:4342
Uncompressed 4:2:2 10-bit
custom_stride?
optionalcustom_stride?:number
Custom V210 stride
See
https://ffmpeg.org/ffmpeg-codecs.html#v210
vplayer
vplayer:
object
Defined in: src/constants/options.ts:4350
VPlayer subtitle
keep_ass_markup?
optionalkeep_ass_markup?:boolean
Set if ASS tags must be escaped