filters
¶
acrossfade
¶
acrossfade(
_crossfade0: AudioStream,
_crossfade1: AudioStream,
*,
nb_samples: Int = Default(44100),
duration: Duration = Default(0.0),
overlap: Boolean = Default(True),
curve1: (
Int
| Literal[
"nofade",
"tri",
"qsin",
"esin",
"hsin",
"log",
"ipar",
"qua",
"cub",
"squ",
"cbr",
"par",
"exp",
"iqsin",
"ihsin",
"dese",
"desi",
"losi",
"sinc",
"isinc",
]
| Default
) = Default("tri"),
curve2: (
Int
| Literal[
"nofade",
"tri",
"qsin",
"esin",
"hsin",
"log",
"ipar",
"qua",
"cub",
"squ",
"cbr",
"par",
"exp",
"iqsin",
"ihsin",
"dese",
"desi",
"losi",
"sinc",
"isinc",
]
| Default
) = Default("tri"),
**kwargs: Any
) -> AudioStream
Cross fade two input audio streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
nb_samples |
Int
|
set number of samples for cross fade duration (from 1 to 2.14748e+08) (default 44100) |
Default(44100)
|
duration |
Duration
|
set cross fade duration (default 0) |
Default(0.0)
|
overlap |
Boolean
|
overlap 1st stream end with 2nd stream start (default true) |
Default(True)
|
curve1 |
Int | Literal['nofade', 'tri', 'qsin', 'esin', 'hsin', 'log', 'ipar', 'qua', 'cub', 'squ', 'cbr', 'par', 'exp', 'iqsin', 'ihsin', 'dese', 'desi', 'losi', 'sinc', 'isinc'] | Default
|
set fade curve type for 1st stream (from -1 to 18) (default tri) |
Default('tri')
|
curve2 |
Int | Literal['nofade', 'tri', 'qsin', 'esin', 'hsin', 'log', 'ipar', 'qua', 'cub', 'squ', 'cbr', 'par', 'exp', 'iqsin', 'ihsin', 'dese', 'desi', 'losi', 'sinc', 'isinc'] | Default
|
set fade curve type for 2nd stream (from -1 to 18) (default tri) |
Default('tri')
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
ainterleave
¶
ainterleave(
*streams: AudioStream,
nb_inputs: Int = Auto("len(streams)"),
duration: (
Int
| Literal["longest", "shortest", "first"]
| Default
) = Default("longest"),
**kwargs: Any
) -> AudioStream
Temporally interleave audio inputs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
nb_inputs |
Int
|
set number of inputs (from 1 to INT_MAX) (default 2) |
Auto('len(streams)')
|
duration |
Int | Literal['longest', 'shortest', 'first'] | Default
|
how to determine the end-of-stream (from 0 to 2) (default longest) |
Default('longest')
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
alphamerge
¶
alphamerge(
_main: VideoStream,
_alpha: VideoStream,
*,
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Copy the luma value of the second input into the alpha channel of the first input.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
amerge
¶
amerge(
*streams: AudioStream,
inputs: Int = Auto("len(streams)"),
**kwargs: Any
) -> AudioStream
Merge two or more audio streams into a single multi-channel stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
specify the number of inputs (from 1 to 64) (default 2) |
Auto('len(streams)')
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
amix
¶
amix(
*streams: AudioStream,
inputs: Int = Auto("len(streams)"),
duration: (
Int
| Literal["longest", "shortest", "first"]
| Default
) = Default("longest"),
dropout_transition: Float = Default(2.0),
weights: String = Default("1 1"),
normalize: Boolean = Default(True),
**kwargs: Any
) -> AudioStream
Audio mixing.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
Number of inputs. (from 1 to 32767) (default 2) |
Auto('len(streams)')
|
duration |
Int | Literal['longest', 'shortest', 'first'] | Default
|
How to determine the end-of-stream. (from 0 to 2) (default longest) |
Default('longest')
|
dropout_transition |
Float
|
Transition time, in seconds, for volume renormalization when an input stream ends. (from 0 to INT_MAX) (default 2) |
Default(2.0)
|
weights |
String
|
Set weight for each input. (default "1 1") |
Default('1 1')
|
normalize |
Boolean
|
Scale inputs (default true) |
Default(True)
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
amultiply
¶
amultiply(
_multiply0: AudioStream,
_multiply1: AudioStream,
**kwargs: Any
) -> AudioStream
Multiply two audio streams.
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
anlmf
¶
anlmf(
_input: AudioStream,
_desired: AudioStream,
*,
order: Int = Default(256),
mu: Float = Default(0.75),
eps: Float = Default(1.0),
leakage: Float = Default(0.0),
out_mode: (
Int | Literal["i", "d", "o", "n"] | Default
) = Default("o"),
enable: String = Default(None),
**kwargs: Any
) -> AudioStream
Apply Normalized Least-Mean-Fourth algorithm to first audio stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
order |
Int
|
set the filter order (from 1 to 32767) (default 256) |
Default(256)
|
mu |
Float
|
set the filter mu (from 0 to 2) (default 0.75) |
Default(0.75)
|
eps |
Float
|
set the filter eps (from 0 to 1) (default 1) |
Default(1.0)
|
leakage |
Float
|
set the filter leakage (from 0 to 1) (default 0) |
Default(0.0)
|
out_mode |
Int | Literal['i', 'd', 'o', 'n'] | Default
|
set output mode (from 0 to 3) (default o) |
Default('o')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
anlms
¶
anlms(
_input: AudioStream,
_desired: AudioStream,
*,
order: Int = Default(256),
mu: Float = Default(0.75),
eps: Float = Default(1.0),
leakage: Float = Default(0.0),
out_mode: (
Int | Literal["i", "d", "o", "n"] | Default
) = Default("o"),
enable: String = Default(None),
**kwargs: Any
) -> AudioStream
Apply Normalized Least-Mean-Squares algorithm to first audio stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
order |
Int
|
set the filter order (from 1 to 32767) (default 256) |
Default(256)
|
mu |
Float
|
set the filter mu (from 0 to 2) (default 0.75) |
Default(0.75)
|
eps |
Float
|
set the filter eps (from 0 to 1) (default 1) |
Default(1.0)
|
leakage |
Float
|
set the filter leakage (from 0 to 1) (default 0) |
Default(0.0)
|
out_mode |
Int | Literal['i', 'd', 'o', 'n'] | Default
|
set output mode (from 0 to 3) (default o) |
Default('o')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
asdr
¶
asdr(
_input0: AudioStream,
_input1: AudioStream,
**kwargs: Any
) -> AudioStream
Measure Audio Signal-to-Distortion Ratio.
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
astreamselect
¶
astreamselect(
*streams: AudioStream,
inputs: Int = Auto("len(streams)"),
map: String = Default(None),
**kwargs: Any
) -> FilterNode
Select audio streams
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
number of input streams (from 2 to INT_MAX) (default 2) |
Auto('len(streams)')
|
map |
String
|
input indexes to remap to outputs |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
filter_node |
FilterNode
|
the filter node |
References
axcorrelate
¶
axcorrelate(
_axcorrelate0: AudioStream,
_axcorrelate1: AudioStream,
*,
size: Int = Default(256),
algo: Int | Literal["slow", "fast"] | Default = Default(
"slow"
),
**kwargs: Any
) -> AudioStream
Cross-correlate two audio streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
size |
Int
|
set segment size (from 2 to 131072) (default 256) |
Default(256)
|
algo |
Int | Literal['slow', 'fast'] | Default
|
set algorithm (from 0 to 1) (default slow) |
Default('slow')
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
blend
¶
blend(
_top: VideoStream,
_bottom: VideoStream,
*,
c0_mode: (
Int
| Literal[
"addition",
"addition128",
"grainmerge",
"and",
"average",
"burn",
"darken",
"difference",
"difference128",
"grainextract",
"divide",
"dodge",
"exclusion",
"extremity",
"freeze",
"glow",
"hardlight",
"hardmix",
"heat",
"lighten",
"linearlight",
"multiply",
"multiply128",
"negation",
"normal",
"or",
"overlay",
"phoenix",
"pinlight",
"reflect",
"screen",
"softlight",
"subtract",
"vividlight",
"xor",
"softdifference",
"geometric",
"harmonic",
"bleach",
"stain",
"interpolate",
"hardoverlay",
]
| Default
) = Default("normal"),
c1_mode: (
Int
| Literal[
"addition",
"addition128",
"grainmerge",
"and",
"average",
"burn",
"darken",
"difference",
"difference128",
"grainextract",
"divide",
"dodge",
"exclusion",
"extremity",
"freeze",
"glow",
"hardlight",
"hardmix",
"heat",
"lighten",
"linearlight",
"multiply",
"multiply128",
"negation",
"normal",
"or",
"overlay",
"phoenix",
"pinlight",
"reflect",
"screen",
"softlight",
"subtract",
"vividlight",
"xor",
"softdifference",
"geometric",
"harmonic",
"bleach",
"stain",
"interpolate",
"hardoverlay",
]
| Default
) = Default("normal"),
c2_mode: (
Int
| Literal[
"addition",
"addition128",
"grainmerge",
"and",
"average",
"burn",
"darken",
"difference",
"difference128",
"grainextract",
"divide",
"dodge",
"exclusion",
"extremity",
"freeze",
"glow",
"hardlight",
"hardmix",
"heat",
"lighten",
"linearlight",
"multiply",
"multiply128",
"negation",
"normal",
"or",
"overlay",
"phoenix",
"pinlight",
"reflect",
"screen",
"softlight",
"subtract",
"vividlight",
"xor",
"softdifference",
"geometric",
"harmonic",
"bleach",
"stain",
"interpolate",
"hardoverlay",
]
| Default
) = Default("normal"),
c3_mode: (
Int
| Literal[
"addition",
"addition128",
"grainmerge",
"and",
"average",
"burn",
"darken",
"difference",
"difference128",
"grainextract",
"divide",
"dodge",
"exclusion",
"extremity",
"freeze",
"glow",
"hardlight",
"hardmix",
"heat",
"lighten",
"linearlight",
"multiply",
"multiply128",
"negation",
"normal",
"or",
"overlay",
"phoenix",
"pinlight",
"reflect",
"screen",
"softlight",
"subtract",
"vividlight",
"xor",
"softdifference",
"geometric",
"harmonic",
"bleach",
"stain",
"interpolate",
"hardoverlay",
]
| Default
) = Default("normal"),
all_mode: (
Int
| Literal[
"addition",
"addition128",
"grainmerge",
"and",
"average",
"burn",
"darken",
"difference",
"difference128",
"grainextract",
"divide",
"dodge",
"exclusion",
"extremity",
"freeze",
"glow",
"hardlight",
"hardmix",
"heat",
"lighten",
"linearlight",
"multiply",
"multiply128",
"negation",
"normal",
"or",
"overlay",
"phoenix",
"pinlight",
"reflect",
"screen",
"softlight",
"subtract",
"vividlight",
"xor",
"softdifference",
"geometric",
"harmonic",
"bleach",
"stain",
"interpolate",
"hardoverlay",
]
| Default
) = Default(-1),
c0_expr: String = Default(None),
c1_expr: String = Default(None),
c2_expr: String = Default(None),
c3_expr: String = Default(None),
all_expr: String = Default(None),
c0_opacity: Double = Default(1.0),
c1_opacity: Double = Default(1.0),
c2_opacity: Double = Default(1.0),
c3_opacity: Double = Default(1.0),
all_opacity: Double = Default(1.0),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Blend two video frames into each other.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
c0_mode |
Int | Literal['addition', 'addition128', 'grainmerge', 'and', 'average', 'burn', 'darken', 'difference', 'difference128', 'grainextract', 'divide', 'dodge', 'exclusion', 'extremity', 'freeze', 'glow', 'hardlight', 'hardmix', 'heat', 'lighten', 'linearlight', 'multiply', 'multiply128', 'negation', 'normal', 'or', 'overlay', 'phoenix', 'pinlight', 'reflect', 'screen', 'softlight', 'subtract', 'vividlight', 'xor', 'softdifference', 'geometric', 'harmonic', 'bleach', 'stain', 'interpolate', 'hardoverlay'] | Default
|
set component #0 blend mode (from 0 to 39) (default normal) |
Default('normal')
|
c1_mode |
Int | Literal['addition', 'addition128', 'grainmerge', 'and', 'average', 'burn', 'darken', 'difference', 'difference128', 'grainextract', 'divide', 'dodge', 'exclusion', 'extremity', 'freeze', 'glow', 'hardlight', 'hardmix', 'heat', 'lighten', 'linearlight', 'multiply', 'multiply128', 'negation', 'normal', 'or', 'overlay', 'phoenix', 'pinlight', 'reflect', 'screen', 'softlight', 'subtract', 'vividlight', 'xor', 'softdifference', 'geometric', 'harmonic', 'bleach', 'stain', 'interpolate', 'hardoverlay'] | Default
|
set component #1 blend mode (from 0 to 39) (default normal) |
Default('normal')
|
c2_mode |
Int | Literal['addition', 'addition128', 'grainmerge', 'and', 'average', 'burn', 'darken', 'difference', 'difference128', 'grainextract', 'divide', 'dodge', 'exclusion', 'extremity', 'freeze', 'glow', 'hardlight', 'hardmix', 'heat', 'lighten', 'linearlight', 'multiply', 'multiply128', 'negation', 'normal', 'or', 'overlay', 'phoenix', 'pinlight', 'reflect', 'screen', 'softlight', 'subtract', 'vividlight', 'xor', 'softdifference', 'geometric', 'harmonic', 'bleach', 'stain', 'interpolate', 'hardoverlay'] | Default
|
set component #2 blend mode (from 0 to 39) (default normal) |
Default('normal')
|
c3_mode |
Int | Literal['addition', 'addition128', 'grainmerge', 'and', 'average', 'burn', 'darken', 'difference', 'difference128', 'grainextract', 'divide', 'dodge', 'exclusion', 'extremity', 'freeze', 'glow', 'hardlight', 'hardmix', 'heat', 'lighten', 'linearlight', 'multiply', 'multiply128', 'negation', 'normal', 'or', 'overlay', 'phoenix', 'pinlight', 'reflect', 'screen', 'softlight', 'subtract', 'vividlight', 'xor', 'softdifference', 'geometric', 'harmonic', 'bleach', 'stain', 'interpolate', 'hardoverlay'] | Default
|
set component #3 blend mode (from 0 to 39) (default normal) |
Default('normal')
|
all_mode |
Int | Literal['addition', 'addition128', 'grainmerge', 'and', 'average', 'burn', 'darken', 'difference', 'difference128', 'grainextract', 'divide', 'dodge', 'exclusion', 'extremity', 'freeze', 'glow', 'hardlight', 'hardmix', 'heat', 'lighten', 'linearlight', 'multiply', 'multiply128', 'negation', 'normal', 'or', 'overlay', 'phoenix', 'pinlight', 'reflect', 'screen', 'softlight', 'subtract', 'vividlight', 'xor', 'softdifference', 'geometric', 'harmonic', 'bleach', 'stain', 'interpolate', 'hardoverlay'] | Default
|
set blend mode for all components (from -1 to 39) (default -1) |
Default(-1)
|
c0_expr |
String
|
set color component #0 expression |
Default(None)
|
c1_expr |
String
|
set color component #1 expression |
Default(None)
|
c2_expr |
String
|
set color component #2 expression |
Default(None)
|
c3_expr |
String
|
set color component #3 expression |
Default(None)
|
all_expr |
String
|
set expression for all color components |
Default(None)
|
c0_opacity |
Double
|
set color component #0 opacity (from 0 to 1) (default 1) |
Default(1.0)
|
c1_opacity |
Double
|
set color component #1 opacity (from 0 to 1) (default 1) |
Default(1.0)
|
c2_opacity |
Double
|
set color component #2 opacity (from 0 to 1) (default 1) |
Default(1.0)
|
c3_opacity |
Double
|
set color component #3 opacity (from 0 to 1) (default 1) |
Default(1.0)
|
all_opacity |
Double
|
set opacity for all color components (from 0 to 1) (default 1) |
Default(1.0)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
bm3d
¶
bm3d(
*streams: VideoStream,
sigma: Float = Default(1.0),
block: Int = Default(16),
bstep: Int = Default(4),
group: Int = Default(1),
range: Int = Default(9),
mstep: Int = Default(1),
thmse: Float = Default(0.0),
hdthr: Float = Default(2.7),
estim: (
Int | Literal["basic", "final"] | Default
) = Default("basic"),
ref: Boolean = Default(False),
planes: Int = Default(7),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Block-Matching 3D denoiser.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
sigma |
Float
|
set denoising strength (from 0 to 99999.9) (default 1) |
Default(1.0)
|
block |
Int
|
set size of local patch (from 8 to 64) (default 16) |
Default(16)
|
bstep |
Int
|
set sliding step for processing blocks (from 1 to 64) (default 4) |
Default(4)
|
group |
Int
|
set maximal number of similar blocks (from 1 to 256) (default 1) |
Default(1)
|
range |
Int
|
set block matching range (from 1 to INT_MAX) (default 9) |
Default(9)
|
mstep |
Int
|
set step for block matching (from 1 to 64) (default 1) |
Default(1)
|
thmse |
Float
|
set threshold of mean square error for block matching (from 0 to INT_MAX) (default 0) |
Default(0.0)
|
hdthr |
Float
|
set hard threshold for 3D transfer domain (from 0 to INT_MAX) (default 2.7) |
Default(2.7)
|
estim |
Int | Literal['basic', 'final'] | Default
|
set filtering estimation mode (from 0 to 1) (default basic) |
Default('basic')
|
ref |
Boolean
|
have reference stream (default false) |
Default(False)
|
planes |
Int
|
set planes to filter (from 0 to 15) (default 7) |
Default(7)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
colormap
¶
colormap(
_default: VideoStream,
_source: VideoStream,
_target: VideoStream,
*,
patch_size: Image_size = Default("64x64"),
nb_patches: Int = Default(0),
type: (
Int | Literal["relative", "absolute"] | Default
) = Default("absolute"),
kernel: (
Int | Literal["euclidean", "weuclidean"] | Default
) = Default("euclidean"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Apply custom Color Maps to video stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
patch_size |
Image_size
|
set patch size (default "64x64") |
Default('64x64')
|
nb_patches |
Int
|
set number of patches (from 0 to 64) (default 0) |
Default(0)
|
type |
Int | Literal['relative', 'absolute'] | Default
|
set the target type used (from 0 to 1) (default absolute) |
Default('absolute')
|
kernel |
Int | Literal['euclidean', 'weuclidean'] | Default
|
set the kernel used for measuring color difference (from 0 to 1) (default euclidean) |
Default('euclidean')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
concat
¶
concat(
*streams: FilterableStream,
n: Int = Auto("len(streams) // (int(v) + int(a))"),
v: Int = Default(1),
a: Int = Default(0),
unsafe: Boolean = Default(False),
**kwargs: Any
) -> FilterNode
Concatenate audio and video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n |
Int
|
specify the number of segments (from 1 to INT_MAX) (default 2) |
Auto('len(streams) // (int(v) + int(a))')
|
v |
Int
|
specify the number of video streams (from 0 to INT_MAX) (default 1) |
Default(1)
|
a |
Int
|
specify the number of audio streams (from 0 to INT_MAX) (default 0) |
Default(0)
|
unsafe |
Boolean
|
enable unsafe mode (default false) |
Default(False)
|
Returns:
Name | Type | Description |
---|---|---|
filter_node |
FilterNode
|
the filter node |
References
convolve
¶
convolve(
_main: VideoStream,
_impulse: VideoStream,
*,
planes: Int = Default(7),
impulse: (
Int | Literal["first", "all"] | Default
) = Default("all"),
noise: Float = Default(1e-07),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Convolve first video stream with second video stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes to convolve (from 0 to 15) (default 7) |
Default(7)
|
impulse |
Int | Literal['first', 'all'] | Default
|
when to process impulses (from 0 to 1) (default all) |
Default('all')
|
noise |
Float
|
set noise (from 0 to 1) (default 1e-07) |
Default(1e-07)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
corr
¶
corr(
_main: VideoStream,
_reference: VideoStream,
*,
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Calculate the correlation between two video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
decimate
¶
decimate(
*streams: VideoStream,
cycle: Int = Default(5),
dupthresh: Double = Default(1.1),
scthresh: Double = Default(15.0),
blockx: Int = Default(32),
blocky: Int = Default(32),
ppsrc: Boolean = Default(False),
chroma: Boolean = Default(True),
mixed: Boolean = Default(False),
**kwargs: Any
) -> VideoStream
Decimate frames (post field matching filter).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cycle |
Int
|
set the number of frame from which one will be dropped (from 2 to 25) (default 5) |
Default(5)
|
dupthresh |
Double
|
set duplicate threshold (from 0 to 100) (default 1.1) |
Default(1.1)
|
scthresh |
Double
|
set scene change threshold (from 0 to 100) (default 15) |
Default(15.0)
|
blockx |
Int
|
set the size of the x-axis blocks used during metric calculations (from 4 to 512) (default 32) |
Default(32)
|
blocky |
Int
|
set the size of the y-axis blocks used during metric calculations (from 4 to 512) (default 32) |
Default(32)
|
ppsrc |
Boolean
|
mark main input as a pre-processed input and activate clean source input stream (default false) |
Default(False)
|
chroma |
Boolean
|
set whether or not chroma is considered in the metric calculations (default true) |
Default(True)
|
mixed |
Boolean
|
set whether or not the input only partially contains content to be decimated (default false) |
Default(False)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
deconvolve
¶
deconvolve(
_main: VideoStream,
_impulse: VideoStream,
*,
planes: Int = Default(7),
impulse: (
Int | Literal["first", "all"] | Default
) = Default("all"),
noise: Float = Default(1e-07),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Deconvolve first video stream with second video stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes to deconvolve (from 0 to 15) (default 7) |
Default(7)
|
impulse |
Int | Literal['first', 'all'] | Default
|
when to process impulses (from 0 to 1) (default all) |
Default('all')
|
noise |
Float
|
set noise (from 0 to 1) (default 1e-07) |
Default(1e-07)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
displace
¶
displace(
_source: VideoStream,
_xmap: VideoStream,
_ymap: VideoStream,
*,
edge: (
Int
| Literal["blank", "smear", "wrap", "mirror"]
| Default
) = Default("smear"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Displace pixels.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
edge |
Int | Literal['blank', 'smear', 'wrap', 'mirror'] | Default
|
set edge mode (from 0 to 3) (default smear) |
Default('smear')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
feedback
¶
feedback(
_default: VideoStream,
_feedin: VideoStream,
*,
x: Int = Default(0),
w: Int = Default(0),
**kwargs: Any
) -> tuple[VideoStream, VideoStream]
Apply feedback video filter.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
Int
|
set top left crop position (from 0 to INT_MAX) (default 0) |
Default(0)
|
w |
Int
|
set crop size (from 0 to INT_MAX) (default 0) |
Default(0)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
feedout |
VideoStream
|
the video stream |
References
fieldmatch
¶
fieldmatch(
*streams: VideoStream,
order: (
Int | Literal["auto", "bff", "tff"] | Default
) = Default("auto"),
mode: (
Int
| Literal[
"pc", "pc_n", "pc_u", "pc_n_ub", "pcn", "pcn_ub"
]
| Default
) = Default("pc_n"),
ppsrc: Boolean = Default(False),
field: (
Int | Literal["auto", "bottom", "top"] | Default
) = Default("auto"),
mchroma: Boolean = Default(True),
y0: Int = Default(0),
scthresh: Double = Default(12.0),
combmatch: (
Int | Literal["none", "sc", "full"] | Default
) = Default("sc"),
combdbg: (
Int | Literal["none", "pcn", "pcnub"] | Default
) = Default("none"),
cthresh: Int = Default(9),
chroma: Boolean = Default(False),
blockx: Int = Default(16),
blocky: Int = Default(16),
combpel: Int = Default(80),
**kwargs: Any
) -> VideoStream
Field matching for inverse telecine.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
order |
Int | Literal['auto', 'bff', 'tff'] | Default
|
specify the assumed field order (from -1 to 1) (default auto) |
Default('auto')
|
mode |
Int | Literal['pc', 'pc_n', 'pc_u', 'pc_n_ub', 'pcn', 'pcn_ub'] | Default
|
set the matching mode or strategy to use (from 0 to 5) (default pc_n) |
Default('pc_n')
|
ppsrc |
Boolean
|
mark main input as a pre-processed input and activate clean source input stream (default false) |
Default(False)
|
field |
Int | Literal['auto', 'bottom', 'top'] | Default
|
set the field to match from (from -1 to 1) (default auto) |
Default('auto')
|
mchroma |
Boolean
|
set whether or not chroma is included during the match comparisons (default true) |
Default(True)
|
y0 |
Int
|
define an exclusion band which excludes the lines between y0 and y1 from the field matching decision (from 0 to INT_MAX) (default 0) |
Default(0)
|
scthresh |
Double
|
set scene change detection threshold (from 0 to 100) (default 12) |
Default(12.0)
|
combmatch |
Int | Literal['none', 'sc', 'full'] | Default
|
set combmatching mode (from 0 to 2) (default sc) |
Default('sc')
|
combdbg |
Int | Literal['none', 'pcn', 'pcnub'] | Default
|
enable comb debug (from 0 to 2) (default none) |
Default('none')
|
cthresh |
Int
|
set the area combing threshold used for combed frame detection (from -1 to 255) (default 9) |
Default(9)
|
chroma |
Boolean
|
set whether or not chroma is considered in the combed frame decision (default false) |
Default(False)
|
blockx |
Int
|
set the x-axis size of the window used during combed frame detection (from 4 to 512) (default 16) |
Default(16)
|
blocky |
Int
|
set the y-axis size of the window used during combed frame detection (from 4 to 512) (default 16) |
Default(16)
|
combpel |
Int
|
set the number of combed pixels inside any of the blocky by blockx size blocks on the frame for the frame to be detected as combed (from 0 to INT_MAX) (default 80) |
Default(80)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
framepack
¶
framepack(
_left: VideoStream,
_right: VideoStream,
*,
format: (
Int
| Literal[
"sbs", "tab", "frameseq", "lines", "columns"
]
| Default
) = Default("sbs"),
**kwargs: Any
) -> VideoStream
Generate a frame packed stereoscopic video.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
format |
Int | Literal['sbs', 'tab', 'frameseq', 'lines', 'columns'] | Default
|
Frame pack output format (from 0 to INT_MAX) (default sbs) |
Default('sbs')
|
Returns:
Name | Type | Description |
---|---|---|
packed |
VideoStream
|
the video stream |
References
freezeframes
¶
freezeframes(
_source: VideoStream,
_replace: VideoStream,
*,
first: Int64 = Default(0),
last: Int64 = Default(0),
replace: Int64 = Default(0),
**kwargs: Any
) -> VideoStream
Freeze video frames.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
first |
Int64
|
set first frame to freeze (from 0 to I64_MAX) (default 0) |
Default(0)
|
last |
Int64
|
set last frame to freeze (from 0 to I64_MAX) (default 0) |
Default(0)
|
replace |
Int64
|
set frame to replace (from 0 to I64_MAX) (default 0) |
Default(0)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
guided
¶
guided(
*streams: VideoStream,
radius: Int = Default(3),
eps: Float = Default(0.01),
mode: (
Int | Literal["basic", "fast"] | Default
) = Default("basic"),
sub: Int = Default(4),
guidance: (
Int | Literal["off", "on"] | Default
) = Default("off"),
planes: Int = Default(1),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Apply Guided filter.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
radius |
Int
|
set the box radius (from 1 to 20) (default 3) |
Default(3)
|
eps |
Float
|
set the regularization parameter (with square) (from 0 to 1) (default 0.01) |
Default(0.01)
|
mode |
Int | Literal['basic', 'fast'] | Default
|
set filtering mode (0: basic mode; 1: fast mode) (from 0 to 1) (default basic) |
Default('basic')
|
sub |
Int
|
subsampling ratio for fast mode (from 2 to 64) (default 4) |
Default(4)
|
guidance |
Int | Literal['off', 'on'] | Default
|
set guidance mode (0: off mode; 1: on mode) (from 0 to 1) (default off) |
Default('off')
|
planes |
Int
|
set planes to filter (from 0 to 15) (default 1) |
Default(1)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
haldclut
¶
haldclut(
_main: VideoStream,
_clut: VideoStream,
*,
clut: Int | Literal["first", "all"] | Default = Default(
"all"
),
interp: (
Int
| Literal[
"nearest",
"trilinear",
"tetrahedral",
"pyramid",
"prism",
]
| Default
) = Default("tetrahedral"),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Adjust colors using a Hald CLUT.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
clut |
Int | Literal['first', 'all'] | Default
|
when to process CLUT (from 0 to 1) (default all) |
Default('all')
|
interp |
Int | Literal['nearest', 'trilinear', 'tetrahedral', 'pyramid', 'prism'] | Default
|
select interpolation mode (from 0 to 4) (default tetrahedral) |
Default('tetrahedral')
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
headphone
¶
headphone(
*streams: AudioStream,
map: String = Default(None),
gain: Float = Default(0.0),
lfe: Float = Default(0.0),
type: Int | Literal["time", "freq"] | Default = Default(
"freq"
),
size: Int = Default(1024),
hrir: (
Int | Literal["stereo", "multich"] | Default
) = Default("stereo"),
**kwargs: Any
) -> AudioStream
Apply headphone binaural spatialization with HRTFs in additional streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
map |
String
|
set channels convolution mappings |
Default(None)
|
gain |
Float
|
set gain in dB (from -20 to 40) (default 0) |
Default(0.0)
|
lfe |
Float
|
set lfe gain in dB (from -20 to 40) (default 0) |
Default(0.0)
|
type |
Int | Literal['time', 'freq'] | Default
|
set processing (from 0 to 1) (default freq) |
Default('freq')
|
size |
Int
|
set frame size (from 1024 to 96000) (default 1024) |
Default(1024)
|
hrir |
Int | Literal['stereo', 'multich'] | Default
|
set hrir format (from 0 to 1) (default stereo) |
Default('stereo')
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
hstack
¶
hstack(
*streams: VideoStream,
inputs: Int = Auto("len(streams)"),
shortest: Boolean = Default(False),
**kwargs: Any
) -> VideoStream
Stack video inputs horizontally.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
set number of inputs (from 2 to INT_MAX) (default 2) |
Auto('len(streams)')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
hysteresis
¶
hysteresis(
_base: VideoStream,
_alt: VideoStream,
*,
planes: Int = Default(15),
threshold: Int = Default(0),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Grow first stream into second stream by connecting components.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
threshold |
Int
|
set threshold (from 0 to 65535) (default 0) |
Default(0)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
identity
¶
identity(
_main: VideoStream,
_reference: VideoStream,
*,
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Calculate the Identity between two video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
interleave
¶
interleave(
*streams: VideoStream,
nb_inputs: Int = Auto("len(streams)"),
duration: (
Int
| Literal["longest", "shortest", "first"]
| Default
) = Default("longest"),
**kwargs: Any
) -> VideoStream
Temporally interleave video inputs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
nb_inputs |
Int
|
set number of inputs (from 1 to INT_MAX) (default 2) |
Auto('len(streams)')
|
duration |
Int | Literal['longest', 'shortest', 'first'] | Default
|
how to determine the end-of-stream (from 0 to 2) (default longest) |
Default('longest')
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
join
¶
join(
*streams: AudioStream,
inputs: Int = Auto("len(streams)"),
channel_layout: String = Default("stereo"),
map: String = Default(None),
**kwargs: Any
) -> AudioStream
Join multiple audio streams into multi-channel output.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
Number of input streams. (from 1 to INT_MAX) (default 2) |
Auto('len(streams)')
|
channel_layout |
String
|
Channel layout of the output stream. (default "stereo") |
Default('stereo')
|
map |
String
|
A comma-separated list of channels maps in the format 'input_stream.input_channel-output_channel. |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
libvmaf
¶
libvmaf(
_main: VideoStream,
_reference: VideoStream,
*,
model_path: String = Default(None),
log_path: String = Default(None),
log_fmt: String = Default("xml"),
enable_transform: Boolean = Default(False),
psnr: Boolean = Default(False),
ssim: Boolean = Default(False),
ms_ssim: Boolean = Default(False),
pool: String = Default(None),
n_threads: Int = Default(0),
n_subsample: Int = Default(1),
enable_conf_interval: Boolean = Default(False),
model: String = Default("version=vmaf_v0.6.1"),
feature: String = Default(None),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
**kwargs: Any
) -> VideoStream
Calculate the VMAF between two video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_path |
String
|
use model='path=...'. |
Default(None)
|
log_path |
String
|
Set the file path to be used to write log. |
Default(None)
|
log_fmt |
String
|
Set the format of the log (csv, json, xml, or sub). (default "xml") |
Default('xml')
|
enable_transform |
Boolean
|
use model='enable_transform=true'. (default false) |
Default(False)
|
psnr |
Boolean
|
use feature='name=psnr'. (default false) |
Default(False)
|
ssim |
Boolean
|
use feature='name=float_ssim'. (default false) |
Default(False)
|
ms_ssim |
Boolean
|
use feature='name=float_ms_ssim'. (default false) |
Default(False)
|
pool |
String
|
Set the pool method to be used for computing vmaf. |
Default(None)
|
n_threads |
Int
|
Set number of threads to be used when computing vmaf. (from 0 to UINT32_MAX) (default 0) |
Default(0)
|
n_subsample |
Int
|
Set interval for frame subsampling used when computing vmaf. (from 1 to UINT32_MAX) (default 1) |
Default(1)
|
enable_conf_interval |
Boolean
|
model='enable_conf_interval=true'. (default false) |
Default(False)
|
model |
String
|
Set the model to be used for computing vmaf. (default "version=vmaf_v0.6.1") |
Default('version=vmaf_v0.6.1')
|
feature |
String
|
Set the feature to be used for computing vmaf. |
Default(None)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
limitdiff
¶
limitdiff(
*streams: VideoStream,
threshold: Float = Default(0.00392157),
elasticity: Float = Default(2.0),
reference: Boolean = Default(False),
planes: Int = Default(15),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Apply filtering with limiting difference.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
threshold |
Float
|
set the threshold (from 0 to 1) (default 0.00392157) |
Default(0.00392157)
|
elasticity |
Float
|
set the elasticity (from 0 to 10) (default 2) |
Default(2.0)
|
reference |
Boolean
|
enable reference stream (default false) |
Default(False)
|
planes |
Int
|
set the planes to filter (from 0 to 15) (default 15) |
Default(15)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
lut2
¶
lut2(
_srcx: VideoStream,
_srcy: VideoStream,
*,
c0: String = Default("x"),
c1: String = Default("x"),
c2: String = Default("x"),
c3: String = Default("x"),
d: Int = Default(0),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Compute and apply a lookup table from two video inputs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
c0 |
String
|
set component #0 expression (default "x") |
Default('x')
|
c1 |
String
|
set component #1 expression (default "x") |
Default('x')
|
c2 |
String
|
set component #2 expression (default "x") |
Default('x')
|
c3 |
String
|
set component #3 expression (default "x") |
Default('x')
|
d |
Int
|
set output depth (from 0 to 16) (default 0) |
Default(0)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
maskedclamp
¶
maskedclamp(
_base: VideoStream,
_dark: VideoStream,
_bright: VideoStream,
*,
undershoot: Int = Default(0),
overshoot: Int = Default(0),
planes: Int = Default(15),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Clamp first stream with second stream and third stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
undershoot |
Int
|
set undershoot (from 0 to 65535) (default 0) |
Default(0)
|
overshoot |
Int
|
set overshoot (from 0 to 65535) (default 0) |
Default(0)
|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
maskedmax
¶
maskedmax(
_source: VideoStream,
_filter1: VideoStream,
_filter2: VideoStream,
*,
planes: Int = Default(15),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Apply filtering with maximum difference of two streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
maskedmerge
¶
maskedmerge(
_base: VideoStream,
_overlay: VideoStream,
_mask: VideoStream,
*,
planes: Int = Default(15),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Merge first stream with second stream using third stream as mask.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
maskedmin
¶
maskedmin(
_source: VideoStream,
_filter1: VideoStream,
_filter2: VideoStream,
*,
planes: Int = Default(15),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Apply filtering with minimum difference of two streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
maskedthreshold
¶
maskedthreshold(
_source: VideoStream,
_reference: VideoStream,
*,
threshold: Int = Default(1),
planes: Int = Default(15),
mode: Int | Literal["abs", "diff"] | Default = Default(
"abs"
),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Pick pixels comparing absolute difference of two streams with threshold.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
threshold |
Int
|
set threshold (from 0 to 65535) (default 1) |
Default(1)
|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
mode |
Int | Literal['abs', 'diff'] | Default
|
set mode (from 0 to 1) (default abs) |
Default('abs')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
mergeplanes
¶
mergeplanes(
*streams: VideoStream,
mapping: Int = Default(-1),
format: Pix_fmt = Default("yuva444p"),
map0s: Int = Default(0),
map0p: Int = Default(0),
map1s: Int = Default(0),
map1p: Int = Default(0),
map2s: Int = Default(0),
map2p: Int = Default(0),
map3s: Int = Default(0),
map3p: Int = Default(0),
**kwargs: Any
) -> VideoStream
Merge planes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
mapping |
Int
|
set input to output plane mapping (from -1 to 8.58993e+08) (default -1) |
Default(-1)
|
format |
Pix_fmt
|
set output pixel format (default yuva444p) |
Default('yuva444p')
|
map0s |
Int
|
set 1st input to output stream mapping (from 0 to 3) (default 0) |
Default(0)
|
map0p |
Int
|
set 1st input to output plane mapping (from 0 to 3) (default 0) |
Default(0)
|
map1s |
Int
|
set 2nd input to output stream mapping (from 0 to 3) (default 0) |
Default(0)
|
map1p |
Int
|
set 2nd input to output plane mapping (from 0 to 3) (default 0) |
Default(0)
|
map2s |
Int
|
set 3rd input to output stream mapping (from 0 to 3) (default 0) |
Default(0)
|
map2p |
Int
|
set 3rd input to output plane mapping (from 0 to 3) (default 0) |
Default(0)
|
map3s |
Int
|
set 4th input to output stream mapping (from 0 to 3) (default 0) |
Default(0)
|
map3p |
Int
|
set 4th input to output plane mapping (from 0 to 3) (default 0) |
Default(0)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
midequalizer
¶
midequalizer(
_in0: VideoStream,
_in1: VideoStream,
*,
planes: Int = Default(15),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Apply Midway Equalization.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
mix
¶
mix(
*streams: VideoStream,
inputs: Int = Auto("len(streams)"),
weights: String = Default("1 1"),
scale: Float = Default(0.0),
planes: Flags = Default("F"),
duration: (
Int
| Literal["longest", "shortest", "first"]
| Default
) = Default("longest"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Mix video inputs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
set number of inputs (from 2 to 32767) (default 2) |
Auto('len(streams)')
|
weights |
String
|
set weight for each input (default "1 1") |
Default('1 1')
|
scale |
Float
|
set scale (from 0 to 32767) (default 0) |
Default(0.0)
|
planes |
Flags
|
set what planes to filter (default F) |
Default('F')
|
duration |
Int | Literal['longest', 'shortest', 'first'] | Default
|
how to determine end of stream (from 0 to 2) (default longest) |
Default('longest')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
morpho
¶
morpho(
_default: VideoStream,
_structure: VideoStream,
*,
mode: (
Int
| Literal[
"erode",
"dilate",
"open",
"close",
"gradient",
"tophat",
"blackhat",
]
| Default
) = Default("erode"),
planes: Int = Default(7),
structure: (
Int | Literal["first", "all"] | Default
) = Default("all"),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Apply Morphological filter.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
mode |
Int | Literal['erode', 'dilate', 'open', 'close', 'gradient', 'tophat', 'blackhat'] | Default
|
set morphological transform (from 0 to 6) (default erode) |
Default('erode')
|
planes |
Int
|
set planes to filter (from 0 to 15) (default 7) |
Default(7)
|
structure |
Int | Literal['first', 'all'] | Default
|
when to process structures (from 0 to 1) (default all) |
Default('all')
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
msad
¶
msad(
_main: VideoStream,
_reference: VideoStream,
*,
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Calculate the MSAD between two video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
multiply
¶
multiply(
_source: VideoStream,
_factor: VideoStream,
*,
scale: Float = Default(1.0),
offset: Float = Default(0.5),
planes: Flags = Default("F"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Multiply first video stream with second video stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
scale |
Float
|
set scale (from 0 to 9) (default 1) |
Default(1.0)
|
offset |
Float
|
set offset (from -1 to 1) (default 0.5) |
Default(0.5)
|
planes |
Flags
|
set planes (default F) |
Default('F')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
overlay
¶
overlay(
_main: VideoStream,
_overlay: VideoStream,
*,
x: String = Default("0"),
y: String = Default("0"),
eof_action: (
Int
| Literal[
"repeat",
"endall",
"pass",
"repeat",
"endall",
"pass",
]
| Default
) = Default("repeat"),
eval: (
Int | Literal["init", "frame"] | Default
) = Default("frame"),
shortest: Boolean = Default(False),
format: (
Int
| Literal[
"yuv420",
"yuv420p10",
"yuv422",
"yuv422p10",
"yuv444",
"rgb",
"gbrp",
"auto",
]
| Default
) = Default("yuv420"),
repeatlast: Boolean = Default(True),
alpha: (
Int | Literal["straight", "premultiplied"] | Default
) = Default("straight"),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Overlay a video source on top of the input.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
String
|
set the x expression (default "0") |
Default('0')
|
y |
String
|
set the y expression (default "0") |
Default('0')
|
eof_action |
Int | Literal['repeat', 'endall', 'pass', 'repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
eval |
Int | Literal['init', 'frame'] | Default
|
specify when to evaluate expressions (from 0 to 1) (default frame) |
Default('frame')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
format |
Int | Literal['yuv420', 'yuv420p10', 'yuv422', 'yuv422p10', 'yuv444', 'rgb', 'gbrp', 'auto'] | Default
|
set output format (from 0 to 7) (default yuv420) |
Default('yuv420')
|
repeatlast |
Boolean
|
repeat overlay of the last overlay frame (default true) |
Default(True)
|
alpha |
Int | Literal['straight', 'premultiplied'] | Default
|
alpha format (from 0 to 1) (default straight) |
Default('straight')
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
paletteuse
¶
paletteuse(
_default: VideoStream,
_palette: VideoStream,
*,
dither: (
Int
| Literal[
"bayer",
"heckbert",
"floyd_steinberg",
"sierra2",
"sierra2_4a",
"sierra3",
"burkes",
"atkinson",
]
| Default
) = Default("sierra2_4a"),
bayer_scale: Int = Default(2),
diff_mode: (
Int | Literal["rectangle"] | Default
) = Default(0),
new: Boolean = Default(False),
alpha_threshold: Int = Default(128),
debug_kdtree: String = Default(None),
**kwargs: Any
) -> VideoStream
Use a palette to downsample an input video stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dither |
Int | Literal['bayer', 'heckbert', 'floyd_steinberg', 'sierra2', 'sierra2_4a', 'sierra3', 'burkes', 'atkinson'] | Default
|
select dithering mode (from 0 to 8) (default sierra2_4a) |
Default('sierra2_4a')
|
bayer_scale |
Int
|
set scale for bayer dithering (from 0 to 5) (default 2) |
Default(2)
|
diff_mode |
Int | Literal['rectangle'] | Default
|
set frame difference mode (from 0 to 1) (default 0) |
Default(0)
|
new |
Boolean
|
take new palette for each output frame (default false) |
Default(False)
|
alpha_threshold |
Int
|
set the alpha threshold for transparency (from 0 to 255) (default 128) |
Default(128)
|
debug_kdtree |
String
|
save Graphviz graph of the kdtree in specified file |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
premultiply
¶
premultiply(
*streams: VideoStream,
planes: Int = Default(15),
inplace: Boolean = Default(False),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
PreMultiply first stream with first plane of second stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
inplace |
Boolean
|
enable inplace mode (default false) |
Default(False)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
psnr
¶
psnr(
_main: VideoStream,
_reference: VideoStream,
*,
stats_file: String = Default(None),
stats_version: Int = Default(1),
output_max: Boolean = Default(False),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Calculate the PSNR between two video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stats_file |
String
|
Set file where to store per-frame difference information |
Default(None)
|
stats_version |
Int
|
Set the format version for the stats file. (from 1 to 2) (default 1) |
Default(1)
|
output_max |
Boolean
|
Add raw stats (max values) to the output log. (default false) |
Default(False)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
remap
¶
remap(
_source: VideoStream,
_xmap: VideoStream,
_ymap: VideoStream,
*,
format: (
Int | Literal["color", "gray"] | Default
) = Default("color"),
fill: Color = Default("black"),
**kwargs: Any
) -> VideoStream
Remap pixels.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
format |
Int | Literal['color', 'gray'] | Default
|
set output format (from 0 to 1) (default color) |
Default('color')
|
fill |
Color
|
set the color of the unmapped pixels (default "black") |
Default('black')
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
scale2ref
¶
scale2ref(
_default: VideoStream,
_ref: VideoStream,
*,
w: String = Default(None),
h: String = Default(None),
flags: String = Default(""),
interl: Boolean = Default(False),
in_color_matrix: (
String
| Literal[
"auto",
"bt601",
"bt470",
"smpte170m",
"bt709",
"fcc",
"smpte240m",
"bt2020",
]
| Default
) = Default("auto"),
out_color_matrix: (
String
| Literal[
"auto",
"bt601",
"bt470",
"smpte170m",
"bt709",
"fcc",
"smpte240m",
"bt2020",
]
| Default
) = Default(None),
in_range: (
Int
| Literal[
"auto",
"unknown",
"full",
"limited",
"jpeg",
"mpeg",
"tv",
"pc",
]
| Default
) = Default("auto"),
out_range: (
Int
| Literal[
"auto",
"unknown",
"full",
"limited",
"jpeg",
"mpeg",
"tv",
"pc",
]
| Default
) = Default("auto"),
in_v_chr_pos: Int = Default(-513),
in_h_chr_pos: Int = Default(-513),
out_v_chr_pos: Int = Default(-513),
out_h_chr_pos: Int = Default(-513),
force_original_aspect_ratio: (
Int
| Literal["disable", "decrease", "increase"]
| Default
) = Default("disable"),
force_divisible_by: Int = Default(1),
param0: Double = Default("DBL_MAX"),
param1: Double = Default("DBL_MAX"),
eval: (
Int | Literal["init", "frame"] | Default
) = Default("init"),
**kwargs: Any
) -> tuple[VideoStream, VideoStream]
Scale the input video size and/or convert the image format to the given reference.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
w |
String
|
Output video width |
Default(None)
|
h |
String
|
Output video height |
Default(None)
|
flags |
String
|
Flags to pass to libswscale (default "") |
Default('')
|
interl |
Boolean
|
set interlacing (default false) |
Default(False)
|
in_color_matrix |
String | Literal['auto', 'bt601', 'bt470', 'smpte170m', 'bt709', 'fcc', 'smpte240m', 'bt2020'] | Default
|
set input YCbCr type (default "auto") |
Default('auto')
|
out_color_matrix |
String | Literal['auto', 'bt601', 'bt470', 'smpte170m', 'bt709', 'fcc', 'smpte240m', 'bt2020'] | Default
|
set output YCbCr type |
Default(None)
|
in_range |
Int | Literal['auto', 'unknown', 'full', 'limited', 'jpeg', 'mpeg', 'tv', 'pc'] | Default
|
set input color range (from 0 to 2) (default auto) |
Default('auto')
|
out_range |
Int | Literal['auto', 'unknown', 'full', 'limited', 'jpeg', 'mpeg', 'tv', 'pc'] | Default
|
set output color range (from 0 to 2) (default auto) |
Default('auto')
|
in_v_chr_pos |
Int
|
input vertical chroma position in luma grid/256 (from -513 to 512) (default -513) |
Default(-513)
|
in_h_chr_pos |
Int
|
input horizontal chroma position in luma grid/256 (from -513 to 512) (default -513) |
Default(-513)
|
out_v_chr_pos |
Int
|
output vertical chroma position in luma grid/256 (from -513 to 512) (default -513) |
Default(-513)
|
out_h_chr_pos |
Int
|
output horizontal chroma position in luma grid/256 (from -513 to 512) (default -513) |
Default(-513)
|
force_original_aspect_ratio |
Int | Literal['disable', 'decrease', 'increase'] | Default
|
decrease or increase w/h if necessary to keep the original AR (from 0 to 2) (default disable) |
Default('disable')
|
force_divisible_by |
Int
|
enforce that the output resolution is divisible by a defined integer when force_original_aspect_ratio is used (from 1 to 256) (default 1) |
Default(1)
|
param0 |
Double
|
Scaler param 0 (from -DBL_MAX to DBL_MAX) (default DBL_MAX) |
Default('DBL_MAX')
|
param1 |
Double
|
Scaler param 1 (from -DBL_MAX to DBL_MAX) (default DBL_MAX) |
Default('DBL_MAX')
|
eval |
Int | Literal['init', 'frame'] | Default
|
specify when to evaluate expressions (from 0 to 1) (default init) |
Default('init')
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
ref |
VideoStream
|
the video stream |
References
sidechaincompress
¶
sidechaincompress(
_main: AudioStream,
_sidechain: AudioStream,
*,
level_in: Double = Default(1.0),
mode: (
Int | Literal["downward", "upward"] | Default
) = Default("downward"),
threshold: Double = Default(0.125),
ratio: Double = Default(2.0),
attack: Double = Default(20.0),
release: Double = Default(250.0),
makeup: Double = Default(1.0),
knee: Double = Default(2.82843),
link: (
Int | Literal["average", "maximum"] | Default
) = Default("average"),
detection: (
Int | Literal["peak", "rms"] | Default
) = Default("rms"),
level_sc: Double = Default(1.0),
mix: Double = Default(1.0),
**kwargs: Any
) -> AudioStream
Sidechain compressor.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
level_in |
Double
|
set input gain (from 0.015625 to 64) (default 1) |
Default(1.0)
|
mode |
Int | Literal['downward', 'upward'] | Default
|
set mode (from 0 to 1) (default downward) |
Default('downward')
|
threshold |
Double
|
set threshold (from 0.000976563 to 1) (default 0.125) |
Default(0.125)
|
ratio |
Double
|
set ratio (from 1 to 20) (default 2) |
Default(2.0)
|
attack |
Double
|
set attack (from 0.01 to 2000) (default 20) |
Default(20.0)
|
release |
Double
|
set release (from 0.01 to 9000) (default 250) |
Default(250.0)
|
makeup |
Double
|
set make up gain (from 1 to 64) (default 1) |
Default(1.0)
|
knee |
Double
|
set knee (from 1 to 8) (default 2.82843) |
Default(2.82843)
|
link |
Int | Literal['average', 'maximum'] | Default
|
set link type (from 0 to 1) (default average) |
Default('average')
|
detection |
Int | Literal['peak', 'rms'] | Default
|
set detection (from 0 to 1) (default rms) |
Default('rms')
|
level_sc |
Double
|
set sidechain gain (from 0.015625 to 64) (default 1) |
Default(1.0)
|
mix |
Double
|
set mix (from 0 to 1) (default 1) |
Default(1.0)
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
sidechaingate
¶
sidechaingate(
_main: AudioStream,
_sidechain: AudioStream,
*,
level_in: Double = Default(1.0),
mode: (
Int | Literal["downward", "upward"] | Default
) = Default("downward"),
range: Double = Default(0.06125),
threshold: Double = Default(0.125),
ratio: Double = Default(2.0),
attack: Double = Default(20.0),
release: Double = Default(250.0),
makeup: Double = Default(1.0),
knee: Double = Default(2.82843),
detection: (
Int | Literal["peak", "rms"] | Default
) = Default("rms"),
link: (
Int | Literal["average", "maximum"] | Default
) = Default("average"),
level_sc: Double = Default(1.0),
enable: String = Default(None),
**kwargs: Any
) -> AudioStream
Audio sidechain gate.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
level_in |
Double
|
set input level (from 0.015625 to 64) (default 1) |
Default(1.0)
|
mode |
Int | Literal['downward', 'upward'] | Default
|
set mode (from 0 to 1) (default downward) |
Default('downward')
|
range |
Double
|
set max gain reduction (from 0 to 1) (default 0.06125) |
Default(0.06125)
|
threshold |
Double
|
set threshold (from 0 to 1) (default 0.125) |
Default(0.125)
|
ratio |
Double
|
set ratio (from 1 to 9000) (default 2) |
Default(2.0)
|
attack |
Double
|
set attack (from 0.01 to 9000) (default 20) |
Default(20.0)
|
release |
Double
|
set release (from 0.01 to 9000) (default 250) |
Default(250.0)
|
makeup |
Double
|
set makeup gain (from 1 to 64) (default 1) |
Default(1.0)
|
knee |
Double
|
set knee (from 1 to 8) (default 2.82843) |
Default(2.82843)
|
detection |
Int | Literal['peak', 'rms'] | Default
|
set detection (from 0 to 1) (default rms) |
Default('rms')
|
link |
Int | Literal['average', 'maximum'] | Default
|
set link (from 0 to 1) (default average) |
Default('average')
|
level_sc |
Double
|
set sidechain gain (from 0.015625 to 64) (default 1) |
Default(1.0)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
signature
¶
signature(
*streams: VideoStream,
detectmode: (
Int | Literal["off", "full", "fast"] | Default
) = Default("off"),
nb_inputs: Int = Auto("len(streams)"),
filename: String = Default(""),
format: (
Int | Literal["binary", "xml"] | Default
) = Default("binary"),
th_d: Int = Default(9000),
th_dc: Int = Default(60000),
th_xh: Int = Default(116),
th_di: Int = Default(0),
th_it: Double = Default(0.5),
**kwargs: Any
) -> VideoStream
Calculate the MPEG-7 video signature
Parameters:
Name | Type | Description | Default |
---|---|---|---|
detectmode |
Int | Literal['off', 'full', 'fast'] | Default
|
set the detectmode (from 0 to 2) (default off) |
Default('off')
|
nb_inputs |
Int
|
number of inputs (from 1 to INT_MAX) (default 1) |
Auto('len(streams)')
|
filename |
String
|
filename for output files (default "") |
Default('')
|
format |
Int | Literal['binary', 'xml'] | Default
|
set output format (from 0 to 1) (default binary) |
Default('binary')
|
th_d |
Int
|
threshold to detect one word as similar (from 1 to INT_MAX) (default 9000) |
Default(9000)
|
th_dc |
Int
|
threshold to detect all words as similar (from 1 to INT_MAX) (default 60000) |
Default(60000)
|
th_xh |
Int
|
threshold to detect frames as similar (from 1 to INT_MAX) (default 116) |
Default(116)
|
th_di |
Int
|
minimum length of matching sequence in frames (from 0 to INT_MAX) (default 0) |
Default(0)
|
th_it |
Double
|
threshold for relation of good to all frames (from 0 to 1) (default 0.5) |
Default(0.5)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
spectrumsynth
¶
spectrumsynth(
_magnitude: VideoStream,
_phase: VideoStream,
*,
sample_rate: Int = Default(44100),
channels: Int = Default(1),
scale: Int | Literal["lin", "log"] | Default = Default(
"log"
),
slide: (
Int
| Literal[
"replace", "scroll", "fullframe", "rscroll"
]
| Default
) = Default("fullframe"),
win_func: (
Int
| Literal[
"rect",
"bartlett",
"hann",
"hanning",
"hamming",
"blackman",
"welch",
"flattop",
"bharris",
"bnuttall",
"bhann",
"sine",
"nuttall",
"lanczos",
"gauss",
"tukey",
"dolph",
"cauchy",
"parzen",
"poisson",
"bohman",
"kaiser",
]
| Default
) = Default("rect"),
overlap: Float = Default(1.0),
orientation: (
Int | Literal["vertical", "horizontal"] | Default
) = Default("vertical"),
**kwargs: Any
) -> AudioStream
Convert input spectrum videos to audio output.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
sample_rate |
Int
|
set sample rate (from 15 to INT_MAX) (default 44100) |
Default(44100)
|
channels |
Int
|
set channels (from 1 to 8) (default 1) |
Default(1)
|
scale |
Int | Literal['lin', 'log'] | Default
|
set input amplitude scale (from 0 to 1) (default log) |
Default('log')
|
slide |
Int | Literal['replace', 'scroll', 'fullframe', 'rscroll'] | Default
|
set input sliding mode (from 0 to 3) (default fullframe) |
Default('fullframe')
|
win_func |
Int | Literal['rect', 'bartlett', 'hann', 'hanning', 'hamming', 'blackman', 'welch', 'flattop', 'bharris', 'bnuttall', 'bhann', 'sine', 'nuttall', 'lanczos', 'gauss', 'tukey', 'dolph', 'cauchy', 'parzen', 'poisson', 'bohman', 'kaiser'] | Default
|
set window function (from 0 to 20) (default rect) |
Default('rect')
|
overlap |
Float
|
set window overlap (from 0 to 1) (default 1) |
Default(1.0)
|
orientation |
Int | Literal['vertical', 'horizontal'] | Default
|
set orientation (from 0 to 1) (default vertical) |
Default('vertical')
|
Returns:
Name | Type | Description |
---|---|---|
default |
AudioStream
|
the audio stream |
References
ssim
¶
ssim(
_main: VideoStream,
_reference: VideoStream,
*,
stats_file: String = Default(None),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Calculate the SSIM between two video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stats_file |
String
|
Set file where to store per-frame difference information |
Default(None)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
streamselect
¶
streamselect(
*streams: VideoStream,
inputs: Int = Auto("len(streams)"),
map: String = Default(None),
**kwargs: Any
) -> FilterNode
Select video streams
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
number of input streams (from 2 to INT_MAX) (default 2) |
Auto('len(streams)')
|
map |
String
|
input indexes to remap to outputs |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
filter_node |
FilterNode
|
the filter node |
References
threshold
¶
threshold(
_default: VideoStream,
_threshold: VideoStream,
_min: VideoStream,
_max: VideoStream,
*,
planes: Int = Default(15),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Threshold first video stream using other video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes to filter (from 0 to 15) (default 15) |
Default(15)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
unpremultiply
¶
unpremultiply(
*streams: VideoStream,
planes: Int = Default(15),
inplace: Boolean = Default(False),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
UnPreMultiply first stream with first plane of second stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes (from 0 to 15) (default 15) |
Default(15)
|
inplace |
Boolean
|
enable inplace mode (default false) |
Default(False)
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
varblur
¶
varblur(
_default: VideoStream,
_radius: VideoStream,
*,
min_r: Int = Default(0),
max_r: Int = Default(8),
planes: Int = Default(15),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Apply Variable Blur filter.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
min_r |
Int
|
set min blur radius (from 0 to 254) (default 0) |
Default(0)
|
max_r |
Int
|
set max blur radius (from 1 to 255) (default 8) |
Default(8)
|
planes |
Int
|
set planes to filter (from 0 to 15) (default 15) |
Default(15)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
vif
¶
vif(
_main: VideoStream,
_reference: VideoStream,
*,
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Calculate the VIF between two video streams.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
vstack
¶
vstack(
*streams: VideoStream,
inputs: Int = Auto("len(streams)"),
shortest: Boolean = Default(False),
**kwargs: Any
) -> VideoStream
Stack video inputs vertically.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
set number of inputs (from 2 to INT_MAX) (default 2) |
Auto('len(streams)')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
xcorrelate
¶
xcorrelate(
_primary: VideoStream,
_secondary: VideoStream,
*,
planes: Int = Default(7),
secondary: (
Int | Literal["first", "all"] | Default
) = Default("all"),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Cross-correlate first video stream with second video stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
planes |
Int
|
set planes to cross-correlate (from 0 to 15) (default 7) |
Default(7)
|
secondary |
Int | Literal['first', 'all'] | Default
|
when to process secondary frame (from 0 to 1) (default all) |
Default('all')
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
xfade
¶
xfade(
_main: VideoStream,
_xfade: VideoStream,
*,
transition: (
Int
| Literal[
"custom",
"fade",
"wipeleft",
"wiperight",
"wipeup",
"wipedown",
"slideleft",
"slideright",
"slideup",
"slidedown",
"circlecrop",
"rectcrop",
"distance",
"fadeblack",
"fadewhite",
"radial",
"smoothleft",
"smoothright",
"smoothup",
"smoothdown",
"circleopen",
"circleclose",
"vertopen",
"vertclose",
"horzopen",
"horzclose",
"dissolve",
"pixelize",
"diagtl",
"diagtr",
"diagbl",
"diagbr",
"hlslice",
"hrslice",
"vuslice",
"vdslice",
"hblur",
"fadegrays",
"wipetl",
"wipetr",
"wipebl",
"wipebr",
"squeezeh",
"squeezev",
"zoomin",
"fadefast",
"fadeslow",
]
| Default
) = Default("fade"),
duration: Duration = Default(1.0),
offset: Duration = Default(0.0),
expr: String = Default(None),
**kwargs: Any
) -> VideoStream
Cross fade one video with another video.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
transition |
Int | Literal['custom', 'fade', 'wipeleft', 'wiperight', 'wipeup', 'wipedown', 'slideleft', 'slideright', 'slideup', 'slidedown', 'circlecrop', 'rectcrop', 'distance', 'fadeblack', 'fadewhite', 'radial', 'smoothleft', 'smoothright', 'smoothup', 'smoothdown', 'circleopen', 'circleclose', 'vertopen', 'vertclose', 'horzopen', 'horzclose', 'dissolve', 'pixelize', 'diagtl', 'diagtr', 'diagbl', 'diagbr', 'hlslice', 'hrslice', 'vuslice', 'vdslice', 'hblur', 'fadegrays', 'wipetl', 'wipetr', 'wipebl', 'wipebr', 'squeezeh', 'squeezev', 'zoomin', 'fadefast', 'fadeslow'] | Default
|
set cross fade transition (from -1 to 45) (default fade) |
Default('fade')
|
duration |
Duration
|
set cross fade duration (default 1) |
Default(1.0)
|
offset |
Duration
|
set cross fade start relative to first input stream (default 0) |
Default(0.0)
|
expr |
String
|
set expression for custom transition |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
xmedian
¶
xmedian(
*streams: VideoStream,
inputs: Int = Auto("len(streams)"),
planes: Int = Default(15),
percentile: Float = Default(0.5),
eof_action: (
Int | Literal["repeat", "endall", "pass"] | Default
) = Default("repeat"),
shortest: Boolean = Default(False),
repeatlast: Boolean = Default(True),
ts_sync_mode: (
Int | Literal["default", "nearest"] | Default
) = Default("default"),
enable: String = Default(None),
**kwargs: Any
) -> VideoStream
Pick median pixels from several video inputs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
set number of inputs (from 3 to 255) (default 3) |
Auto('len(streams)')
|
planes |
Int
|
set planes to filter (from 0 to 15) (default 15) |
Default(15)
|
percentile |
Float
|
set percentile (from 0 to 1) (default 0.5) |
Default(0.5)
|
eof_action |
Int | Literal['repeat', 'endall', 'pass'] | Default
|
Action to take when encountering EOF from secondary input (from 0 to 2) (default repeat) |
Default('repeat')
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
repeatlast |
Boolean
|
extend last frame of secondary streams beyond EOF (default true) |
Default(True)
|
ts_sync_mode |
Int | Literal['default', 'nearest'] | Default
|
How strictly to sync streams based on secondary input timestamps (from 0 to 1) (default default) |
Default('default')
|
enable |
String
|
timeline editing |
Default(None)
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |
References
xstack
¶
xstack(
*streams: VideoStream,
inputs: Int = Auto("len(streams)"),
layout: String = Default(None),
grid: Image_size = Default(None),
shortest: Boolean = Default(False),
fill: String = Default("none"),
**kwargs: Any
) -> VideoStream
Stack video inputs into custom layout.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
inputs |
Int
|
set number of inputs (from 2 to INT_MAX) (default 2) |
Auto('len(streams)')
|
layout |
String
|
set custom layout |
Default(None)
|
grid |
Image_size
|
set fixed size grid layout |
Default(None)
|
shortest |
Boolean
|
force termination when the shortest input terminates (default false) |
Default(False)
|
fill |
String
|
set the color for unused pixels (default "none") |
Default('none')
|
Returns:
Name | Type | Description |
---|---|---|
default |
VideoStream
|
the video stream |