Source / FFmpeg filter

ffmpeg.filter.a3dscope

Ffmpeg filter: Convert input audio to 3d scope video output.

Type:

(?rate : string?, ?r : string?, ?size : string?, ?s : string?, ?fov : float?,
 ?roll : float?, ?pitch : float?, ?yaw : float?, ?xzoom : float?,
 ?yzoom : float?, ?zzoom : float?, ?xpos : float?, ?ypos : float?,
 ?zpos : float?, ?length : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.video

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• s (of type string?, which defaults to null): set video size. (default: hd720)
• fov (of type float?, which defaults to null): set camera FoV. (default: 90)
• roll (of type float?, which defaults to null): set camera roll. (default: 0)
• pitch (of type float?, which defaults to null): set camera pitch. (default: 0)
• yaw (of type float?, which defaults to null): set camera yaw. (default: 0)
• xzoom (of type float?, which defaults to null): set camera zoom. (default: 1)
• yzoom (of type float?, which defaults to null): set camera zoom. (default: 1)
• zzoom (of type float?, which defaults to null): set camera zoom. (default: 1)
• xpos (of type float?, which defaults to null): set camera position. (default: 0)
• ypos (of type float?, which defaults to null): set camera position. (default: 0)
• zpos (of type float?, which defaults to null): set camera position. (default: 0)
• length (of type int?, which defaults to null): set length. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.a3dscope.create

Ffmpeg filter: Convert input audio to 3d scope video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rate : string?, ?r : string?, ?size : string?, ?s : string?, ?fov : float?,
 ?roll : float?, ?pitch : float?, ?yaw : float?, ?xzoom : float?,
 ?yzoom : float?, ?zzoom : float?, ?xpos : float?, ?ypos : float?,
 ?zpos : float?, ?length : int?, ffmpeg.filter.graph) -> unit

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• s (of type string?, which defaults to null): set video size. (default: hd720)
• fov (of type float?, which defaults to null): set camera FoV. (default: 90)
• roll (of type float?, which defaults to null): set camera roll. (default: 0)
• pitch (of type float?, which defaults to null): set camera pitch. (default: 0)
• yaw (of type float?, which defaults to null): set camera yaw. (default: 0)
• xzoom (of type float?, which defaults to null): set camera zoom. (default: 1)
• yzoom (of type float?, which defaults to null): set camera zoom. (default: 1)
• zzoom (of type float?, which defaults to null): set camera zoom. (default: 1)
• xpos (of type float?, which defaults to null): set camera position. (default: 0)
• ypos (of type float?, which defaults to null): set camera position. (default: 0)
• zpos (of type float?, which defaults to null): set camera position. (default: 0)
• length (of type int?, which defaults to null): set length. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aap

Ffmpeg filter: Apply Affine Projection algorithm to first audio stream.

Type:

(?order : int?, ?projection : int?, ?mu : float?, ?delta : float?,
 ?out_mode : int?, ?precision : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• order (of type int?, which defaults to null): set the filter order. (default: 16)
• projection (of type int?, which defaults to null): set the filter projection. (default: 2)
• mu (of type float?, which defaults to null): set the filter mu. (default: 0.0001)
• delta (of type float?, which defaults to null): set the filter delta. (default: 0.001)
• out_mode (of type int?, which defaults to null): set output mode. (default: 2, possible values: 0 (i), 1 (d), 2 (o), 3 (n), 4 (e))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aap.create

Ffmpeg filter: Apply Affine Projection algorithm to first audio stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?order : int?, ?projection : int?, ?mu : float?, ?delta : float?,
 ?out_mode : int?, ?precision : int?, ffmpeg.filter.graph) -> unit

Arguments:

• order (of type int?, which defaults to null): set the filter order. (default: 16)
• projection (of type int?, which defaults to null): set the filter projection. (default: 2)
• mu (of type float?, which defaults to null): set the filter mu. (default: 0.0001)
• delta (of type float?, which defaults to null): set the filter delta. (default: 0.001)
• out_mode (of type int?, which defaults to null): set output mode. (default: 2, possible values: 0 (i), 1 (d), 2 (o), 3 (n), 4 (e))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.abench

Ffmpeg filter: Benchmark part of a filtergraph.

Type:

(?action : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• action (of type int?, which defaults to null): set action. (default: 0, possible values: 0 (start), 1 (stop))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.abench.create

Ffmpeg filter: Benchmark part of a filtergraph. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?action : int?, ffmpeg.filter.graph) -> unit

Arguments:

• action (of type int?, which defaults to null): set action. (default: 0, possible values: 0 (start), 1 (stop))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.abitscope

Ffmpeg filter: Convert input audio to audio bit scope video output.

Type:

(?rate : string?, ?r : string?, ?size : string?, ?s : string?,
 ?colors : string?, ?mode : int?, ?m : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.video

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: 1024x256)
• s (of type string?, which defaults to null): set video size. (default: 1024x256)
• colors (of type string?, which defaults to null): set channels colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• mode (of type int?, which defaults to null): set output mode. (default: 0, possible values: 0 (bars), 1 (trace))
• m (of type int?, which defaults to null): set output mode. (default: 0, possible values: 0 (bars), 1 (trace))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.abitscope.create

Ffmpeg filter: Convert input audio to audio bit scope video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rate : string?, ?r : string?, ?size : string?, ?s : string?,
 ?colors : string?, ?mode : int?, ?m : int?, ffmpeg.filter.graph) -> unit

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: 1024x256)
• s (of type string?, which defaults to null): set video size. (default: 1024x256)
• colors (of type string?, which defaults to null): set channels colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• mode (of type int?, which defaults to null): set output mode. (default: 0, possible values: 0 (bars), 1 (trace))
• m (of type int?, which defaults to null): set output mode. (default: 0, possible values: 0 (bars), 1 (trace))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.acompressor

Ffmpeg filter: Audio compressor.

Type:

(?level_in : float?, ?mode : int?, ?threshold : float?, ?ratio : float?,
 ?attack : float?, ?release : float?, ?makeup : float?, ?knee : float?,
 ?link : int?, ?detection : int?, ?level_sc : float?, ?mix : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set input gain. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (downward), 1 (upward))
• threshold (of type float?, which defaults to null): set threshold. (default: 0.125)
• ratio (of type float?, which defaults to null): set ratio. (default: 2)
• attack (of type float?, which defaults to null): set attack. (default: 20)
• release (of type float?, which defaults to null): set release. (default: 250)
• makeup (of type float?, which defaults to null): set make up gain. (default: 1)
• knee (of type float?, which defaults to null): set knee. (default: 2.82843)
• link (of type int?, which defaults to null): set link type. (default: 0, possible values: 0 (average), 1 (maximum))
• detection (of type int?, which defaults to null): set detection. (default: 1, possible values: 0 (peak), 1 (rms))
• level_sc (of type float?, which defaults to null): set sidechain gain. (default: 1)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.acompressor.create

Ffmpeg filter: Audio compressor. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?mode : int?, ?threshold : float?, ?ratio : float?,
 ?attack : float?, ?release : float?, ?makeup : float?, ?knee : float?,
 ?link : int?, ?detection : int?, ?level_sc : float?, ?mix : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set input gain. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (downward), 1 (upward))
• threshold (of type float?, which defaults to null): set threshold. (default: 0.125)
• ratio (of type float?, which defaults to null): set ratio. (default: 2)
• attack (of type float?, which defaults to null): set attack. (default: 20)
• release (of type float?, which defaults to null): set release. (default: 250)
• makeup (of type float?, which defaults to null): set make up gain. (default: 1)
• knee (of type float?, which defaults to null): set knee. (default: 2.82843)
• link (of type int?, which defaults to null): set link type. (default: 0, possible values: 0 (average), 1 (maximum))
• detection (of type int?, which defaults to null): set detection. (default: 1, possible values: 0 (peak), 1 (rms))
• level_sc (of type float?, which defaults to null): set sidechain gain. (default: 1)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.acontrast

Ffmpeg filter: Simple audio dynamic range compression/expansion filter.

Type:

(?contrast : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• contrast (of type float?, which defaults to null): set contrast. (default: 33)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.acontrast.create

Ffmpeg filter: Simple audio dynamic range compression/expansion filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?contrast : float?, ffmpeg.filter.graph) -> unit

Arguments:

• contrast (of type float?, which defaults to null): set contrast. (default: 33)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.acopy

Ffmpeg filter: Copy the input audio unchanged to the output.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.acopy.create

Ffmpeg filter: Copy the input audio unchanged to the output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.acrossfade

Ffmpeg filter: Cross fade two input audio streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?n : int?, ?nb_samples : int?, ?ns : int?, ?duration : int?,
 ?d : int?, ?overlap : bool?, ?o : bool?, ?curve1 : int?, ?c1 : int?,
 ?curve2 : int?, ?c2 : int?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.audio

Arguments:

• inputs (of type int?, which defaults to null): set number of input files to cross fade. (default: 2)
• n (of type int?, which defaults to null): set number of input files to cross fade. (default: 2)
• nb_samples (of type int?, which defaults to null): set number of samples for cross fade duration. (default: 44100)
• ns (of type int?, which defaults to null): set number of samples for cross fade duration. (default: 44100)
• duration (of type int?, which defaults to null): set cross fade duration. (default: 0)
• d (of type int?, which defaults to null): set cross fade duration. (default: 0)
• overlap (of type bool?, which defaults to null): overlap 1st stream end with 2nd stream start. (default: true)
• o (of type bool?, which defaults to null): overlap 1st stream end with 2nd stream start. (default: true)
• curve1 (of type int?, which defaults to null): set fade curve type for 1st stream. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• c1 (of type int?, which defaults to null): set fade curve type for 1st stream. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• curve2 (of type int?, which defaults to null): set fade curve type for 2nd stream. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• c2 (of type int?, which defaults to null): set fade curve type for 2nd stream. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.acrossfade.create

Ffmpeg filter: Cross fade two input audio streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?n : int?, ?nb_samples : int?, ?ns : int?, ?duration : int?,
 ?d : int?, ?overlap : bool?, ?o : bool?, ?curve1 : int?, ?c1 : int?,
 ?curve2 : int?, ?c2 : int?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): set number of input files to cross fade. (default: 2)
• n (of type int?, which defaults to null): set number of input files to cross fade. (default: 2)
• nb_samples (of type int?, which defaults to null): set number of samples for cross fade duration. (default: 44100)
• ns (of type int?, which defaults to null): set number of samples for cross fade duration. (default: 44100)
• duration (of type int?, which defaults to null): set cross fade duration. (default: 0)
• d (of type int?, which defaults to null): set cross fade duration. (default: 0)
• overlap (of type bool?, which defaults to null): overlap 1st stream end with 2nd stream start. (default: true)
• o (of type bool?, which defaults to null): overlap 1st stream end with 2nd stream start. (default: true)
• curve1 (of type int?, which defaults to null): set fade curve type for 1st stream. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• c1 (of type int?, which defaults to null): set fade curve type for 1st stream. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• curve2 (of type int?, which defaults to null): set fade curve type for 2nd stream. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• c2 (of type int?, which defaults to null): set fade curve type for 2nd stream. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.acrossover

Ffmpeg filter: Split audio into per-bands streams. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?split : string?, ?order : int?, ?level : float?, ?gain : string?,
 ?precision : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• split (of type string?, which defaults to null): set split frequencies. (default: 500)
• order (of type int?, which defaults to null): set filter order. (default: 1, possible values: 0 (2nd), 1 (4th), 2 (6th), 3 (8th), 4 (10th), 5 (12th), 6 (14th), 7 (16th), 8 (18th), 9 (20th))
• level (of type float?, which defaults to null): set input gain. (default: 1)
• gain (of type string?, which defaults to null): set output bands gain. (default: 1.f)
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.acrossover.create

Ffmpeg filter: Split audio into per-bands streams. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?split : string?, ?order : int?, ?level : float?, ?gain : string?,
 ?precision : int?, ffmpeg.filter.graph) -> unit

Arguments:

• split (of type string?, which defaults to null): set split frequencies. (default: 500)
• order (of type int?, which defaults to null): set filter order. (default: 1, possible values: 0 (2nd), 1 (4th), 2 (6th), 3 (8th), 4 (10th), 5 (12th), 6 (14th), 7 (16th), 8 (18th), 9 (20th))
• level (of type float?, which defaults to null): set input gain. (default: 1)
• gain (of type string?, which defaults to null): set output bands gain. (default: 1.f)
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.acrusher

Ffmpeg filter: Reduce audio bit resolution.

Type:

(?level_in : float?, ?level_out : float?, ?bits : float?, ?mix : float?,
 ?mode : int?, ?dc : float?, ?aa : float?, ?samples : float?, ?lfo : bool?,
 ?lforange : float?, ?lforate : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set level in. (default: 1)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• bits (of type float?, which defaults to null): set bit reduction. (default: 8)
• mix (of type float?, which defaults to null): set mix. (default: 0.5)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (lin), 1 (log))
• dc (of type float?, which defaults to null): set DC. (default: 1)
• aa (of type float?, which defaults to null): set anti-aliasing. (default: 0.5)
• samples (of type float?, which defaults to null): set sample reduction. (default: 1)
• lfo (of type bool?, which defaults to null): enable LFO. (default: false)
• lforange (of type float?, which defaults to null): set LFO depth. (default: 20)
• lforate (of type float?, which defaults to null): set LFO rate. (default: 0.3)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.acrusher.create

Ffmpeg filter: Reduce audio bit resolution. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?level_out : float?, ?bits : float?, ?mix : float?,
 ?mode : int?, ?dc : float?, ?aa : float?, ?samples : float?, ?lfo : bool?,
 ?lforange : float?, ?lforate : float?, ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set level in. (default: 1)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• bits (of type float?, which defaults to null): set bit reduction. (default: 8)
• mix (of type float?, which defaults to null): set mix. (default: 0.5)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (lin), 1 (log))
• dc (of type float?, which defaults to null): set DC. (default: 1)
• aa (of type float?, which defaults to null): set anti-aliasing. (default: 0.5)
• samples (of type float?, which defaults to null): set sample reduction. (default: 1)
• lfo (of type bool?, which defaults to null): enable LFO. (default: false)
• lforange (of type float?, which defaults to null): set LFO depth. (default: 20)
• lforate (of type float?, which defaults to null): set LFO rate. (default: 0.3)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.acue

Ffmpeg filter: Delay filtering to match a cue.

Type:

(?cue : int?, ?preroll : int?, ?buffer : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• cue (of type int?, which defaults to null): cue unix timestamp in microseconds. (default: 0)
• preroll (of type int?, which defaults to null): preroll duration in seconds. (default: 0)
• buffer (of type int?, which defaults to null): buffer duration in seconds. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.acue.create

Ffmpeg filter: Delay filtering to match a cue. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cue : int?, ?preroll : int?, ?buffer : int?, ffmpeg.filter.graph) -> unit

Arguments:

• cue (of type int?, which defaults to null): cue unix timestamp in microseconds. (default: 0)
• preroll (of type int?, which defaults to null): preroll duration in seconds. (default: 0)
• buffer (of type int?, which defaults to null): buffer duration in seconds. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.addroi

Ffmpeg filter: Add region of interest to frame.

Type:

(?x : string?, ?y : string?, ?w : string?, ?h : string?, ?qoffset : string?,
 ?clear : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• x (of type string?, which defaults to null): Region distance from left edge of frame.. (default: 0)
• y (of type string?, which defaults to null): Region distance from top edge of frame.. (default: 0)
• w (of type string?, which defaults to null): Region width.. (default: 0)
• h (of type string?, which defaults to null): Region height.. (default: 0)
• qoffset (of type string?, which defaults to null): Quantisation offset to apply in the region.. (default: -1/10)
• clear (of type bool?, which defaults to null): Remove any existing regions of interest before adding the new one.. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.addroi.create

Ffmpeg filter: Add region of interest to frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : string?, ?y : string?, ?w : string?, ?h : string?, ?qoffset : string?,
 ?clear : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• x (of type string?, which defaults to null): Region distance from left edge of frame.. (default: 0)
• y (of type string?, which defaults to null): Region distance from top edge of frame.. (default: 0)
• w (of type string?, which defaults to null): Region width.. (default: 0)
• h (of type string?, which defaults to null): Region height.. (default: 0)
• qoffset (of type string?, which defaults to null): Quantisation offset to apply in the region.. (default: -1/10)
• clear (of type bool?, which defaults to null): Remove any existing regions of interest before adding the new one.. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adeclick

Ffmpeg filter: Remove impulsive noise from input audio.

Type:

(?window : float?, ?w : float?, ?overlap : float?, ?o : float?,
 ?arorder : float?, ?a : float?, ?threshold : float?, ?t : float?,
 ?burst : float?, ?b : float?, ?method : int?, ?m : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• window (of type float?, which defaults to null): set window size. (default: 55)
• w (of type float?, which defaults to null): set window size. (default: 55)
• overlap (of type float?, which defaults to null): set window overlap. (default: 75)
• o (of type float?, which defaults to null): set window overlap. (default: 75)
• arorder (of type float?, which defaults to null): set autoregression order. (default: 2)
• a (of type float?, which defaults to null): set autoregression order. (default: 2)
• threshold (of type float?, which defaults to null): set threshold. (default: 2)
• t (of type float?, which defaults to null): set threshold. (default: 2)
• burst (of type float?, which defaults to null): set burst fusion. (default: 2)
• b (of type float?, which defaults to null): set burst fusion. (default: 2)
• method (of type int?, which defaults to null): set overlap method. (default: 0, possible values: 0 (add), 0 (a), 1 (save), 1 (s))
• m (of type int?, which defaults to null): set overlap method. (default: 0, possible values: 0 (add), 0 (a), 1 (save), 1 (s))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adeclick.create

Ffmpeg filter: Remove impulsive noise from input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?window : float?, ?w : float?, ?overlap : float?, ?o : float?,
 ?arorder : float?, ?a : float?, ?threshold : float?, ?t : float?,
 ?burst : float?, ?b : float?, ?method : int?, ?m : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• window (of type float?, which defaults to null): set window size. (default: 55)
• w (of type float?, which defaults to null): set window size. (default: 55)
• overlap (of type float?, which defaults to null): set window overlap. (default: 75)
• o (of type float?, which defaults to null): set window overlap. (default: 75)
• arorder (of type float?, which defaults to null): set autoregression order. (default: 2)
• a (of type float?, which defaults to null): set autoregression order. (default: 2)
• threshold (of type float?, which defaults to null): set threshold. (default: 2)
• t (of type float?, which defaults to null): set threshold. (default: 2)
• burst (of type float?, which defaults to null): set burst fusion. (default: 2)
• b (of type float?, which defaults to null): set burst fusion. (default: 2)
• method (of type int?, which defaults to null): set overlap method. (default: 0, possible values: 0 (add), 0 (a), 1 (save), 1 (s))
• m (of type int?, which defaults to null): set overlap method. (default: 0, possible values: 0 (add), 0 (a), 1 (save), 1 (s))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adeclip

Ffmpeg filter: Remove clipping from input audio.

Type:

(?window : float?, ?w : float?, ?overlap : float?, ?o : float?,
 ?arorder : float?, ?a : float?, ?threshold : float?, ?t : float?,
 ?hsize : int?, ?n : int?, ?method : int?, ?m : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• window (of type float?, which defaults to null): set window size. (default: 55)
• w (of type float?, which defaults to null): set window size. (default: 55)
• overlap (of type float?, which defaults to null): set window overlap. (default: 75)
• o (of type float?, which defaults to null): set window overlap. (default: 75)
• arorder (of type float?, which defaults to null): set autoregression order. (default: 8)
• a (of type float?, which defaults to null): set autoregression order. (default: 8)
• threshold (of type float?, which defaults to null): set threshold. (default: 10)
• t (of type float?, which defaults to null): set threshold. (default: 10)
• hsize (of type int?, which defaults to null): set histogram size. (default: 1000)
• n (of type int?, which defaults to null): set histogram size. (default: 1000)
• method (of type int?, which defaults to null): set overlap method. (default: 0, possible values: 0 (add), 0 (a), 1 (save), 1 (s))
• m (of type int?, which defaults to null): set overlap method. (default: 0, possible values: 0 (add), 0 (a), 1 (save), 1 (s))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adeclip.create

Ffmpeg filter: Remove clipping from input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?window : float?, ?w : float?, ?overlap : float?, ?o : float?,
 ?arorder : float?, ?a : float?, ?threshold : float?, ?t : float?,
 ?hsize : int?, ?n : int?, ?method : int?, ?m : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• window (of type float?, which defaults to null): set window size. (default: 55)
• w (of type float?, which defaults to null): set window size. (default: 55)
• overlap (of type float?, which defaults to null): set window overlap. (default: 75)
• o (of type float?, which defaults to null): set window overlap. (default: 75)
• arorder (of type float?, which defaults to null): set autoregression order. (default: 8)
• a (of type float?, which defaults to null): set autoregression order. (default: 8)
• threshold (of type float?, which defaults to null): set threshold. (default: 10)
• t (of type float?, which defaults to null): set threshold. (default: 10)
• hsize (of type int?, which defaults to null): set histogram size. (default: 1000)
• n (of type int?, which defaults to null): set histogram size. (default: 1000)
• method (of type int?, which defaults to null): set overlap method. (default: 0, possible values: 0 (add), 0 (a), 1 (save), 1 (s))
• m (of type int?, which defaults to null): set overlap method. (default: 0, possible values: 0 (add), 0 (a), 1 (save), 1 (s))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adecorrelate

Ffmpeg filter: Apply decorrelation to input audio.

Type:

(?stages : int?, ?seed : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• stages (of type int?, which defaults to null): set filtering stages. (default: 6)
• seed (of type int?, which defaults to null): set random seed. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adecorrelate.create

Ffmpeg filter: Apply decorrelation to input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?stages : int?, ?seed : int?, ffmpeg.filter.graph) -> unit

Arguments:

• stages (of type int?, which defaults to null): set filtering stages. (default: 6)
• seed (of type int?, which defaults to null): set random seed. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adelay

Ffmpeg filter: Delay one or more audio channels.

Type:

(?delays : string?, ?all : bool?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• delays (of type string?, which defaults to null): set list of delays for each channel
• all (of type bool?, which defaults to null): use last available delay for remained channels. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adelay.create

Ffmpeg filter: Delay one or more audio channels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?delays : string?, ?all : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• delays (of type string?, which defaults to null): set list of delays for each channel
• all (of type bool?, which defaults to null): use last available delay for remained channels. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adenorm

Ffmpeg filter: Remedy denormals by adding extremely low-level noise.

Type:

(?level : float?, ?type : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• level (of type float?, which defaults to null): set level. (default: -351)
• type (of type int?, which defaults to null): set type. (default: 0, possible values: 0 (dc), 1 (ac), 2 (square), 3 (pulse))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adenorm.create

Ffmpeg filter: Remedy denormals by adding extremely low-level noise. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level : float?, ?type : int?, ffmpeg.filter.graph) -> unit

Arguments:

• level (of type float?, which defaults to null): set level. (default: -351)
• type (of type int?, which defaults to null): set type. (default: 0, possible values: 0 (dc), 1 (ac), 2 (square), 3 (pulse))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aderivative

Ffmpeg filter: Compute derivative of input audio.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aderivative.create

Ffmpeg filter: Compute derivative of input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adrawgraph

Ffmpeg filter: Draw a graph using input audio metadata.

Type:

(?m1 : string?, ?fg1 : string?, ?m2 : string?, ?fg2 : string?, ?m3 : string?,
 ?fg3 : string?, ?m4 : string?, ?fg4 : string?, ?bg : string?, ?min : float?,
 ?max : float?, ?mode : int?, ?slide : int?, ?size : string?, ?s : string?,
 ?rate : string?, ?r : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.video

Arguments:

• m1 (of type string?, which defaults to null): set 1st metadata key. (default: )
• fg1 (of type string?, which defaults to null): set 1st foreground color expression. (default: 0xffff0000)
• m2 (of type string?, which defaults to null): set 2nd metadata key. (default: )
• fg2 (of type string?, which defaults to null): set 2nd foreground color expression. (default: 0xff00ff00)
• m3 (of type string?, which defaults to null): set 3rd metadata key. (default: )
• fg3 (of type string?, which defaults to null): set 3rd foreground color expression. (default: 0xffff00ff)
• m4 (of type string?, which defaults to null): set 4th metadata key. (default: )
• fg4 (of type string?, which defaults to null): set 4th foreground color expression. (default: 0xffffff00)
• bg (of type string?, which defaults to null): set background color. (default: white)
• min (of type float?, which defaults to null): set minimal value. (default: -1)
• max (of type float?, which defaults to null): set maximal value. (default: 1)
• mode (of type int?, which defaults to null): set graph mode. (default: 2, possible values: 0 (bar), 1 (dot), 2 (line))
• slide (of type int?, which defaults to null): set slide mode. (default: 0, possible values: 0 (frame), 1 (replace), 2 (scroll), 3 (rscroll), 4 (picture))
• size (of type string?, which defaults to null): set graph size. (default: 900x256)
• s (of type string?, which defaults to null): set graph size. (default: 900x256)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adrawgraph.create

Ffmpeg filter: Draw a graph using input audio metadata. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?m1 : string?, ?fg1 : string?, ?m2 : string?, ?fg2 : string?, ?m3 : string?,
 ?fg3 : string?, ?m4 : string?, ?fg4 : string?, ?bg : string?, ?min : float?,
 ?max : float?, ?mode : int?, ?slide : int?, ?size : string?, ?s : string?,
 ?rate : string?, ?r : string?, ffmpeg.filter.graph) -> unit

Arguments:

• m1 (of type string?, which defaults to null): set 1st metadata key. (default: )
• fg1 (of type string?, which defaults to null): set 1st foreground color expression. (default: 0xffff0000)
• m2 (of type string?, which defaults to null): set 2nd metadata key. (default: )
• fg2 (of type string?, which defaults to null): set 2nd foreground color expression. (default: 0xff00ff00)
• m3 (of type string?, which defaults to null): set 3rd metadata key. (default: )
• fg3 (of type string?, which defaults to null): set 3rd foreground color expression. (default: 0xffff00ff)
• m4 (of type string?, which defaults to null): set 4th metadata key. (default: )
• fg4 (of type string?, which defaults to null): set 4th foreground color expression. (default: 0xffffff00)
• bg (of type string?, which defaults to null): set background color. (default: white)
• min (of type float?, which defaults to null): set minimal value. (default: -1)
• max (of type float?, which defaults to null): set maximal value. (default: 1)
• mode (of type int?, which defaults to null): set graph mode. (default: 2, possible values: 0 (bar), 1 (dot), 2 (line))
• slide (of type int?, which defaults to null): set slide mode. (default: 0, possible values: 0 (frame), 1 (replace), 2 (scroll), 3 (rscroll), 4 (picture))
• size (of type string?, which defaults to null): set graph size. (default: 900x256)
• s (of type string?, which defaults to null): set graph size. (default: 900x256)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adrc

Ffmpeg filter: Audio Spectral Dynamic Range Controller.

Type:

(?transfer : string?, ?attack : float?, ?release : float?,
 ?channels : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• transfer (of type string?, which defaults to null): set the transfer expression. (default: p)
• attack (of type float?, which defaults to null): set the attack. (default: 50)
• release (of type float?, which defaults to null): set the release. (default: 100)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adrc.create

Ffmpeg filter: Audio Spectral Dynamic Range Controller. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?transfer : string?, ?attack : float?, ?release : float?,
 ?channels : string?, ffmpeg.filter.graph) -> unit

Arguments:

• transfer (of type string?, which defaults to null): set the transfer expression. (default: p)
• attack (of type float?, which defaults to null): set the attack. (default: 50)
• release (of type float?, which defaults to null): set the release. (default: 100)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adynamicequalizer

Ffmpeg filter: Apply Dynamic Equalization of input audio.

Type:

(?threshold : float?, ?dfrequency : float?, ?dqfactor : float?,
 ?tfrequency : float?, ?tqfactor : float?, ?attack : float?,
 ?release : float?, ?ratio : float?, ?makeup : float?, ?range : float?,
 ?mode : int?, ?dftype : int?, ?tftype : int?, ?auto : int?,
 ?precision : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• threshold (of type float?, which defaults to null): set detection threshold. (default: 0)
• dfrequency (of type float?, which defaults to null): set detection frequency. (default: 1000)
• dqfactor (of type float?, which defaults to null): set detection Q factor. (default: 1)
• tfrequency (of type float?, which defaults to null): set target frequency. (default: 1000)
• tqfactor (of type float?, which defaults to null): set target Q factor. (default: 1)
• attack (of type float?, which defaults to null): set detection attack duration. (default: 20)
• release (of type float?, which defaults to null): set detection release duration. (default: 200)
• ratio (of type float?, which defaults to null): set ratio factor. (default: 1)
• makeup (of type float?, which defaults to null): set makeup gain. (default: 0)
• range (of type float?, which defaults to null): set max gain. (default: 50)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: -1 (listen), 0 (cutbelow), 1 (cutabove), 2 (boostbelow), 3 (boostabove))
• dftype (of type int?, which defaults to null): set detection filter type. (default: 0, possible values: 0 (bandpass), 1 (lowpass), 2 (highpass), 3 (peak))
• tftype (of type int?, which defaults to null): set target filter type. (default: 0, possible values: 0 (bell), 1 (lowshelf), 2 (highshelf))
• auto (of type int?, which defaults to null): set auto threshold. (default: 2, possible values: 1 (disabled), 2 (off), 3 (on), 4 (adaptive))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adynamicequalizer.create

Ffmpeg filter: Apply Dynamic Equalization of input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold : float?, ?dfrequency : float?, ?dqfactor : float?,
 ?tfrequency : float?, ?tqfactor : float?, ?attack : float?,
 ?release : float?, ?ratio : float?, ?makeup : float?, ?range : float?,
 ?mode : int?, ?dftype : int?, ?tftype : int?, ?auto : int?,
 ?precision : int?, ffmpeg.filter.graph) -> unit

Arguments:

• threshold (of type float?, which defaults to null): set detection threshold. (default: 0)
• dfrequency (of type float?, which defaults to null): set detection frequency. (default: 1000)
• dqfactor (of type float?, which defaults to null): set detection Q factor. (default: 1)
• tfrequency (of type float?, which defaults to null): set target frequency. (default: 1000)
• tqfactor (of type float?, which defaults to null): set target Q factor. (default: 1)
• attack (of type float?, which defaults to null): set detection attack duration. (default: 20)
• release (of type float?, which defaults to null): set detection release duration. (default: 200)
• ratio (of type float?, which defaults to null): set ratio factor. (default: 1)
• makeup (of type float?, which defaults to null): set makeup gain. (default: 0)
• range (of type float?, which defaults to null): set max gain. (default: 50)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: -1 (listen), 0 (cutbelow), 1 (cutabove), 2 (boostbelow), 3 (boostabove))
• dftype (of type int?, which defaults to null): set detection filter type. (default: 0, possible values: 0 (bandpass), 1 (lowpass), 2 (highpass), 3 (peak))
• tftype (of type int?, which defaults to null): set target filter type. (default: 0, possible values: 0 (bell), 1 (lowshelf), 2 (highshelf))
• auto (of type int?, which defaults to null): set auto threshold. (default: 2, possible values: 1 (disabled), 2 (off), 3 (on), 4 (adaptive))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.adynamicsmooth

Ffmpeg filter: Apply Dynamic Smoothing of input audio.

Type:

(?sensitivity : float?, ?basefreq : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• sensitivity (of type float?, which defaults to null): set smooth sensitivity. (default: 2)
• basefreq (of type float?, which defaults to null): set base frequency. (default: 22050)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.adynamicsmooth.create

Ffmpeg filter: Apply Dynamic Smoothing of input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sensitivity : float?, ?basefreq : float?, ffmpeg.filter.graph) -> unit

Arguments:

• sensitivity (of type float?, which defaults to null): set smooth sensitivity. (default: 2)
• basefreq (of type float?, which defaults to null): set base frequency. (default: 22050)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aecho

Ffmpeg filter: Add echoing to the audio.

Type:

(?in_gain : float?, ?out_gain : float?, ?delays : string?, ?decays : string?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• in_gain (of type float?, which defaults to null): set signal input gain. (default: 0.6)
• out_gain (of type float?, which defaults to null): set signal output gain. (default: 0.3)
• delays (of type string?, which defaults to null): set list of signal delays. (default: 1000)
• decays (of type string?, which defaults to null): set list of signal decays. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aecho.create

Ffmpeg filter: Add echoing to the audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?in_gain : float?, ?out_gain : float?, ?delays : string?, ?decays : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• in_gain (of type float?, which defaults to null): set signal input gain. (default: 0.6)
• out_gain (of type float?, which defaults to null): set signal output gain. (default: 0.3)
• delays (of type string?, which defaults to null): set list of signal delays. (default: 1000)
• decays (of type string?, which defaults to null): set list of signal decays. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aemphasis

Ffmpeg filter: Audio emphasis.

Type:

(?level_in : float?, ?level_out : float?, ?mode : int?, ?type : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set input gain. (default: 1)
• level_out (of type float?, which defaults to null): set output gain. (default: 1)
• mode (of type int?, which defaults to null): set filter mode. (default: 0, possible values: 0 (reproduction), 1 (production))
• type (of type int?, which defaults to null): set filter type. (default: 4, possible values: 0 (col), 1 (emi), 2 (bsi), 3 (riaa), 4 (cd), 5 (50fm), 6 (75fm), 7 (50kf), 8 (75kf))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aemphasis.create

Ffmpeg filter: Audio emphasis. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?level_out : float?, ?mode : int?, ?type : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set input gain. (default: 1)
• level_out (of type float?, which defaults to null): set output gain. (default: 1)
• mode (of type int?, which defaults to null): set filter mode. (default: 0, possible values: 0 (reproduction), 1 (production))
• type (of type int?, which defaults to null): set filter type. (default: 4, possible values: 0 (col), 1 (emi), 2 (bsi), 3 (riaa), 4 (cd), 5 (50fm), 6 (75fm), 7 (50kf), 8 (75kf))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aeval

Ffmpeg filter: Filter audio signal according to a specified expression.

Type:

(?exprs : string?, ?channel_layout : string?, ?c : string?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• exprs (of type string?, which defaults to null): set the '|'-separated list of channels expressions
• channel_layout (of type string?, which defaults to null): set channel layout
• c (of type string?, which defaults to null): set channel layout
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aeval.create

Ffmpeg filter: Filter audio signal according to a specified expression. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?exprs : string?, ?channel_layout : string?, ?c : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• exprs (of type string?, which defaults to null): set the '|'-separated list of channels expressions
• channel_layout (of type string?, which defaults to null): set channel layout
• c (of type string?, which defaults to null): set channel layout
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aevalsrc

Ffmpeg filter: Generate an audio signal generated by an expression.

Type:

(?exprs : string?, ?nb_samples : int?, ?n : int?, ?sample_rate : string?,
 ?s : string?, ?duration : int?, ?d : int?, ?channel_layout : string?,
 ?c : string?, ffmpeg.filter.graph) -> ffmpeg.filter.audio

Arguments:

• exprs (of type string?, which defaults to null): set the '|'-separated list of channels expressions
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• sample_rate (of type string?, which defaults to null): set the sample rate. (default: 44100)
• s (of type string?, which defaults to null): set the sample rate. (default: 44100)
• duration (of type int?, which defaults to null): set audio duration. (default: -1e-06)
• d (of type int?, which defaults to null): set audio duration. (default: -1e-06)
• channel_layout (of type string?, which defaults to null): set channel layout
• c (of type string?, which defaults to null): set channel layout
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.aevalsrc.create

Ffmpeg filter: Generate an audio signal generated by an expression. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?exprs : string?, ?nb_samples : int?, ?n : int?, ?sample_rate : string?,
 ?s : string?, ?duration : int?, ?d : int?, ?channel_layout : string?,
 ?c : string?, ffmpeg.filter.graph) -> unit

Arguments:

• exprs (of type string?, which defaults to null): set the '|'-separated list of channels expressions
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• sample_rate (of type string?, which defaults to null): set the sample rate. (default: 44100)
• s (of type string?, which defaults to null): set the sample rate. (default: 44100)
• duration (of type int?, which defaults to null): set audio duration. (default: -1e-06)
• d (of type int?, which defaults to null): set audio duration. (default: -1e-06)
• channel_layout (of type string?, which defaults to null): set channel layout
• c (of type string?, which defaults to null): set channel layout
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aexciter

Ffmpeg filter: Enhance high frequency part of audio.

Type:

(?level_in : float?, ?level_out : float?, ?amount : float?, ?drive : float?,
 ?blend : float?, ?freq : float?, ?ceil : float?, ?listen : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set level in. (default: 1)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• amount (of type float?, which defaults to null): set amount. (default: 1)
• drive (of type float?, which defaults to null): set harmonics. (default: 8.5)
• blend (of type float?, which defaults to null): set blend harmonics. (default: 0)
• freq (of type float?, which defaults to null): set scope. (default: 7500)
• ceil (of type float?, which defaults to null): set ceiling. (default: 9999)
• listen (of type bool?, which defaults to null): enable listen mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aexciter.create

Ffmpeg filter: Enhance high frequency part of audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?level_out : float?, ?amount : float?, ?drive : float?,
 ?blend : float?, ?freq : float?, ?ceil : float?, ?listen : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set level in. (default: 1)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• amount (of type float?, which defaults to null): set amount. (default: 1)
• drive (of type float?, which defaults to null): set harmonics. (default: 8.5)
• blend (of type float?, which defaults to null): set blend harmonics. (default: 0)
• freq (of type float?, which defaults to null): set scope. (default: 7500)
• ceil (of type float?, which defaults to null): set ceiling. (default: 9999)
• listen (of type bool?, which defaults to null): enable listen mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afade

Ffmpeg filter: Fade in/out input audio.

Type:

(?type : int?, ?t : int?, ?start_sample : int?, ?ss : int?,
 ?nb_samples : int?, ?ns : int?, ?start_time : int?, ?st : int?,
 ?duration : int?, ?d : int?, ?curve : int?, ?c : int?, ?silence : float?,
 ?unity : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• type (of type int?, which defaults to null): set the fade direction. (default: 0, possible values: 0 (in), 1 (out))
• t (of type int?, which defaults to null): set the fade direction. (default: 0, possible values: 0 (in), 1 (out))
• start_sample (of type int?, which defaults to null): set number of first sample to start fading. (default: 0)
• ss (of type int?, which defaults to null): set number of first sample to start fading. (default: 0)
• nb_samples (of type int?, which defaults to null): set number of samples for fade duration. (default: 44100)
• ns (of type int?, which defaults to null): set number of samples for fade duration. (default: 44100)
• start_time (of type int?, which defaults to null): set time to start fading. (default: 0)
• st (of type int?, which defaults to null): set time to start fading. (default: 0)
• duration (of type int?, which defaults to null): set fade duration. (default: 0)
• d (of type int?, which defaults to null): set fade duration. (default: 0)
• curve (of type int?, which defaults to null): set fade curve type. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• c (of type int?, which defaults to null): set fade curve type. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• silence (of type float?, which defaults to null): set the silence gain. (default: 0)
• unity (of type float?, which defaults to null): set the unity gain. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.afade.create

Ffmpeg filter: Fade in/out input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?type : int?, ?t : int?, ?start_sample : int?, ?ss : int?,
 ?nb_samples : int?, ?ns : int?, ?start_time : int?, ?st : int?,
 ?duration : int?, ?d : int?, ?curve : int?, ?c : int?, ?silence : float?,
 ?unity : float?, ffmpeg.filter.graph) -> unit

Arguments:

• type (of type int?, which defaults to null): set the fade direction. (default: 0, possible values: 0 (in), 1 (out))
• t (of type int?, which defaults to null): set the fade direction. (default: 0, possible values: 0 (in), 1 (out))
• start_sample (of type int?, which defaults to null): set number of first sample to start fading. (default: 0)
• ss (of type int?, which defaults to null): set number of first sample to start fading. (default: 0)
• nb_samples (of type int?, which defaults to null): set number of samples for fade duration. (default: 44100)
• ns (of type int?, which defaults to null): set number of samples for fade duration. (default: 44100)
• start_time (of type int?, which defaults to null): set time to start fading. (default: 0)
• st (of type int?, which defaults to null): set time to start fading. (default: 0)
• duration (of type int?, which defaults to null): set fade duration. (default: 0)
• d (of type int?, which defaults to null): set fade duration. (default: 0)
• curve (of type int?, which defaults to null): set fade curve type. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• c (of type int?, which defaults to null): set fade curve type. (default: 0, possible values: -1 (nofade), 0 (tri), 1 (qsin), 2 (esin), 3 (hsin), 4 (log), 5 (ipar), 6 (qua), 7 (cub), 8 (squ), 9 (cbr), 10 (par), 11 (exp), 12 (iqsin), 13 (ihsin), 14 (dese), 15 (desi), 16 (losi), 17 (sinc), 18 (isinc), 19 (quat), 20 (quatr), 21 (qsin2), 22 (hsin2))
• silence (of type float?, which defaults to null): set the silence gain. (default: 0)
• unity (of type float?, which defaults to null): set the unity gain. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afdelaysrc

Ffmpeg filter: Generate a Fractional delay FIR coefficients.

Type:

(?delay : float?, ?d : float?, ?sample_rate : int?, ?r : int?,
 ?nb_samples : int?, ?n : int?, ?taps : int?, ?t : int?,
 ?channel_layout : string?, ?c : string?, ffmpeg.filter.graph) ->
ffmpeg.filter.audio

Arguments:

• delay (of type float?, which defaults to null): set fractional delay. (default: 0)
• d (of type float?, which defaults to null): set fractional delay. (default: 0)
• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• taps (of type int?, which defaults to null): set number of taps for delay filter. (default: 0)
• t (of type int?, which defaults to null): set number of taps for delay filter. (default: 0)
• channel_layout (of type string?, which defaults to null): set channel layout. (default: stereo)
• c (of type string?, which defaults to null): set channel layout. (default: stereo)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.afdelaysrc.create

Ffmpeg filter: Generate a Fractional delay FIR coefficients. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?delay : float?, ?d : float?, ?sample_rate : int?, ?r : int?,
 ?nb_samples : int?, ?n : int?, ?taps : int?, ?t : int?,
 ?channel_layout : string?, ?c : string?, ffmpeg.filter.graph) -> unit

Arguments:

• delay (of type float?, which defaults to null): set fractional delay. (default: 0)
• d (of type float?, which defaults to null): set fractional delay. (default: 0)
• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• taps (of type int?, which defaults to null): set number of taps for delay filter. (default: 0)
• t (of type int?, which defaults to null): set number of taps for delay filter. (default: 0)
• channel_layout (of type string?, which defaults to null): set channel layout. (default: stereo)
• c (of type string?, which defaults to null): set channel layout. (default: stereo)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afftdn

Ffmpeg filter: Denoise audio samples using FFT.

Type:

(?noise_reduction : float?, ?nr : float?, ?noise_floor : float?,
 ?nf : float?, ?noise_type : int?, ?nt : int?, ?band_noise : string?,
 ?bn : string?, ?residual_floor : float?, ?rf : float?, ?track_noise : bool?,
 ?tn : bool?, ?track_residual : bool?, ?tr : bool?, ?output_mode : int?,
 ?om : int?, ?adaptivity : float?, ?ad : float?, ?floor_offset : float?,
 ?fo : float?, ?noise_link : int?, ?nl : int?, ?band_multiplier : float?,
 ?bm : float?, ?sample_noise : int?, ?sn : int?, ?gain_smooth : int?,
 ?gs : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• noise_reduction (of type float?, which defaults to null): set the noise reduction. (default: 12)
• nr (of type float?, which defaults to null): set the noise reduction. (default: 12)
• noise_floor (of type float?, which defaults to null): set the noise floor. (default: -50)
• nf (of type float?, which defaults to null): set the noise floor. (default: -50)
• noise_type (of type int?, which defaults to null): set the noise type. (default: 0, possible values: 0 (white), 0 (w), 1 (vinyl), 1 (v), 2 (shellac), 2 (s), 3 (custom), 3 (c))
• nt (of type int?, which defaults to null): set the noise type. (default: 0, possible values: 0 (white), 0 (w), 1 (vinyl), 1 (v), 2 (shellac), 2 (s), 3 (custom), 3 (c))
• band_noise (of type string?, which defaults to null): set the custom bands noise
• bn (of type string?, which defaults to null): set the custom bands noise
• residual_floor (of type float?, which defaults to null): set the residual floor. (default: -38)
• rf (of type float?, which defaults to null): set the residual floor. (default: -38)
• track_noise (of type bool?, which defaults to null): track noise. (default: false)
• tn (of type bool?, which defaults to null): track noise. (default: false)
• track_residual (of type bool?, which defaults to null): track residual. (default: false)
• tr (of type bool?, which defaults to null): track residual. (default: false)
• output_mode (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (input), 0 (i), 1 (output), 1 (o), 2 (noise), 2 (n))
• om (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (input), 0 (i), 1 (output), 1 (o), 2 (noise), 2 (n))
• adaptivity (of type float?, which defaults to null): set adaptivity factor. (default: 0.5)
• ad (of type float?, which defaults to null): set adaptivity factor. (default: 0.5)
• floor_offset (of type float?, which defaults to null): set noise floor offset factor. (default: 1)
• fo (of type float?, which defaults to null): set noise floor offset factor. (default: 1)
• noise_link (of type int?, which defaults to null): set the noise floor link. (default: 1, possible values: 0 (none), 1 (min), 2 (max), 3 (average))
• nl (of type int?, which defaults to null): set the noise floor link. (default: 1, possible values: 0 (none), 1 (min), 2 (max), 3 (average))
• band_multiplier (of type float?, which defaults to null): set band multiplier. (default: 1.25)
• bm (of type float?, which defaults to null): set band multiplier. (default: 1.25)
• sample_noise (of type int?, which defaults to null): set sample noise mode. (default: 0, possible values: 0 (none), 1 (start), 1 (begin), 2 (stop), 2 (end))
• sn (of type int?, which defaults to null): set sample noise mode. (default: 0, possible values: 0 (none), 1 (start), 1 (begin), 2 (stop), 2 (end))
• gain_smooth (of type int?, which defaults to null): set gain smooth radius. (default: 0)
• gs (of type int?, which defaults to null): set gain smooth radius. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.afftdn.create

Ffmpeg filter: Denoise audio samples using FFT. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?noise_reduction : float?, ?nr : float?, ?noise_floor : float?,
 ?nf : float?, ?noise_type : int?, ?nt : int?, ?band_noise : string?,
 ?bn : string?, ?residual_floor : float?, ?rf : float?, ?track_noise : bool?,
 ?tn : bool?, ?track_residual : bool?, ?tr : bool?, ?output_mode : int?,
 ?om : int?, ?adaptivity : float?, ?ad : float?, ?floor_offset : float?,
 ?fo : float?, ?noise_link : int?, ?nl : int?, ?band_multiplier : float?,
 ?bm : float?, ?sample_noise : int?, ?sn : int?, ?gain_smooth : int?,
 ?gs : int?, ffmpeg.filter.graph) -> unit

Arguments:

• noise_reduction (of type float?, which defaults to null): set the noise reduction. (default: 12)
• nr (of type float?, which defaults to null): set the noise reduction. (default: 12)
• noise_floor (of type float?, which defaults to null): set the noise floor. (default: -50)
• nf (of type float?, which defaults to null): set the noise floor. (default: -50)
• noise_type (of type int?, which defaults to null): set the noise type. (default: 0, possible values: 0 (white), 0 (w), 1 (vinyl), 1 (v), 2 (shellac), 2 (s), 3 (custom), 3 (c))
• nt (of type int?, which defaults to null): set the noise type. (default: 0, possible values: 0 (white), 0 (w), 1 (vinyl), 1 (v), 2 (shellac), 2 (s), 3 (custom), 3 (c))
• band_noise (of type string?, which defaults to null): set the custom bands noise
• bn (of type string?, which defaults to null): set the custom bands noise
• residual_floor (of type float?, which defaults to null): set the residual floor. (default: -38)
• rf (of type float?, which defaults to null): set the residual floor. (default: -38)
• track_noise (of type bool?, which defaults to null): track noise. (default: false)
• tn (of type bool?, which defaults to null): track noise. (default: false)
• track_residual (of type bool?, which defaults to null): track residual. (default: false)
• tr (of type bool?, which defaults to null): track residual. (default: false)
• output_mode (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (input), 0 (i), 1 (output), 1 (o), 2 (noise), 2 (n))
• om (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (input), 0 (i), 1 (output), 1 (o), 2 (noise), 2 (n))
• adaptivity (of type float?, which defaults to null): set adaptivity factor. (default: 0.5)
• ad (of type float?, which defaults to null): set adaptivity factor. (default: 0.5)
• floor_offset (of type float?, which defaults to null): set noise floor offset factor. (default: 1)
• fo (of type float?, which defaults to null): set noise floor offset factor. (default: 1)
• noise_link (of type int?, which defaults to null): set the noise floor link. (default: 1, possible values: 0 (none), 1 (min), 2 (max), 3 (average))
• nl (of type int?, which defaults to null): set the noise floor link. (default: 1, possible values: 0 (none), 1 (min), 2 (max), 3 (average))
• band_multiplier (of type float?, which defaults to null): set band multiplier. (default: 1.25)
• bm (of type float?, which defaults to null): set band multiplier. (default: 1.25)
• sample_noise (of type int?, which defaults to null): set sample noise mode. (default: 0, possible values: 0 (none), 1 (start), 1 (begin), 2 (stop), 2 (end))
• sn (of type int?, which defaults to null): set sample noise mode. (default: 0, possible values: 0 (none), 1 (start), 1 (begin), 2 (stop), 2 (end))
• gain_smooth (of type int?, which defaults to null): set gain smooth radius. (default: 0)
• gs (of type int?, which defaults to null): set gain smooth radius. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afftfilt

Ffmpeg filter: Apply arbitrary expressions to samples in frequency domain.

Type:

(?real : string?, ?imag : string?, ?win_size : int?, ?win_func : int?,
 ?overlap : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• real (of type string?, which defaults to null): set channels real expressions. (default: re)
• imag (of type string?, which defaults to null): set channels imaginary expressions. (default: im)
• win_size (of type int?, which defaults to null): set window size. (default: 4096)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 0.75)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.afftfilt.create

Ffmpeg filter: Apply arbitrary expressions to samples in frequency domain. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?real : string?, ?imag : string?, ?win_size : int?, ?win_func : int?,
 ?overlap : float?, ffmpeg.filter.graph) -> unit

Arguments:

• real (of type string?, which defaults to null): set channels real expressions. (default: re)
• imag (of type string?, which defaults to null): set channels imaginary expressions. (default: im)
• win_size (of type int?, which defaults to null): set window size. (default: 4096)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 0.75)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afir

Ffmpeg filter: Apply Finite Impulse Response filter with supplied coefficients in additional stream(s). This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?dry : float?, ?wet : float?, ?length : float?, ?gtype : int?,
 ?irnorm : float?, ?irlink : bool?, ?irgain : float?, ?irfmt : int?,
 ?maxir : float?, ?response : bool?, ?channel : int?, ?size : string?,
 ?rate : string?, ?minp : int?, ?maxp : int?, ?nbirs : int?, ?ir : int?,
 ?precision : int?, ?irload : int?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.audio

Arguments:

• dry (of type float?, which defaults to null): set dry gain. (default: 1)
• wet (of type float?, which defaults to null): set wet gain. (default: 1)
• length (of type float?, which defaults to null): set IR length. (default: 1)
• gtype (of type int?, which defaults to null): set IR auto gain type. (default: 0, possible values: -1 (none), 0 (peak), 1 (dc), 2 (gn), 3 (ac), 4 (rms))
• irnorm (of type float?, which defaults to null): set IR norm. (default: 1)
• irlink (of type bool?, which defaults to null): set IR link. (default: true)
• irgain (of type float?, which defaults to null): set IR gain. (default: 1)
• irfmt (of type int?, which defaults to null): set IR format. (default: 1, possible values: 0 (mono), 1 (input))
• maxir (of type float?, which defaults to null): set max IR length. (default: 30)
• response (of type bool?, which defaults to null): show IR frequency response. (default: false)
• channel (of type int?, which defaults to null): set IR channel to display frequency response. (default: 0)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• minp (of type int?, which defaults to null): set min partition size. (default: 8192)
• maxp (of type int?, which defaults to null): set max partition size. (default: 8192)
• nbirs (of type int?, which defaults to null): set number of input IRs. (default: 1)
• ir (of type int?, which defaults to null): select IR. (default: 0)
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• irload (of type int?, which defaults to null): set IR loading type. (default: 0, possible values: 0 (init), 1 (access))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.afir.create

Ffmpeg filter: Apply Finite Impulse Response filter with supplied coefficients in additional stream(s). This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?dry : float?, ?wet : float?, ?length : float?, ?gtype : int?,
 ?irnorm : float?, ?irlink : bool?, ?irgain : float?, ?irfmt : int?,
 ?maxir : float?, ?response : bool?, ?channel : int?, ?size : string?,
 ?rate : string?, ?minp : int?, ?maxp : int?, ?nbirs : int?, ?ir : int?,
 ?precision : int?, ?irload : int?, ffmpeg.filter.graph) -> unit

Arguments:

• dry (of type float?, which defaults to null): set dry gain. (default: 1)
• wet (of type float?, which defaults to null): set wet gain. (default: 1)
• length (of type float?, which defaults to null): set IR length. (default: 1)
• gtype (of type int?, which defaults to null): set IR auto gain type. (default: 0, possible values: -1 (none), 0 (peak), 1 (dc), 2 (gn), 3 (ac), 4 (rms))
• irnorm (of type float?, which defaults to null): set IR norm. (default: 1)
• irlink (of type bool?, which defaults to null): set IR link. (default: true)
• irgain (of type float?, which defaults to null): set IR gain. (default: 1)
• irfmt (of type int?, which defaults to null): set IR format. (default: 1, possible values: 0 (mono), 1 (input))
• maxir (of type float?, which defaults to null): set max IR length. (default: 30)
• response (of type bool?, which defaults to null): show IR frequency response. (default: false)
• channel (of type int?, which defaults to null): set IR channel to display frequency response. (default: 0)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• minp (of type int?, which defaults to null): set min partition size. (default: 8192)
• maxp (of type int?, which defaults to null): set max partition size. (default: 8192)
• nbirs (of type int?, which defaults to null): set number of input IRs. (default: 1)
• ir (of type int?, which defaults to null): select IR. (default: 0)
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• irload (of type int?, which defaults to null): set IR loading type. (default: 0, possible values: 0 (init), 1 (access))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afireqsrc

Ffmpeg filter: Generate a FIR equalizer coefficients audio stream.

Type:

(?preset : int?, ?p : int?, ?gains : string?, ?g : string?, ?bands : string?,
 ?b : string?, ?taps : int?, ?t : int?, ?sample_rate : int?, ?r : int?,
 ?nb_samples : int?, ?n : int?, ?interp : int?, ?i : int?, ?phase : int?,
 ?h : int?, ffmpeg.filter.graph) -> ffmpeg.filter.audio

Arguments:

• preset (of type int?, which defaults to null): set equalizer preset. (default: 0, possible values: -1 (custom), 0 (flat), 1 (acoustic), 2 (bass), 3 (beats), 4 (classic), 5 (clear), 6 (deep bass), 7 (dubstep), 8 (electronic), 9 (hardstyle), 10 (hip-hop), 11 (jazz), 12 (metal), 13 (movie), 14 (pop), 15 (r&b), 16 (rock), 17 (vocal booster))
• p (of type int?, which defaults to null): set equalizer preset. (default: 0, possible values: -1 (custom), 0 (flat), 1 (acoustic), 2 (bass), 3 (beats), 4 (classic), 5 (clear), 6 (deep bass), 7 (dubstep), 8 (electronic), 9 (hardstyle), 10 (hip-hop), 11 (jazz), 12 (metal), 13 (movie), 14 (pop), 15 (r&b), 16 (rock), 17 (vocal booster))
• gains (of type string?, which defaults to null): set gain values per band. (default: 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0)
• g (of type string?, which defaults to null): set gain values per band. (default: 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0)
• bands (of type string?, which defaults to null): set central frequency values per band. (default: 25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000)
• b (of type string?, which defaults to null): set central frequency values per band. (default: 25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000)
• taps (of type int?, which defaults to null): set number of taps. (default: 4096)
• t (of type int?, which defaults to null): set number of taps. (default: 4096)
• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• interp (of type int?, which defaults to null): set the interpolation. (default: 0, possible values: 0 (linear), 1 (cubic))
• i (of type int?, which defaults to null): set the interpolation. (default: 0, possible values: 0 (linear), 1 (cubic))
• phase (of type int?, which defaults to null): set the phase. (default: 1, possible values: 0 (linear), 1 (min))
• h (of type int?, which defaults to null): set the phase. (default: 1, possible values: 0 (linear), 1 (min))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.afireqsrc.create

Ffmpeg filter: Generate a FIR equalizer coefficients audio stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?preset : int?, ?p : int?, ?gains : string?, ?g : string?, ?bands : string?,
 ?b : string?, ?taps : int?, ?t : int?, ?sample_rate : int?, ?r : int?,
 ?nb_samples : int?, ?n : int?, ?interp : int?, ?i : int?, ?phase : int?,
 ?h : int?, ffmpeg.filter.graph) -> unit

Arguments:

• preset (of type int?, which defaults to null): set equalizer preset. (default: 0, possible values: -1 (custom), 0 (flat), 1 (acoustic), 2 (bass), 3 (beats), 4 (classic), 5 (clear), 6 (deep bass), 7 (dubstep), 8 (electronic), 9 (hardstyle), 10 (hip-hop), 11 (jazz), 12 (metal), 13 (movie), 14 (pop), 15 (r&b), 16 (rock), 17 (vocal booster))
• p (of type int?, which defaults to null): set equalizer preset. (default: 0, possible values: -1 (custom), 0 (flat), 1 (acoustic), 2 (bass), 3 (beats), 4 (classic), 5 (clear), 6 (deep bass), 7 (dubstep), 8 (electronic), 9 (hardstyle), 10 (hip-hop), 11 (jazz), 12 (metal), 13 (movie), 14 (pop), 15 (r&b), 16 (rock), 17 (vocal booster))
• gains (of type string?, which defaults to null): set gain values per band. (default: 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0)
• g (of type string?, which defaults to null): set gain values per band. (default: 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0)
• bands (of type string?, which defaults to null): set central frequency values per band. (default: 25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000)
• b (of type string?, which defaults to null): set central frequency values per band. (default: 25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000)
• taps (of type int?, which defaults to null): set number of taps. (default: 4096)
• t (of type int?, which defaults to null): set number of taps. (default: 4096)
• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• interp (of type int?, which defaults to null): set the interpolation. (default: 0, possible values: 0 (linear), 1 (cubic))
• i (of type int?, which defaults to null): set the interpolation. (default: 0, possible values: 0 (linear), 1 (cubic))
• phase (of type int?, which defaults to null): set the phase. (default: 1, possible values: 0 (linear), 1 (min))
• h (of type int?, which defaults to null): set the phase. (default: 1, possible values: 0 (linear), 1 (min))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afirsrc

Ffmpeg filter: Generate a FIR coefficients audio stream.

Type:

(?taps : int?, ?t : int?, ?frequency : string?, ?f : string?,
 ?magnitude : string?, ?m : string?, ?phase : string?, ?p : string?,
 ?sample_rate : int?, ?r : int?, ?nb_samples : int?, ?n : int?,
 ?win_func : int?, ?w : int?, ffmpeg.filter.graph) -> ffmpeg.filter.audio

Arguments:

• taps (of type int?, which defaults to null): set number of taps. (default: 1025)
• t (of type int?, which defaults to null): set number of taps. (default: 1025)
• frequency (of type string?, which defaults to null): set frequency points. (default: 0 1)
• f (of type string?, which defaults to null): set frequency points. (default: 0 1)
• magnitude (of type string?, which defaults to null): set magnitude values. (default: 1 1)
• m (of type string?, which defaults to null): set magnitude values. (default: 1 1)
• phase (of type string?, which defaults to null): set phase values. (default: 0 0)
• p (of type string?, which defaults to null): set phase values. (default: 0 0)
• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• win_func (of type int?, which defaults to null): set window function. (default: 3, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser), 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• w (of type int?, which defaults to null): set window function. (default: 3, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser), 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.afirsrc.create

Ffmpeg filter: Generate a FIR coefficients audio stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?taps : int?, ?t : int?, ?frequency : string?, ?f : string?,
 ?magnitude : string?, ?m : string?, ?phase : string?, ?p : string?,
 ?sample_rate : int?, ?r : int?, ?nb_samples : int?, ?n : int?,
 ?win_func : int?, ?w : int?, ffmpeg.filter.graph) -> unit

Arguments:

• taps (of type int?, which defaults to null): set number of taps. (default: 1025)
• t (of type int?, which defaults to null): set number of taps. (default: 1025)
• frequency (of type string?, which defaults to null): set frequency points. (default: 0 1)
• f (of type string?, which defaults to null): set frequency points. (default: 0 1)
• magnitude (of type string?, which defaults to null): set magnitude values. (default: 1 1)
• m (of type string?, which defaults to null): set magnitude values. (default: 1 1)
• phase (of type string?, which defaults to null): set phase values. (default: 0 0)
• p (of type string?, which defaults to null): set phase values. (default: 0 0)
• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• win_func (of type int?, which defaults to null): set window function. (default: 3, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser), 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• w (of type int?, which defaults to null): set window function. (default: 3, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser), 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aformat

Ffmpeg filter: Convert the input audio to one of the specified formats.

Type:

(?sample_fmts : [string]?, ?f : [string]?, ?sample_rates : [int]?,
 ?r : [int]?, ?channel_layouts : [string]?, ?cl : [string]?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• sample_fmts (of type [string]?, which defaults to null): A '|'-separated list of sample formats.
• f (of type [string]?, which defaults to null): A '|'-separated list of sample formats.
• sample_rates (of type [int]?, which defaults to null): A '|'-separated list of sample rates.
• r (of type [int]?, which defaults to null): A '|'-separated list of sample rates.
• channel_layouts (of type [string]?, which defaults to null): A '|'-separated list of channel layouts.
• cl (of type [string]?, which defaults to null): A '|'-separated list of channel layouts.
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aformat.create

Ffmpeg filter: Convert the input audio to one of the specified formats. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sample_fmts : [string]?, ?f : [string]?, ?sample_rates : [int]?,
 ?r : [int]?, ?channel_layouts : [string]?, ?cl : [string]?,
 ffmpeg.filter.graph) -> unit

Arguments:

• sample_fmts (of type [string]?, which defaults to null): A '|'-separated list of sample formats.
• f (of type [string]?, which defaults to null): A '|'-separated list of sample formats.
• sample_rates (of type [int]?, which defaults to null): A '|'-separated list of sample rates.
• r (of type [int]?, which defaults to null): A '|'-separated list of sample rates.
• channel_layouts (of type [string]?, which defaults to null): A '|'-separated list of channel layouts.
• cl (of type [string]?, which defaults to null): A '|'-separated list of channel layouts.
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afreqshift

Ffmpeg filter: Apply frequency shifting to input audio.

Type:

(?shift : float?, ?level : float?, ?order : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• shift (of type float?, which defaults to null): set frequency shift. (default: 0)
• level (of type float?, which defaults to null): set output level. (default: 1)
• order (of type int?, which defaults to null): set filter order. (default: 8)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.afreqshift.create

Ffmpeg filter: Apply frequency shifting to input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?shift : float?, ?level : float?, ?order : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• shift (of type float?, which defaults to null): set frequency shift. (default: 0)
• level (of type float?, which defaults to null): set output level. (default: 1)
• order (of type int?, which defaults to null): set filter order. (default: 8)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.afwtdn

Ffmpeg filter: Denoise audio stream using Wavelets.

Type:

(?sigma : float?, ?levels : int?, ?wavet : int?, ?percent : float?,
 ?profile : bool?, ?adaptive : bool?, ?samples : int?, ?softness : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• sigma (of type float?, which defaults to null): set noise sigma. (default: 0)
• levels (of type int?, which defaults to null): set number of wavelet levels. (default: 10)
• wavet (of type int?, which defaults to null): set wavelet type. (default: 4, possible values: 0 (sym2), 1 (sym4), 2 (rbior68), 3 (deb10), 4 (sym10), 5 (coif5), 6 (bl3))
• percent (of type float?, which defaults to null): set percent of full denoising. (default: 85)
• profile (of type bool?, which defaults to null): profile noise. (default: false)
• adaptive (of type bool?, which defaults to null): adaptive profiling of noise. (default: false)
• samples (of type int?, which defaults to null): set frame size in number of samples. (default: 8192)
• softness (of type float?, which defaults to null): set thresholding softness. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.afwtdn.create

Ffmpeg filter: Denoise audio stream using Wavelets. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sigma : float?, ?levels : int?, ?wavet : int?, ?percent : float?,
 ?profile : bool?, ?adaptive : bool?, ?samples : int?, ?softness : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• sigma (of type float?, which defaults to null): set noise sigma. (default: 0)
• levels (of type int?, which defaults to null): set number of wavelet levels. (default: 10)
• wavet (of type int?, which defaults to null): set wavelet type. (default: 4, possible values: 0 (sym2), 1 (sym4), 2 (rbior68), 3 (deb10), 4 (sym10), 5 (coif5), 6 (bl3))
• percent (of type float?, which defaults to null): set percent of full denoising. (default: 85)
• profile (of type bool?, which defaults to null): profile noise. (default: false)
• adaptive (of type bool?, which defaults to null): adaptive profiling of noise. (default: false)
• samples (of type int?, which defaults to null): set frame size in number of samples. (default: 8192)
• softness (of type float?, which defaults to null): set thresholding softness. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.agate

Ffmpeg filter: Audio gate.

Type:

(?level_in : float?, ?mode : int?, ?range : float?, ?threshold : float?,
 ?ratio : float?, ?attack : float?, ?release : float?, ?makeup : float?,
 ?knee : float?, ?detection : int?, ?link : int?, ?level_sc : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set input level. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (downward), 1 (upward))
• range (of type float?, which defaults to null): set max gain reduction. (default: 0.06125)
• threshold (of type float?, which defaults to null): set threshold. (default: 0.125)
• ratio (of type float?, which defaults to null): set ratio. (default: 2)
• attack (of type float?, which defaults to null): set attack. (default: 20)
• release (of type float?, which defaults to null): set release. (default: 250)
• makeup (of type float?, which defaults to null): set makeup gain. (default: 1)
• knee (of type float?, which defaults to null): set knee. (default: 2.828427125)
• detection (of type int?, which defaults to null): set detection. (default: 1, possible values: 0 (peak), 1 (rms))
• link (of type int?, which defaults to null): set link. (default: 0, possible values: 0 (average), 1 (maximum))
• level_sc (of type float?, which defaults to null): set sidechain gain. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.agate.create

Ffmpeg filter: Audio gate. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?mode : int?, ?range : float?, ?threshold : float?,
 ?ratio : float?, ?attack : float?, ?release : float?, ?makeup : float?,
 ?knee : float?, ?detection : int?, ?link : int?, ?level_sc : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set input level. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (downward), 1 (upward))
• range (of type float?, which defaults to null): set max gain reduction. (default: 0.06125)
• threshold (of type float?, which defaults to null): set threshold. (default: 0.125)
• ratio (of type float?, which defaults to null): set ratio. (default: 2)
• attack (of type float?, which defaults to null): set attack. (default: 20)
• release (of type float?, which defaults to null): set release. (default: 250)
• makeup (of type float?, which defaults to null): set makeup gain. (default: 1)
• knee (of type float?, which defaults to null): set knee. (default: 2.828427125)
• detection (of type int?, which defaults to null): set detection. (default: 1, possible values: 0 (peak), 1 (rms))
• link (of type int?, which defaults to null): set link. (default: 0, possible values: 0 (average), 1 (maximum))
• level_sc (of type float?, which defaults to null): set sidechain gain. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.agraphmonitor

Ffmpeg filter: Show various filtergraph stats.

Type:

(?size : string?, ?s : string?, ?opacity : float?, ?o : float?, ?mode : int?,
 ?m : int?, ?flags : int?, ?f : int?, ?rate : string?, ?r : string?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set monitor size. (default: hd720)
• s (of type string?, which defaults to null): set monitor size. (default: hd720)
• opacity (of type float?, which defaults to null): set video opacity. (default: 0.9)
• o (of type float?, which defaults to null): set video opacity. (default: 0.9)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact), 2 (nozero), 4 (noeof), 8 (nodisabled), combined by addition)
• m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact), 2 (nozero), 4 (noeof), 8 (nodisabled), combined by addition)
• flags (of type int?, which defaults to null): set flags. (default: 1, possible values: 0 (none), 2147483647 (all), 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 16384 (frame_count_delta), 8 (pts), 4096 (pts_delta), 16 (time), 8192 (time_delta), 32 (timebase), 64 (format), 128 (size), 256 (rate), 512 (eof), 2048 (sample_count_in), 1024 (sample_count_out), 32768 (sample_count_delta), 65536 (disabled), combined by addition)
• f (of type int?, which defaults to null): set flags. (default: 1, possible values: 0 (none), 2147483647 (all), 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 16384 (frame_count_delta), 8 (pts), 4096 (pts_delta), 16 (time), 8192 (time_delta), 32 (timebase), 64 (format), 128 (size), 256 (rate), 512 (eof), 2048 (sample_count_in), 1024 (sample_count_out), 32768 (sample_count_delta), 65536 (disabled), combined by addition)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.agraphmonitor.create

Ffmpeg filter: Show various filtergraph stats. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?opacity : float?, ?o : float?, ?mode : int?,
 ?m : int?, ?flags : int?, ?f : int?, ?rate : string?, ?r : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set monitor size. (default: hd720)
• s (of type string?, which defaults to null): set monitor size. (default: hd720)
• opacity (of type float?, which defaults to null): set video opacity. (default: 0.9)
• o (of type float?, which defaults to null): set video opacity. (default: 0.9)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact), 2 (nozero), 4 (noeof), 8 (nodisabled), combined by addition)
• m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact), 2 (nozero), 4 (noeof), 8 (nodisabled), combined by addition)
• flags (of type int?, which defaults to null): set flags. (default: 1, possible values: 0 (none), 2147483647 (all), 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 16384 (frame_count_delta), 8 (pts), 4096 (pts_delta), 16 (time), 8192 (time_delta), 32 (timebase), 64 (format), 128 (size), 256 (rate), 512 (eof), 2048 (sample_count_in), 1024 (sample_count_out), 32768 (sample_count_delta), 65536 (disabled), combined by addition)
• f (of type int?, which defaults to null): set flags. (default: 1, possible values: 0 (none), 2147483647 (all), 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 16384 (frame_count_delta), 8 (pts), 4096 (pts_delta), 16 (time), 8192 (time_delta), 32 (timebase), 64 (format), 128 (size), 256 (rate), 512 (eof), 2048 (sample_count_in), 1024 (sample_count_out), 32768 (sample_count_delta), 65536 (disabled), combined by addition)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ahistogram

Ffmpeg filter: Convert input audio to histogram video output.

Type:

(?dmode : int?, ?rate : string?, ?r : string?, ?size : string?, ?s : string?,
 ?scale : int?, ?ascale : int?, ?acount : int?, ?rheight : float?,
 ?slide : int?, ?hmode : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.video

Arguments:

• dmode (of type int?, which defaults to null): set method to display channels. (default: 0, possible values: 0 (single), 1 (separate))
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• s (of type string?, which defaults to null): set video size. (default: hd720)
• scale (of type int?, which defaults to null): set display scale. (default: 3, possible values: 3 (log), 1 (sqrt), 2 (cbrt), 0 (lin), 4 (rlog))
• ascale (of type int?, which defaults to null): set amplitude scale. (default: 1, possible values: 1 (log), 0 (lin))
• acount (of type int?, which defaults to null): how much frames to accumulate. (default: 1)
• rheight (of type float?, which defaults to null): set histogram ratio of window height. (default: 0.1)
• slide (of type int?, which defaults to null): set sonogram sliding. (default: 0, possible values: 0 (replace), 1 (scroll))
• hmode (of type int?, which defaults to null): set histograms mode. (default: 0, possible values: 0 (abs), 1 (sign))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.ahistogram.create

Ffmpeg filter: Convert input audio to histogram video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?dmode : int?, ?rate : string?, ?r : string?, ?size : string?, ?s : string?,
 ?scale : int?, ?ascale : int?, ?acount : int?, ?rheight : float?,
 ?slide : int?, ?hmode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• dmode (of type int?, which defaults to null): set method to display channels. (default: 0, possible values: 0 (single), 1 (separate))
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• s (of type string?, which defaults to null): set video size. (default: hd720)
• scale (of type int?, which defaults to null): set display scale. (default: 3, possible values: 3 (log), 1 (sqrt), 2 (cbrt), 0 (lin), 4 (rlog))
• ascale (of type int?, which defaults to null): set amplitude scale. (default: 1, possible values: 1 (log), 0 (lin))
• acount (of type int?, which defaults to null): how much frames to accumulate. (default: 1)
• rheight (of type float?, which defaults to null): set histogram ratio of window height. (default: 0.1)
• slide (of type int?, which defaults to null): set sonogram sliding. (default: 0, possible values: 0 (replace), 1 (scroll))
• hmode (of type int?, which defaults to null): set histograms mode. (default: 0, possible values: 0 (abs), 1 (sign))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aiir

Ffmpeg filter: Apply Infinite Impulse Response filter with supplied coefficients. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?zeros : string?, ?z : string?, ?poles : string?, ?p : string?,
 ?gains : string?, ?k : string?, ?dry : float?, ?wet : float?,
 ?format : int?, ?f : int?, ?process : int?, ?r : int?, ?precision : int?,
 ?e : int?, ?normalize : bool?, ?n : bool?, ?mix : float?, ?response : bool?,
 ?channel : int?, ?size : string?, ?rate : string?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> [ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• zeros (of type string?, which defaults to null): set B/numerator/zeros/reflection coefficients. (default: 1+0i 1-0i)
• z (of type string?, which defaults to null): set B/numerator/zeros/reflection coefficients. (default: 1+0i 1-0i)
• poles (of type string?, which defaults to null): set A/denominator/poles/ladder coefficients. (default: 1+0i 1-0i)
• p (of type string?, which defaults to null): set A/denominator/poles/ladder coefficients. (default: 1+0i 1-0i)
• gains (of type string?, which defaults to null): set channels gains. (default: 1|1)
• k (of type string?, which defaults to null): set channels gains. (default: 1|1)
• dry (of type float?, which defaults to null): set dry gain. (default: 1)
• wet (of type float?, which defaults to null): set wet gain. (default: 1)
• format (of type int?, which defaults to null): set coefficients format. (default: 1, possible values: -2 (ll), -1 (sf), 0 (tf), 1 (zp), 2 (pr), 3 (pd), 4 (sp))
• f (of type int?, which defaults to null): set coefficients format. (default: 1, possible values: -2 (ll), -1 (sf), 0 (tf), 1 (zp), 2 (pr), 3 (pd), 4 (sp))
• process (of type int?, which defaults to null): set kind of processing. (default: 1, possible values: 0 (d), 1 (s), 2 (p))
• r (of type int?, which defaults to null): set kind of processing. (default: 1, possible values: 0 (d), 1 (s), 2 (p))
• precision (of type int?, which defaults to null): set filtering precision. (default: 0, possible values: 0 (dbl), 1 (flt), 2 (i32), 3 (i16))
• e (of type int?, which defaults to null): set precision. (default: 0, possible values: 0 (dbl), 1 (flt), 2 (i32), 3 (i16))
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: true)
• n (of type bool?, which defaults to null): normalize coefficients. (default: true)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• response (of type bool?, which defaults to null): show IR frequency response. (default: false)
• channel (of type int?, which defaults to null): set IR channel to display frequency response. (default: 0)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aiir.create

Ffmpeg filter: Apply Infinite Impulse Response filter with supplied coefficients. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?zeros : string?, ?z : string?, ?poles : string?, ?p : string?,
 ?gains : string?, ?k : string?, ?dry : float?, ?wet : float?,
 ?format : int?, ?f : int?, ?process : int?, ?r : int?, ?precision : int?,
 ?e : int?, ?normalize : bool?, ?n : bool?, ?mix : float?, ?response : bool?,
 ?channel : int?, ?size : string?, ?rate : string?, ffmpeg.filter.graph) ->
unit

Arguments:

• zeros (of type string?, which defaults to null): set B/numerator/zeros/reflection coefficients. (default: 1+0i 1-0i)
• z (of type string?, which defaults to null): set B/numerator/zeros/reflection coefficients. (default: 1+0i 1-0i)
• poles (of type string?, which defaults to null): set A/denominator/poles/ladder coefficients. (default: 1+0i 1-0i)
• p (of type string?, which defaults to null): set A/denominator/poles/ladder coefficients. (default: 1+0i 1-0i)
• gains (of type string?, which defaults to null): set channels gains. (default: 1|1)
• k (of type string?, which defaults to null): set channels gains. (default: 1|1)
• dry (of type float?, which defaults to null): set dry gain. (default: 1)
• wet (of type float?, which defaults to null): set wet gain. (default: 1)
• format (of type int?, which defaults to null): set coefficients format. (default: 1, possible values: -2 (ll), -1 (sf), 0 (tf), 1 (zp), 2 (pr), 3 (pd), 4 (sp))
• f (of type int?, which defaults to null): set coefficients format. (default: 1, possible values: -2 (ll), -1 (sf), 0 (tf), 1 (zp), 2 (pr), 3 (pd), 4 (sp))
• process (of type int?, which defaults to null): set kind of processing. (default: 1, possible values: 0 (d), 1 (s), 2 (p))
• r (of type int?, which defaults to null): set kind of processing. (default: 1, possible values: 0 (d), 1 (s), 2 (p))
• precision (of type int?, which defaults to null): set filtering precision. (default: 0, possible values: 0 (dbl), 1 (flt), 2 (i32), 3 (i16))
• e (of type int?, which defaults to null): set precision. (default: 0, possible values: 0 (dbl), 1 (flt), 2 (i32), 3 (i16))
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: true)
• n (of type bool?, which defaults to null): normalize coefficients. (default: true)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• response (of type bool?, which defaults to null): show IR frequency response. (default: false)
• channel (of type int?, which defaults to null): set IR channel to display frequency response. (default: 0)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aintegral

Ffmpeg filter: Compute integral of input audio.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aintegral.create

Ffmpeg filter: Compute integral of input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ainterleave

Ffmpeg filter: Temporally interleave audio inputs. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?nb_inputs : int?, ?n : int?, ?duration : int?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.audio

Arguments:

• nb_inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• n (of type int?, which defaults to null): set number of inputs. (default: 2)
• duration (of type int?, which defaults to null): how to determine the end-of-stream. (default: 0, possible values: 0 (longest), 1 (shortest), 2 (first))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.ainterleave.create

Ffmpeg filter: Temporally interleave audio inputs. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?nb_inputs : int?, ?n : int?, ?duration : int?, ffmpeg.filter.graph) -> unit

Arguments:

• nb_inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• n (of type int?, which defaults to null): set number of inputs. (default: 2)
• duration (of type int?, which defaults to null): how to determine the end-of-stream. (default: 0, possible values: 0 (longest), 1 (shortest), 2 (first))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.alatency

Ffmpeg filter: Report audio filtering latency.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.alatency.create

Ffmpeg filter: Report audio filtering latency. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.alimiter

Ffmpeg filter: Audio lookahead limiter.

Type:

(?level_in : float?, ?level_out : float?, ?limit : float?, ?attack : float?,
 ?release : float?, ?asc : bool?, ?asc_level : float?, ?level : bool?,
 ?latency : bool?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set input level. (default: 1)
• level_out (of type float?, which defaults to null): set output level. (default: 1)
• limit (of type float?, which defaults to null): set limit. (default: 1)
• attack (of type float?, which defaults to null): set attack. (default: 5)
• release (of type float?, which defaults to null): set release. (default: 50)
• asc (of type bool?, which defaults to null): enable asc. (default: false)
• asc_level (of type float?, which defaults to null): set asc level. (default: 0.5)
• level (of type bool?, which defaults to null): auto level. (default: true)
• latency (of type bool?, which defaults to null): compensate delay. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.alimiter.create

Ffmpeg filter: Audio lookahead limiter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?level_out : float?, ?limit : float?, ?attack : float?,
 ?release : float?, ?asc : bool?, ?asc_level : float?, ?level : bool?,
 ?latency : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set input level. (default: 1)
• level_out (of type float?, which defaults to null): set output level. (default: 1)
• limit (of type float?, which defaults to null): set limit. (default: 1)
• attack (of type float?, which defaults to null): set attack. (default: 5)
• release (of type float?, which defaults to null): set release. (default: 50)
• asc (of type bool?, which defaults to null): enable asc. (default: false)
• asc_level (of type float?, which defaults to null): set asc level. (default: 0.5)
• level (of type bool?, which defaults to null): auto level. (default: true)
• latency (of type bool?, which defaults to null): compensate delay. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.allpass

Ffmpeg filter: Apply a two-pole all-pass filter.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?mix : float?, ?m : float?,
 ?channels : string?, ?c : string?, ?normalize : bool?, ?n : bool?,
 ?order : int?, ?o : int?, ?transform : int?, ?a : int?, ?precision : int?,
 ?r : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.707)
• w (of type float?, which defaults to null): set width. (default: 0.707)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• order (of type int?, which defaults to null): set filter order. (default: 2)
• o (of type int?, which defaults to null): set filter order. (default: 2)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.allpass.create

Ffmpeg filter: Apply a two-pole all-pass filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?mix : float?, ?m : float?,
 ?channels : string?, ?c : string?, ?normalize : bool?, ?n : bool?,
 ?order : int?, ?o : int?, ?transform : int?, ?a : int?, ?precision : int?,
 ?r : int?, ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.707)
• w (of type float?, which defaults to null): set width. (default: 0.707)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• order (of type int?, which defaults to null): set filter order. (default: 2)
• o (of type int?, which defaults to null): set filter order. (default: 2)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.allrgb

Ffmpeg filter: Generate all RGB colors.

Type:

(?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?sar : string?,
 ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.allrgb.create

Ffmpeg filter: Generate all RGB colors. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?sar : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.allyuv

Ffmpeg filter: Generate all yuv colors.

Type:

(?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?sar : string?,
 ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.allyuv.create

Ffmpeg filter: Generate all yuv colors. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?sar : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aloop

Ffmpeg filter: Loop audio samples.

Type:

(?loop : int?, ?size : int?, ?start : int?, ?time : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• loop (of type int?, which defaults to null): number of loops. (default: 0)
• size (of type int?, which defaults to null): max number of samples to loop. (default: 0)
• start (of type int?, which defaults to null): set the loop start sample. (default: 0)
• time (of type int?, which defaults to null): set the loop start time. (default: 9223372036854.775)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aloop.create

Ffmpeg filter: Loop audio samples. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?loop : int?, ?size : int?, ?start : int?, ?time : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• loop (of type int?, which defaults to null): number of loops. (default: 0)
• size (of type int?, which defaults to null): max number of samples to loop. (default: 0)
• start (of type int?, which defaults to null): set the loop start sample. (default: 0)
• time (of type int?, which defaults to null): set the loop start time. (default: 9223372036854.775)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.alphaextract

Ffmpeg filter: Extract an alpha channel as a grayscale image component.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.alphaextract.create

Ffmpeg filter: Extract an alpha channel as a grayscale image component. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.alphamerge

Ffmpeg filter: Copy the luma value of the second input into the alpha channel of the first input.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.alphamerge.create

Ffmpeg filter: Copy the luma value of the second input into the alpha channel of the first input. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.amerge

Ffmpeg filter: Merge two or more audio streams into a single multi-channel stream. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?layout_mode : int?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.audio

Arguments:

• inputs (of type int?, which defaults to null): specify the number of inputs. (default: 2)
• layout_mode (of type int?, which defaults to null): method used to determine the output channel layout. (default: 0, possible values: 0 (legacy), 1 (reset), 2 (normal))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.amerge.create

Ffmpeg filter: Merge two or more audio streams into a single multi-channel stream. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?layout_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): specify the number of inputs. (default: 2)
• layout_mode (of type int?, which defaults to null): method used to determine the output channel layout. (default: 0, possible values: 0 (legacy), 1 (reset), 2 (normal))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ametadata

Ffmpeg filter: Manipulate audio frame metadata.

Type:

(?mode : int?, ?key : string?, ?value : string?, ?function : int?,
 ?expr : string?, ?file : string?, ?direct : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• mode (of type int?, which defaults to null): set a mode of operation. (default: 0, possible values: 0 (select), 1 (add), 2 (modify), 3 (delete), 4 (print))
• key (of type string?, which defaults to null): set metadata key
• value (of type string?, which defaults to null): set metadata value
• function (of type int?, which defaults to null): function for comparing values. (default: 0, possible values: 0 (same_str), 1 (starts_with), 2 (less), 3 (equal), 4 (greater), 5 (expr), 6 (ends_with))
• expr (of type string?, which defaults to null): set expression for expr function
• file (of type string?, which defaults to null): set file where to print metadata information
• direct (of type bool?, which defaults to null): reduce buffering when printing to user-set file or pipe. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.ametadata.create

Ffmpeg filter: Manipulate audio frame metadata. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?key : string?, ?value : string?, ?function : int?,
 ?expr : string?, ?file : string?, ?direct : bool?, ffmpeg.filter.graph) ->
unit

Arguments:

• mode (of type int?, which defaults to null): set a mode of operation. (default: 0, possible values: 0 (select), 1 (add), 2 (modify), 3 (delete), 4 (print))
• key (of type string?, which defaults to null): set metadata key
• value (of type string?, which defaults to null): set metadata value
• function (of type int?, which defaults to null): function for comparing values. (default: 0, possible values: 0 (same_str), 1 (starts_with), 2 (less), 3 (equal), 4 (greater), 5 (expr), 6 (ends_with))
• expr (of type string?, which defaults to null): set expression for expr function
• file (of type string?, which defaults to null): set file where to print metadata information
• direct (of type bool?, which defaults to null): reduce buffering when printing to user-set file or pipe. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.amix

Ffmpeg filter: Audio mixing. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?duration : int?, ?dropout_transition : float?,
 ?weights : string?, ?normalize : bool?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.audio

Arguments:

• inputs (of type int?, which defaults to null): Number of inputs.. (default: 2)
• duration (of type int?, which defaults to null): How to determine the end-of-stream.. (default: 0, possible values: 0 (longest), 1 (shortest), 2 (first))
• dropout_transition (of type float?, which defaults to null): Transition time, in seconds, for volume renormalization when an input stream ends.. (default: 2)
• weights (of type string?, which defaults to null): Set weight for each input.. (default: 1 1)
• normalize (of type bool?, which defaults to null): Scale inputs. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.amix.create

Ffmpeg filter: Audio mixing. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?duration : int?, ?dropout_transition : float?,
 ?weights : string?, ?normalize : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): Number of inputs.. (default: 2)
• duration (of type int?, which defaults to null): How to determine the end-of-stream.. (default: 0, possible values: 0 (longest), 1 (shortest), 2 (first))
• dropout_transition (of type float?, which defaults to null): Transition time, in seconds, for volume renormalization when an input stream ends.. (default: 2)
• weights (of type string?, which defaults to null): Set weight for each input.. (default: 1 1)
• normalize (of type bool?, which defaults to null): Scale inputs. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.amovie

Ffmpeg filter: Read audio from a movie source. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?filename : string?, ?format_name : string?, ?f : string?,
 ?stream_index : int?, ?si : int?, ?seek_point : float?, ?sp : float?,
 ?streams : string?, ?s : string?, ?loop : int?, ?discontinuity : int?,
 ?dec_threads : int?, ?format_opts : string?, ffmpeg.filter.graph) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• filename (of type string?, which defaults to null)
• format_name (of type string?, which defaults to null): set format name
• f (of type string?, which defaults to null): set format name
• stream_index (of type int?, which defaults to null): set stream index. (default: -1)
• si (of type int?, which defaults to null): set stream index. (default: -1)
• seek_point (of type float?, which defaults to null): set seekpoint (seconds). (default: 0)
• sp (of type float?, which defaults to null): set seekpoint (seconds). (default: 0)
• streams (of type string?, which defaults to null): set streams
• s (of type string?, which defaults to null): set streams
• loop (of type int?, which defaults to null): set loop count. (default: 1)
• discontinuity (of type int?, which defaults to null): set discontinuity threshold. (default: 0)
• dec_threads (of type int?, which defaults to null): set the number of threads for decoding. (default: 0)
• format_opts (of type string?, which defaults to null): set format options for the opened file
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.amovie.create

Ffmpeg filter: Read audio from a movie source. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filename : string?, ?format_name : string?, ?f : string?,
 ?stream_index : int?, ?si : int?, ?seek_point : float?, ?sp : float?,
 ?streams : string?, ?s : string?, ?loop : int?, ?discontinuity : int?,
 ?dec_threads : int?, ?format_opts : string?, ffmpeg.filter.graph) -> unit

Arguments:

• filename (of type string?, which defaults to null)
• format_name (of type string?, which defaults to null): set format name
• f (of type string?, which defaults to null): set format name
• stream_index (of type int?, which defaults to null): set stream index. (default: -1)
• si (of type int?, which defaults to null): set stream index. (default: -1)
• seek_point (of type float?, which defaults to null): set seekpoint (seconds). (default: 0)
• sp (of type float?, which defaults to null): set seekpoint (seconds). (default: 0)
• streams (of type string?, which defaults to null): set streams
• s (of type string?, which defaults to null): set streams
• loop (of type int?, which defaults to null): set loop count. (default: 1)
• discontinuity (of type int?, which defaults to null): set discontinuity threshold. (default: 0)
• dec_threads (of type int?, which defaults to null): set the number of threads for decoding. (default: 0)
• format_opts (of type string?, which defaults to null): set format options for the opened file
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.amplify

Ffmpeg filter: Amplify changes between successive video frames.

Type:

(?radius : int?, ?factor : float?, ?threshold : float?, ?tolerance : float?,
 ?low : float?, ?high : float?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• radius (of type int?, which defaults to null): set radius. (default: 2)
• factor (of type float?, which defaults to null): set factor. (default: 2)
• threshold (of type float?, which defaults to null): set threshold. (default: 10)
• tolerance (of type float?, which defaults to null): set tolerance. (default: 0)
• low (of type float?, which defaults to null): set low limit for amplification. (default: 65535)
• high (of type float?, which defaults to null): set high limit for amplification. (default: 65535)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 7)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.amplify.create

Ffmpeg filter: Amplify changes between successive video frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?radius : int?, ?factor : float?, ?threshold : float?, ?tolerance : float?,
 ?low : float?, ?high : float?, ?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• radius (of type int?, which defaults to null): set radius. (default: 2)
• factor (of type float?, which defaults to null): set factor. (default: 2)
• threshold (of type float?, which defaults to null): set threshold. (default: 10)
• tolerance (of type float?, which defaults to null): set tolerance. (default: 0)
• low (of type float?, which defaults to null): set low limit for amplification. (default: 65535)
• high (of type float?, which defaults to null): set high limit for amplification. (default: 65535)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 7)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.amultiply

Ffmpeg filter: Multiply two audio streams.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.amultiply.create

Ffmpeg filter: Multiply two audio streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.anequalizer

Ffmpeg filter: Apply high-order audio parametric multi band equalizer. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?params : string?, ?curves : bool?, ?size : string?, ?mgain : float?,
 ?fscale : int?, ?colors : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• params (of type string?, which defaults to null): Default:
• curves (of type bool?, which defaults to null): draw frequency response curves. (default: false)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• mgain (of type float?, which defaults to null): set max gain. (default: 60)
• fscale (of type int?, which defaults to null): set frequency scale. (default: 1, possible values: 0 (lin), 1 (log))
• colors (of type string?, which defaults to null): set channels curves colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.anequalizer.create

Ffmpeg filter: Apply high-order audio parametric multi band equalizer. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?params : string?, ?curves : bool?, ?size : string?, ?mgain : float?,
 ?fscale : int?, ?colors : string?, ffmpeg.filter.graph) -> unit

Arguments:

• params (of type string?, which defaults to null): Default:
• curves (of type bool?, which defaults to null): draw frequency response curves. (default: false)
• size (of type string?, which defaults to null): set video size. (default: hd720)
• mgain (of type float?, which defaults to null): set max gain. (default: 60)
• fscale (of type int?, which defaults to null): set frequency scale. (default: 1, possible values: 0 (lin), 1 (log))
• colors (of type string?, which defaults to null): set channels curves colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.anlmdn

Ffmpeg filter: Reduce broadband noise from stream using Non-Local Means.

Type:

(?strength : float?, ?s : float?, ?patch : int?, ?p : int?, ?research : int?,
 ?r : int?, ?output : int?, ?o : int?, ?smooth : float?, ?m : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• strength (of type float?, which defaults to null): set denoising strength. (default: 1e-05)
• s (of type float?, which defaults to null): set denoising strength. (default: 1e-05)
• patch (of type int?, which defaults to null): set patch duration. (default: 0.002)
• p (of type int?, which defaults to null): set patch duration. (default: 0.002)
• research (of type int?, which defaults to null): set research duration. (default: 0.006)
• r (of type int?, which defaults to null): set research duration. (default: 0.006)
• output (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (n))
• o (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (n))
• smooth (of type float?, which defaults to null): set smooth factor. (default: 11)
• m (of type float?, which defaults to null): set smooth factor. (default: 11)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.anlmdn.create

Ffmpeg filter: Reduce broadband noise from stream using Non-Local Means. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?strength : float?, ?s : float?, ?patch : int?, ?p : int?, ?research : int?,
 ?r : int?, ?output : int?, ?o : int?, ?smooth : float?, ?m : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• strength (of type float?, which defaults to null): set denoising strength. (default: 1e-05)
• s (of type float?, which defaults to null): set denoising strength. (default: 1e-05)
• patch (of type int?, which defaults to null): set patch duration. (default: 0.002)
• p (of type int?, which defaults to null): set patch duration. (default: 0.002)
• research (of type int?, which defaults to null): set research duration. (default: 0.006)
• r (of type int?, which defaults to null): set research duration. (default: 0.006)
• output (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (n))
• o (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (n))
• smooth (of type float?, which defaults to null): set smooth factor. (default: 11)
• m (of type float?, which defaults to null): set smooth factor. (default: 11)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.anlmf

Ffmpeg filter: Apply Normalized Least-Mean-Fourth algorithm to first audio stream.

Type:

(?order : int?, ?mu : float?, ?eps : float?, ?leakage : float?,
 ?out_mode : int?, ?precision : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• order (of type int?, which defaults to null): set the filter order. (default: 256)
• mu (of type float?, which defaults to null): set the filter mu. (default: 0.75)
• eps (of type float?, which defaults to null): set the filter eps. (default: 1)
• leakage (of type float?, which defaults to null): set the filter leakage. (default: 0)
• out_mode (of type int?, which defaults to null): set output mode. (default: 2, possible values: 0 (i), 1 (d), 2 (o), 3 (n), 4 (e))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.anlmf.create

Ffmpeg filter: Apply Normalized Least-Mean-Fourth algorithm to first audio stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?order : int?, ?mu : float?, ?eps : float?, ?leakage : float?,
 ?out_mode : int?, ?precision : int?, ffmpeg.filter.graph) -> unit

Arguments:

• order (of type int?, which defaults to null): set the filter order. (default: 256)
• mu (of type float?, which defaults to null): set the filter mu. (default: 0.75)
• eps (of type float?, which defaults to null): set the filter eps. (default: 1)
• leakage (of type float?, which defaults to null): set the filter leakage. (default: 0)
• out_mode (of type int?, which defaults to null): set output mode. (default: 2, possible values: 0 (i), 1 (d), 2 (o), 3 (n), 4 (e))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.anlms

Ffmpeg filter: Apply Normalized Least-Mean-Squares algorithm to first audio stream.

Type:

(?order : int?, ?mu : float?, ?eps : float?, ?leakage : float?,
 ?out_mode : int?, ?precision : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• order (of type int?, which defaults to null): set the filter order. (default: 256)
• mu (of type float?, which defaults to null): set the filter mu. (default: 0.75)
• eps (of type float?, which defaults to null): set the filter eps. (default: 1)
• leakage (of type float?, which defaults to null): set the filter leakage. (default: 0)
• out_mode (of type int?, which defaults to null): set output mode. (default: 2, possible values: 0 (i), 1 (d), 2 (o), 3 (n), 4 (e))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.anlms.create

Ffmpeg filter: Apply Normalized Least-Mean-Squares algorithm to first audio stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?order : int?, ?mu : float?, ?eps : float?, ?leakage : float?,
 ?out_mode : int?, ?precision : int?, ffmpeg.filter.graph) -> unit

Arguments:

• order (of type int?, which defaults to null): set the filter order. (default: 256)
• mu (of type float?, which defaults to null): set the filter mu. (default: 0.75)
• eps (of type float?, which defaults to null): set the filter eps. (default: 1)
• leakage (of type float?, which defaults to null): set the filter leakage. (default: 0)
• out_mode (of type int?, which defaults to null): set output mode. (default: 2, possible values: 0 (i), 1 (d), 2 (o), 3 (n), 4 (e))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.anoisesrc

Ffmpeg filter: Generate a noise audio signal.

Type:

(?sample_rate : int?, ?r : int?, ?amplitude : float?, ?a : float?,
 ?duration : int?, ?d : int?, ?color : int?, ?colour : int?, ?c : int?,
 ?seed : int?, ?s : int?, ?nb_samples : int?, ?n : int?, ?density : float?,
 ffmpeg.filter.graph) -> ffmpeg.filter.audio

Arguments:

• sample_rate (of type int?, which defaults to null): set sample rate. (default: 48000)
• r (of type int?, which defaults to null): set sample rate. (default: 48000)
• amplitude (of type float?, which defaults to null): set amplitude. (default: 1)
• a (of type float?, which defaults to null): set amplitude. (default: 1)
• duration (of type int?, which defaults to null): set duration. (default: 0)
• d (of type int?, which defaults to null): set duration. (default: 0)
• color (of type int?, which defaults to null): set noise color. (default: 0, possible values: 0 (white), 1 (pink), 2 (brown), 3 (blue), 4 (violet), 5 (velvet))
• colour (of type int?, which defaults to null): set noise color. (default: 0, possible values: 0 (white), 1 (pink), 2 (brown), 3 (blue), 4 (violet), 5 (velvet))
• c (of type int?, which defaults to null): set noise color. (default: 0, possible values: 0 (white), 1 (pink), 2 (brown), 3 (blue), 4 (violet), 5 (velvet))
• seed (of type int?, which defaults to null): set random seed. (default: -1)
• s (of type int?, which defaults to null): set random seed. (default: -1)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• density (of type float?, which defaults to null): set density. (default: 0.05)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.anoisesrc.create

Ffmpeg filter: Generate a noise audio signal. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sample_rate : int?, ?r : int?, ?amplitude : float?, ?a : float?,
 ?duration : int?, ?d : int?, ?color : int?, ?colour : int?, ?c : int?,
 ?seed : int?, ?s : int?, ?nb_samples : int?, ?n : int?, ?density : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• sample_rate (of type int?, which defaults to null): set sample rate. (default: 48000)
• r (of type int?, which defaults to null): set sample rate. (default: 48000)
• amplitude (of type float?, which defaults to null): set amplitude. (default: 1)
• a (of type float?, which defaults to null): set amplitude. (default: 1)
• duration (of type int?, which defaults to null): set duration. (default: 0)
• d (of type int?, which defaults to null): set duration. (default: 0)
• color (of type int?, which defaults to null): set noise color. (default: 0, possible values: 0 (white), 1 (pink), 2 (brown), 3 (blue), 4 (violet), 5 (velvet))
• colour (of type int?, which defaults to null): set noise color. (default: 0, possible values: 0 (white), 1 (pink), 2 (brown), 3 (blue), 4 (violet), 5 (velvet))
• c (of type int?, which defaults to null): set noise color. (default: 0, possible values: 0 (white), 1 (pink), 2 (brown), 3 (blue), 4 (violet), 5 (velvet))
• seed (of type int?, which defaults to null): set random seed. (default: -1)
• s (of type int?, which defaults to null): set random seed. (default: -1)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• density (of type float?, which defaults to null): set density. (default: 0.05)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.anull

Ffmpeg filter: Pass the source unchanged to the output.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.anull.create

Ffmpeg filter: Pass the source unchanged to the output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.anullsink

Ffmpeg filter: Do absolutely nothing with the input audio.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.anullsink.create

Ffmpeg filter: Do absolutely nothing with the input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type unit): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.anullsrc

Ffmpeg filter: Null audio source, return empty audio frames.

Type:

(?channel_layout : string?, ?cl : string?, ?sample_rate : int?, ?r : int?,
 ?nb_samples : int?, ?n : int?, ?duration : int?, ?d : int?,
 ffmpeg.filter.graph) -> ffmpeg.filter.audio

Arguments:

• channel_layout (of type string?, which defaults to null): set channel_layout. (default: stereo)
• cl (of type string?, which defaults to null): set channel_layout. (default: stereo)
• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• duration (of type int?, which defaults to null): set the audio duration. (default: -1e-06)
• d (of type int?, which defaults to null): set the audio duration. (default: -1e-06)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.anullsrc.create

Ffmpeg filter: Null audio source, return empty audio frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?channel_layout : string?, ?cl : string?, ?sample_rate : int?, ?r : int?,
 ?nb_samples : int?, ?n : int?, ?duration : int?, ?d : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• channel_layout (of type string?, which defaults to null): set channel_layout. (default: stereo)
• cl (of type string?, which defaults to null): set channel_layout. (default: stereo)
• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• duration (of type int?, which defaults to null): set the audio duration. (default: -1e-06)
• d (of type int?, which defaults to null): set the audio duration. (default: -1e-06)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.apad

Ffmpeg filter: Pad audio with silence.

Type:

(?packet_size : int?, ?pad_len : int?, ?whole_len : int?, ?pad_dur : int?,
 ?whole_dur : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• packet_size (of type int?, which defaults to null): set silence packet size. (default: 4096)
• pad_len (of type int?, which defaults to null): set number of samples of silence to add. (default: -1)
• whole_len (of type int?, which defaults to null): set minimum target number of samples in the audio stream. (default: -1)
• pad_dur (of type int?, which defaults to null): set duration of silence to add. (default: -1e-06)
• whole_dur (of type int?, which defaults to null): set minimum target duration in the audio stream. (default: -1e-06)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.apad.create

Ffmpeg filter: Pad audio with silence. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?packet_size : int?, ?pad_len : int?, ?whole_len : int?, ?pad_dur : int?,
 ?whole_dur : int?, ffmpeg.filter.graph) -> unit

Arguments:

• packet_size (of type int?, which defaults to null): set silence packet size. (default: 4096)
• pad_len (of type int?, which defaults to null): set number of samples of silence to add. (default: -1)
• whole_len (of type int?, which defaults to null): set minimum target number of samples in the audio stream. (default: -1)
• pad_dur (of type int?, which defaults to null): set duration of silence to add. (default: -1e-06)
• whole_dur (of type int?, which defaults to null): set minimum target duration in the audio stream. (default: -1e-06)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aperms

Ffmpeg filter: Set permissions for the output audio frame.

Type:

(?mode : int?, ?seed : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• mode (of type int?, which defaults to null): select permissions mode. (default: 0, possible values: 0 (none), 1 (ro), 2 (rw), 3 (toggle), 4 (random))
• seed (of type int?, which defaults to null): set the seed for the random mode. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aperms.create

Ffmpeg filter: Set permissions for the output audio frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?seed : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): select permissions mode. (default: 0, possible values: 0 (none), 1 (ro), 2 (rw), 3 (toggle), 4 (random))
• seed (of type int?, which defaults to null): set the seed for the random mode. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aphasemeter

Ffmpeg filter: Convert input audio to phase meter video output. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?rate : string?, ?r : string?, ?size : string?, ?s : string?, ?rc : int?,
 ?gc : int?, ?bc : int?, ?mpc : string?, ?video : bool?, ?phasing : bool?,
 ?tolerance : float?, ?t : float?, ?angle : float?, ?a : float?,
 ?duration : int?, ?d : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: 800x400)
• s (of type string?, which defaults to null): set video size. (default: 800x400)
• rc (of type int?, which defaults to null): set red contrast. (default: 2)
• gc (of type int?, which defaults to null): set green contrast. (default: 7)
• bc (of type int?, which defaults to null): set blue contrast. (default: 1)
• mpc (of type string?, which defaults to null): set median phase color. (default: none)
• video (of type bool?, which defaults to null): set video output. (default: true)
• phasing (of type bool?, which defaults to null): set mono and out-of-phase detection output. (default: false)
• tolerance (of type float?, which defaults to null): set phase tolerance for mono detection. (default: 0)
• t (of type float?, which defaults to null): set phase tolerance for mono detection. (default: 0)
• angle (of type float?, which defaults to null): set angle threshold for out-of-phase detection. (default: 170)
• a (of type float?, which defaults to null): set angle threshold for out-of-phase detection. (default: 170)
• duration (of type int?, which defaults to null): set minimum mono or out-of-phase duration in seconds. (default: 2)
• d (of type int?, which defaults to null): set minimum mono or out-of-phase duration in seconds. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aphasemeter.create

Ffmpeg filter: Convert input audio to phase meter video output. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rate : string?, ?r : string?, ?size : string?, ?s : string?, ?rc : int?,
 ?gc : int?, ?bc : int?, ?mpc : string?, ?video : bool?, ?phasing : bool?,
 ?tolerance : float?, ?t : float?, ?angle : float?, ?a : float?,
 ?duration : int?, ?d : int?, ffmpeg.filter.graph) -> unit

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: 800x400)
• s (of type string?, which defaults to null): set video size. (default: 800x400)
• rc (of type int?, which defaults to null): set red contrast. (default: 2)
• gc (of type int?, which defaults to null): set green contrast. (default: 7)
• bc (of type int?, which defaults to null): set blue contrast. (default: 1)
• mpc (of type string?, which defaults to null): set median phase color. (default: none)
• video (of type bool?, which defaults to null): set video output. (default: true)
• phasing (of type bool?, which defaults to null): set mono and out-of-phase detection output. (default: false)
• tolerance (of type float?, which defaults to null): set phase tolerance for mono detection. (default: 0)
• t (of type float?, which defaults to null): set phase tolerance for mono detection. (default: 0)
• angle (of type float?, which defaults to null): set angle threshold for out-of-phase detection. (default: 170)
• a (of type float?, which defaults to null): set angle threshold for out-of-phase detection. (default: 170)
• duration (of type int?, which defaults to null): set minimum mono or out-of-phase duration in seconds. (default: 2)
• d (of type int?, which defaults to null): set minimum mono or out-of-phase duration in seconds. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aphaser

Ffmpeg filter: Add a phasing effect to the audio.

Type:

(?in_gain : float?, ?out_gain : float?, ?delay : float?, ?decay : float?,
 ?speed : float?, ?type : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• in_gain (of type float?, which defaults to null): set input gain. (default: 0.4)
• out_gain (of type float?, which defaults to null): set output gain. (default: 0.74)
• delay (of type float?, which defaults to null): set delay in milliseconds. (default: 3)
• decay (of type float?, which defaults to null): set decay. (default: 0.4)
• speed (of type float?, which defaults to null): set modulation speed. (default: 0.5)
• type (of type int?, which defaults to null): set modulation type. (default: 1, possible values: 1 (triangular), 1 (t), 0 (sinusoidal), 0 (s))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aphaser.create

Ffmpeg filter: Add a phasing effect to the audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?in_gain : float?, ?out_gain : float?, ?delay : float?, ?decay : float?,
 ?speed : float?, ?type : int?, ffmpeg.filter.graph) -> unit

Arguments:

• in_gain (of type float?, which defaults to null): set input gain. (default: 0.4)
• out_gain (of type float?, which defaults to null): set output gain. (default: 0.74)
• delay (of type float?, which defaults to null): set delay in milliseconds. (default: 3)
• decay (of type float?, which defaults to null): set decay. (default: 0.4)
• speed (of type float?, which defaults to null): set modulation speed. (default: 0.5)
• type (of type int?, which defaults to null): set modulation type. (default: 1, possible values: 1 (triangular), 1 (t), 0 (sinusoidal), 0 (s))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aphaseshift

Ffmpeg filter: Apply phase shifting to input audio.

Type:

(?shift : float?, ?level : float?, ?order : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• shift (of type float?, which defaults to null): set phase shift. (default: 0)
• level (of type float?, which defaults to null): set output level. (default: 1)
• order (of type int?, which defaults to null): set filter order. (default: 8)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aphaseshift.create

Ffmpeg filter: Apply phase shifting to input audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?shift : float?, ?level : float?, ?order : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• shift (of type float?, which defaults to null): set phase shift. (default: 0)
• level (of type float?, which defaults to null): set output level. (default: 1)
• order (of type int?, which defaults to null): set filter order. (default: 8)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.apsnr

Ffmpeg filter: Measure Audio Peak Signal-to-Noise Ratio.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.apsnr.create

Ffmpeg filter: Measure Audio Peak Signal-to-Noise Ratio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.apsyclip

Ffmpeg filter: Audio Psychoacoustic Clipper.

Type:

(?level_in : float?, ?level_out : float?, ?clip : float?, ?diff : bool?,
 ?adaptive : float?, ?iterations : int?, ?level : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set input level. (default: 1)
• level_out (of type float?, which defaults to null): set output level. (default: 1)
• clip (of type float?, which defaults to null): set clip level. (default: 1)
• diff (of type bool?, which defaults to null): enable difference. (default: false)
• adaptive (of type float?, which defaults to null): set adaptive distortion. (default: 0.5)
• iterations (of type int?, which defaults to null): set iterations. (default: 10)
• level (of type bool?, which defaults to null): set auto level. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.apsyclip.create

Ffmpeg filter: Audio Psychoacoustic Clipper. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?level_out : float?, ?clip : float?, ?diff : bool?,
 ?adaptive : float?, ?iterations : int?, ?level : bool?, ffmpeg.filter.graph) ->
unit

Arguments:

• level_in (of type float?, which defaults to null): set input level. (default: 1)
• level_out (of type float?, which defaults to null): set output level. (default: 1)
• clip (of type float?, which defaults to null): set clip level. (default: 1)
• diff (of type bool?, which defaults to null): enable difference. (default: false)
• adaptive (of type float?, which defaults to null): set adaptive distortion. (default: 0.5)
• iterations (of type int?, which defaults to null): set iterations. (default: 10)
• level (of type bool?, which defaults to null): set auto level. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.apulsator

Ffmpeg filter: Audio pulsator.

Type:

(?level_in : float?, ?level_out : float?, ?mode : int?, ?amount : float?,
 ?offset_l : float?, ?offset_r : float?, ?width : float?, ?timing : int?,
 ?bpm : float?, ?ms : int?, ?hz : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set input gain. (default: 1)
• level_out (of type float?, which defaults to null): set output gain. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (sine), 1 (triangle), 2 (square), 3 (sawup), 4 (sawdown))
• amount (of type float?, which defaults to null): set modulation. (default: 1)
• offset_l (of type float?, which defaults to null): set offset L. (default: 0)
• offset_r (of type float?, which defaults to null): set offset R. (default: 0.5)
• width (of type float?, which defaults to null): set pulse width. (default: 1)
• timing (of type int?, which defaults to null): set timing. (default: 2, possible values: 0 (bpm), 1 (ms), 2 (hz))
• bpm (of type float?, which defaults to null): set BPM. (default: 120)
• ms (of type int?, which defaults to null): set ms. (default: 500)
• hz (of type float?, which defaults to null): set frequency. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.apulsator.create

Ffmpeg filter: Audio pulsator. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?level_out : float?, ?mode : int?, ?amount : float?,
 ?offset_l : float?, ?offset_r : float?, ?width : float?, ?timing : int?,
 ?bpm : float?, ?ms : int?, ?hz : float?, ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set input gain. (default: 1)
• level_out (of type float?, which defaults to null): set output gain. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (sine), 1 (triangle), 2 (square), 3 (sawup), 4 (sawdown))
• amount (of type float?, which defaults to null): set modulation. (default: 1)
• offset_l (of type float?, which defaults to null): set offset L. (default: 0)
• offset_r (of type float?, which defaults to null): set offset R. (default: 0.5)
• width (of type float?, which defaults to null): set pulse width. (default: 1)
• timing (of type int?, which defaults to null): set timing. (default: 2, possible values: 0 (bpm), 1 (ms), 2 (hz))
• bpm (of type float?, which defaults to null): set BPM. (default: 120)
• ms (of type int?, which defaults to null): set ms. (default: 500)
• hz (of type float?, which defaults to null): set frequency. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.arealtime

Ffmpeg filter: Slow down filtering to match realtime.

Type:

(?limit : int?, ?speed : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• limit (of type int?, which defaults to null): sleep time limit. (default: 2)
• speed (of type float?, which defaults to null): speed factor. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.arealtime.create

Ffmpeg filter: Slow down filtering to match realtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?limit : int?, ?speed : float?, ffmpeg.filter.graph) -> unit

Arguments:

• limit (of type int?, which defaults to null): sleep time limit. (default: 2)
• speed (of type float?, which defaults to null): speed factor. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aresample

Ffmpeg filter: Resample audio data.

Type:

(?sample_rate : int?, ?isr : int?, ?in_sample_rate : int?, ?osr : int?,
 ?out_sample_rate : int?, ?isf : string?, ?in_sample_fmt : string?,
 ?osf : string?, ?out_sample_fmt : string?, ?tsf : string?,
 ?internal_sample_fmt : string?, ?ichl : string?, ?in_chlayout : string?,
 ?ochl : string?, ?out_chlayout : string?, ?uchl : string?,
 ?used_chlayout : string?, ?clev : float?, ?center_mix_level : float?,
 ?slev : float?, ?surround_mix_level : float?, ?lfe_mix_level : float?,
 ?rmvol : float?, ?rematrix_volume : float?, ?rematrix_maxval : float?,
 ?flags : int?, ?swr_flags : int?, ?dither_scale : float?,
 ?dither_method : int?, ?filter_size : int?, ?phase_shift : int?,
 ?linear_interp : bool?, ?exact_rational : bool?, ?cutoff : float?,
 ?resample_cutoff : float?, ?resampler : int?, ?precision : float?,
 ?cheby : bool?, ?min_comp : float?, ?min_hard_comp : float?,
 ?comp_duration : float?, ?max_soft_comp : float?, ?async : float?,
 ?first_pts : int?, ?matrix_encoding : int?, ?filter_type : int?,
 ?kaiser_beta : float?, ?output_sample_bits : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• sample_rate (of type int?, which defaults to null): Default: 0
• isr (of type int?, which defaults to null): set input sample rate. (default: 0)
• in_sample_rate (of type int?, which defaults to null): set input sample rate. (default: 0)
• osr (of type int?, which defaults to null): set output sample rate. (default: 0)
• out_sample_rate (of type int?, which defaults to null): set output sample rate. (default: 0)
• isf (of type string?, which defaults to null): set input sample format
• in_sample_fmt (of type string?, which defaults to null): set input sample format
• osf (of type string?, which defaults to null): set output sample format
• out_sample_fmt (of type string?, which defaults to null): set output sample format
• tsf (of type string?, which defaults to null): set internal sample format
• internal_sample_fmt (of type string?, which defaults to null): set internal sample format
• ichl (of type string?, which defaults to null): set input channel layout
• in_chlayout (of type string?, which defaults to null): set input channel layout
• ochl (of type string?, which defaults to null): set output channel layout
• out_chlayout (of type string?, which defaults to null): set output channel layout
• uchl (of type string?, which defaults to null): set used channel layout
• used_chlayout (of type string?, which defaults to null): set used channel layout
• clev (of type float?, which defaults to null): set center mix level. (default: 0.7071067811865476)
• center_mix_level (of type float?, which defaults to null): set center mix level. (default: 0.7071067811865476)
• slev (of type float?, which defaults to null): set surround mix level. (default: 0.7071067811865476)
• surround_mix_level (of type float?, which defaults to null): set surround mix Level. (default: 0.7071067811865476)
• lfe_mix_level (of type float?, which defaults to null): set LFE mix level. (default: 0)
• rmvol (of type float?, which defaults to null): set rematrix volume. (default: 1)
• rematrix_volume (of type float?, which defaults to null): set rematrix volume. (default: 1)
• rematrix_maxval (of type float?, which defaults to null): set rematrix maxval. (default: 0)
• flags (of type int?, which defaults to null): set flags. (default: 0, possible values: 1 (res), combined by addition)
• swr_flags (of type int?, which defaults to null): set flags. (default: 0, possible values: 1 (res), combined by addition)
• dither_scale (of type float?, which defaults to null): set dither scale. (default: 1)
• dither_method (of type int?, which defaults to null): set dither method. (default: 0, possible values: 1 (rectangular), 2 (triangular), 3 (triangular_hp), 65 (lipshitz), 69 (shibata), 70 (low_shibata), 71 (high_shibata), 66 (f_weighted), 67 (modified_e_weighted), 68 (improved_e_weighted))
• filter_size (of type int?, which defaults to null): set swr resampling filter size. (default: 32)
• phase_shift (of type int?, which defaults to null): set swr resampling phase shift. (default: 10)
• linear_interp (of type bool?, which defaults to null): enable linear interpolation. (default: true)
• exact_rational (of type bool?, which defaults to null): enable exact rational. (default: true)
• cutoff (of type float?, which defaults to null): set cutoff frequency ratio. (default: 0)
• resample_cutoff (of type float?, which defaults to null): set cutoff frequency ratio. (default: 0)
• resampler (of type int?, which defaults to null): set resampling Engine. (default: 0, possible values: 0 (swr), 1 (soxr))
• precision (of type float?, which defaults to null): set soxr resampling precision (in bits). (default: 20)
• cheby (of type bool?, which defaults to null): enable soxr Chebyshev passband & higher-precision irrational ratio approximation. (default: false)
• min_comp (of type float?, which defaults to null): set minimum difference between timestamps and audio data (in seconds) below which no timestamp compensation of either kind is applied. (default: 3.4028234663852886e+38)
• min_hard_comp (of type float?, which defaults to null): set minimum difference between timestamps and audio data (in seconds) to trigger padding/trimming the data.. (default: 0.1)
• comp_duration (of type float?, which defaults to null): set duration (in seconds) over which data is stretched/squeezed to make it match the timestamps.. (default: 1)
• max_soft_comp (of type float?, which defaults to null): set maximum factor by which data is stretched/squeezed to make it match the timestamps.. (default: 0)
• async (of type float?, which defaults to null): simplified 1 parameter audio timestamp matching, 0(disabled), 1(filling and trimming), >1(maximum stretch/squeeze in samples per second). (default: 0)
• first_pts (of type int?, which defaults to null): Assume the first pts should be this value (in samples).. (default: -9223372036854775808)
• matrix_encoding (of type int?, which defaults to null): set matrixed stereo encoding. (default: 0, possible values: 0 (none), 1 (dolby), 2 (dplii))
• filter_type (of type int?, which defaults to null): select swr filter type. (default: 2, possible values: 0 (cubic), 1 (blackman_nuttall), 2 (kaiser))
• kaiser_beta (of type float?, which defaults to null): set swr Kaiser window beta. (default: 9)
• output_sample_bits (of type int?, which defaults to null): set swr number of output sample bits. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aresample.create

Ffmpeg filter: Resample audio data. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sample_rate : int?, ?isr : int?, ?in_sample_rate : int?, ?osr : int?,
 ?out_sample_rate : int?, ?isf : string?, ?in_sample_fmt : string?,
 ?osf : string?, ?out_sample_fmt : string?, ?tsf : string?,
 ?internal_sample_fmt : string?, ?ichl : string?, ?in_chlayout : string?,
 ?ochl : string?, ?out_chlayout : string?, ?uchl : string?,
 ?used_chlayout : string?, ?clev : float?, ?center_mix_level : float?,
 ?slev : float?, ?surround_mix_level : float?, ?lfe_mix_level : float?,
 ?rmvol : float?, ?rematrix_volume : float?, ?rematrix_maxval : float?,
 ?flags : int?, ?swr_flags : int?, ?dither_scale : float?,
 ?dither_method : int?, ?filter_size : int?, ?phase_shift : int?,
 ?linear_interp : bool?, ?exact_rational : bool?, ?cutoff : float?,
 ?resample_cutoff : float?, ?resampler : int?, ?precision : float?,
 ?cheby : bool?, ?min_comp : float?, ?min_hard_comp : float?,
 ?comp_duration : float?, ?max_soft_comp : float?, ?async : float?,
 ?first_pts : int?, ?matrix_encoding : int?, ?filter_type : int?,
 ?kaiser_beta : float?, ?output_sample_bits : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• sample_rate (of type int?, which defaults to null): Default: 0
• isr (of type int?, which defaults to null): set input sample rate. (default: 0)
• in_sample_rate (of type int?, which defaults to null): set input sample rate. (default: 0)
• osr (of type int?, which defaults to null): set output sample rate. (default: 0)
• out_sample_rate (of type int?, which defaults to null): set output sample rate. (default: 0)
• isf (of type string?, which defaults to null): set input sample format
• in_sample_fmt (of type string?, which defaults to null): set input sample format
• osf (of type string?, which defaults to null): set output sample format
• out_sample_fmt (of type string?, which defaults to null): set output sample format
• tsf (of type string?, which defaults to null): set internal sample format
• internal_sample_fmt (of type string?, which defaults to null): set internal sample format
• ichl (of type string?, which defaults to null): set input channel layout
• in_chlayout (of type string?, which defaults to null): set input channel layout
• ochl (of type string?, which defaults to null): set output channel layout
• out_chlayout (of type string?, which defaults to null): set output channel layout
• uchl (of type string?, which defaults to null): set used channel layout
• used_chlayout (of type string?, which defaults to null): set used channel layout
• clev (of type float?, which defaults to null): set center mix level. (default: 0.7071067811865476)
• center_mix_level (of type float?, which defaults to null): set center mix level. (default: 0.7071067811865476)
• slev (of type float?, which defaults to null): set surround mix level. (default: 0.7071067811865476)
• surround_mix_level (of type float?, which defaults to null): set surround mix Level. (default: 0.7071067811865476)
• lfe_mix_level (of type float?, which defaults to null): set LFE mix level. (default: 0)
• rmvol (of type float?, which defaults to null): set rematrix volume. (default: 1)
• rematrix_volume (of type float?, which defaults to null): set rematrix volume. (default: 1)
• rematrix_maxval (of type float?, which defaults to null): set rematrix maxval. (default: 0)
• flags (of type int?, which defaults to null): set flags. (default: 0, possible values: 1 (res), combined by addition)
• swr_flags (of type int?, which defaults to null): set flags. (default: 0, possible values: 1 (res), combined by addition)
• dither_scale (of type float?, which defaults to null): set dither scale. (default: 1)
• dither_method (of type int?, which defaults to null): set dither method. (default: 0, possible values: 1 (rectangular), 2 (triangular), 3 (triangular_hp), 65 (lipshitz), 69 (shibata), 70 (low_shibata), 71 (high_shibata), 66 (f_weighted), 67 (modified_e_weighted), 68 (improved_e_weighted))
• filter_size (of type int?, which defaults to null): set swr resampling filter size. (default: 32)
• phase_shift (of type int?, which defaults to null): set swr resampling phase shift. (default: 10)
• linear_interp (of type bool?, which defaults to null): enable linear interpolation. (default: true)
• exact_rational (of type bool?, which defaults to null): enable exact rational. (default: true)
• cutoff (of type float?, which defaults to null): set cutoff frequency ratio. (default: 0)
• resample_cutoff (of type float?, which defaults to null): set cutoff frequency ratio. (default: 0)
• resampler (of type int?, which defaults to null): set resampling Engine. (default: 0, possible values: 0 (swr), 1 (soxr))
• precision (of type float?, which defaults to null): set soxr resampling precision (in bits). (default: 20)
• cheby (of type bool?, which defaults to null): enable soxr Chebyshev passband & higher-precision irrational ratio approximation. (default: false)
• min_comp (of type float?, which defaults to null): set minimum difference between timestamps and audio data (in seconds) below which no timestamp compensation of either kind is applied. (default: 3.4028234663852886e+38)
• min_hard_comp (of type float?, which defaults to null): set minimum difference between timestamps and audio data (in seconds) to trigger padding/trimming the data.. (default: 0.1)
• comp_duration (of type float?, which defaults to null): set duration (in seconds) over which data is stretched/squeezed to make it match the timestamps.. (default: 1)
• max_soft_comp (of type float?, which defaults to null): set maximum factor by which data is stretched/squeezed to make it match the timestamps.. (default: 0)
• async (of type float?, which defaults to null): simplified 1 parameter audio timestamp matching, 0(disabled), 1(filling and trimming), >1(maximum stretch/squeeze in samples per second). (default: 0)
• first_pts (of type int?, which defaults to null): Assume the first pts should be this value (in samples).. (default: -9223372036854775808)
• matrix_encoding (of type int?, which defaults to null): set matrixed stereo encoding. (default: 0, possible values: 0 (none), 1 (dolby), 2 (dplii))
• filter_type (of type int?, which defaults to null): select swr filter type. (default: 2, possible values: 0 (cubic), 1 (blackman_nuttall), 2 (kaiser))
• kaiser_beta (of type float?, which defaults to null): set swr Kaiser window beta. (default: 9)
• output_sample_bits (of type int?, which defaults to null): set swr number of output sample bits. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.areverse

Ffmpeg filter: Reverse an audio clip.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.areverse.create

Ffmpeg filter: Reverse an audio clip. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.arls

Ffmpeg filter: Apply Recursive Least Squares algorithm to first audio stream.

Type:

(?order : int?, ?lambda : float?, ?delta : float?, ?out_mode : int?,
 ?precision : int?, ffmpeg.filter.graph, ffmpeg.filter.audio,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• order (of type int?, which defaults to null): set the filter order. (default: 16)
• lambda (of type float?, which defaults to null): set the filter lambda. (default: 1)
• delta (of type float?, which defaults to null): set the filter delta. (default: 2)
• out_mode (of type int?, which defaults to null): set output mode. (default: 2, possible values: 0 (i), 1 (d), 2 (o), 3 (n), 4 (e))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.arls.create

Ffmpeg filter: Apply Recursive Least Squares algorithm to first audio stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?order : int?, ?lambda : float?, ?delta : float?, ?out_mode : int?,
 ?precision : int?, ffmpeg.filter.graph) -> unit

Arguments:

• order (of type int?, which defaults to null): set the filter order. (default: 16)
• lambda (of type float?, which defaults to null): set the filter lambda. (default: 1)
• delta (of type float?, which defaults to null): set the filter delta. (default: 2)
• out_mode (of type int?, which defaults to null): set output mode. (default: 2, possible values: 0 (i), 1 (d), 2 (o), 3 (n), 4 (e))
• precision (of type int?, which defaults to null): set processing precision. (default: 0, possible values: 0 (auto), 1 (float), 2 (double))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.arnndn

Ffmpeg filter: Reduce noise from speech using Recurrent Neural Networks.

Type:

(?model : string?, ?m : string?, ?mix : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• model (of type string?, which defaults to null): set model name
• m (of type string?, which defaults to null): set model name
• mix (of type float?, which defaults to null): set output vs input mix. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.arnndn.create

Ffmpeg filter: Reduce noise from speech using Recurrent Neural Networks. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?model : string?, ?m : string?, ?mix : float?, ffmpeg.filter.graph) -> unit

Arguments:

• model (of type string?, which defaults to null): set model name
• m (of type string?, which defaults to null): set model name
• mix (of type float?, which defaults to null): set output vs input mix. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asdr

Ffmpeg filter: Measure Audio Signal-to-Distortion Ratio.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asdr.create

Ffmpeg filter: Measure Audio Signal-to-Distortion Ratio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asegment

Ffmpeg filter: Segment audio stream. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?timestamps : string?, ?samples : string?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> [ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• timestamps (of type string?, which defaults to null): timestamps of input at which to split input
• samples (of type string?, which defaults to null): samples at which to split input
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asegment.create

Ffmpeg filter: Segment audio stream. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?timestamps : string?, ?samples : string?, ffmpeg.filter.graph) -> unit

Arguments:

• timestamps (of type string?, which defaults to null): timestamps of input at which to split input
• samples (of type string?, which defaults to null): samples at which to split input
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aselect

Ffmpeg filter: Select audio frames to pass in output. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?expr : string?, ?e : string?, ?outputs : int?, ?n : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• expr (of type string?, which defaults to null): set an expression to use for selecting frames. (default: 1)
• e (of type string?, which defaults to null): set an expression to use for selecting frames. (default: 1)
• outputs (of type int?, which defaults to null): set the number of outputs. (default: 1)
• n (of type int?, which defaults to null): set the number of outputs. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aselect.create

Ffmpeg filter: Select audio frames to pass in output. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?expr : string?, ?e : string?, ?outputs : int?, ?n : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• expr (of type string?, which defaults to null): set an expression to use for selecting frames. (default: 1)
• e (of type string?, which defaults to null): set an expression to use for selecting frames. (default: 1)
• outputs (of type int?, which defaults to null): set the number of outputs. (default: 1)
• n (of type int?, which defaults to null): set the number of outputs. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asendcmd

Ffmpeg filter: Send commands to filters.

Type:

(?commands : string?, ?c : string?, ?filename : string?, ?f : string?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• commands (of type string?, which defaults to null): set commands
• c (of type string?, which defaults to null): set commands
• filename (of type string?, which defaults to null): set commands file
• f (of type string?, which defaults to null): set commands file
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asendcmd.create

Ffmpeg filter: Send commands to filters. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?commands : string?, ?c : string?, ?filename : string?, ?f : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• commands (of type string?, which defaults to null): set commands
• c (of type string?, which defaults to null): set commands
• filename (of type string?, which defaults to null): set commands file
• f (of type string?, which defaults to null): set commands file
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asetnsamples

Ffmpeg filter: Set the number of samples for each output audio frames.

Type:

(?nb_out_samples : int?, ?n : int?, ?pad : bool?, ?p : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• nb_out_samples (of type int?, which defaults to null): set the number of per-frame output samples. (default: 1024)
• n (of type int?, which defaults to null): set the number of per-frame output samples. (default: 1024)
• pad (of type bool?, which defaults to null): pad last frame with zeros. (default: true)
• p (of type bool?, which defaults to null): pad last frame with zeros. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asetnsamples.create

Ffmpeg filter: Set the number of samples for each output audio frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?nb_out_samples : int?, ?n : int?, ?pad : bool?, ?p : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• nb_out_samples (of type int?, which defaults to null): set the number of per-frame output samples. (default: 1024)
• n (of type int?, which defaults to null): set the number of per-frame output samples. (default: 1024)
• pad (of type bool?, which defaults to null): pad last frame with zeros. (default: true)
• p (of type bool?, which defaults to null): pad last frame with zeros. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asetpts

Ffmpeg filter: Set PTS for the output audio frame.

Type:

(?expr : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• expr (of type string?, which defaults to null): Expression determining the frame timestamp. (default: PTS)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asetpts.create

Ffmpeg filter: Set PTS for the output audio frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?expr : string?, ffmpeg.filter.graph) -> unit

Arguments:

• expr (of type string?, which defaults to null): Expression determining the frame timestamp. (default: PTS)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asetrate

Ffmpeg filter: Change the sample rate without altering the data.

Type:

(?sample_rate : int?, ?r : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• sample_rate (of type int?, which defaults to null): set the sample rate. (default: 44100)
• r (of type int?, which defaults to null): set the sample rate. (default: 44100)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asetrate.create

Ffmpeg filter: Change the sample rate without altering the data. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sample_rate : int?, ?r : int?, ffmpeg.filter.graph) -> unit

Arguments:

• sample_rate (of type int?, which defaults to null): set the sample rate. (default: 44100)
• r (of type int?, which defaults to null): set the sample rate. (default: 44100)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asettb

Ffmpeg filter: Set timebase for the audio output link.

Type:

(?expr : string?, ?tb : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• expr (of type string?, which defaults to null): set expression determining the output timebase. (default: intb)
• tb (of type string?, which defaults to null): set expression determining the output timebase. (default: intb)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asettb.create

Ffmpeg filter: Set timebase for the audio output link. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?expr : string?, ?tb : string?, ffmpeg.filter.graph) -> unit

Arguments:

• expr (of type string?, which defaults to null): set expression determining the output timebase. (default: intb)
• tb (of type string?, which defaults to null): set expression determining the output timebase. (default: intb)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ashowinfo

Ffmpeg filter: Show textual information for each audio frame.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.ashowinfo.create

Ffmpeg filter: Show textual information for each audio frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asidedata

Ffmpeg filter: Manipulate audio frame side data.

Type:

(?mode : int?, ?type : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• mode (of type int?, which defaults to null): set a mode of operation. (default: 0, possible values: 0 (select), 1 (delete))
• type (of type int?, which defaults to null): set side data type. (default: -1, possible values: 0 (PANSCAN), 1 (A53_CC), 2 (STEREO3D), 3 (MATRIXENCODING), 4 (DOWNMIX_INFO), 5 (REPLAYGAIN), 6 (DISPLAYMATRIX), 7 (AFD), 8 (MOTION_VECTORS), 9 (SKIP_SAMPLES), 10 (AUDIO_SERVICE_TYPE), 11 (MASTERING_DISPLAY_METADATA), 12 (GOP_TIMECODE), 13 (SPHERICAL), 14 (CONTENT_LIGHT_LEVEL), 15 (ICC_PROFILE), 16 (S12M_TIMECOD), 16 (S12M_TIMECODE), 17 (DYNAMIC_HDR_PLUS), 18 (REGIONS_OF_INTEREST), 19 (VIDEO_ENC_PARAMS), 20 (SEI_UNREGISTERED), 21 (FILM_GRAIN_PARAMS), 22 (DETECTION_BOUNDING_BOXES), 22 (DETECTION_BBOXES), 23 (DOVI_RPU_BUFFER), 24 (DOVI_METADATA), 25 (DYNAMIC_HDR_VIVID), 26 (AMBIENT_VIEWING_ENVIRONMENT), 27 (VIDEO_HINT))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asidedata.create

Ffmpeg filter: Manipulate audio frame side data. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?type : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set a mode of operation. (default: 0, possible values: 0 (select), 1 (delete))
• type (of type int?, which defaults to null): set side data type. (default: -1, possible values: 0 (PANSCAN), 1 (A53_CC), 2 (STEREO3D), 3 (MATRIXENCODING), 4 (DOWNMIX_INFO), 5 (REPLAYGAIN), 6 (DISPLAYMATRIX), 7 (AFD), 8 (MOTION_VECTORS), 9 (SKIP_SAMPLES), 10 (AUDIO_SERVICE_TYPE), 11 (MASTERING_DISPLAY_METADATA), 12 (GOP_TIMECODE), 13 (SPHERICAL), 14 (CONTENT_LIGHT_LEVEL), 15 (ICC_PROFILE), 16 (S12M_TIMECOD), 16 (S12M_TIMECODE), 17 (DYNAMIC_HDR_PLUS), 18 (REGIONS_OF_INTEREST), 19 (VIDEO_ENC_PARAMS), 20 (SEI_UNREGISTERED), 21 (FILM_GRAIN_PARAMS), 22 (DETECTION_BOUNDING_BOXES), 22 (DETECTION_BBOXES), 23 (DOVI_RPU_BUFFER), 24 (DOVI_METADATA), 25 (DYNAMIC_HDR_VIVID), 26 (AMBIENT_VIEWING_ENVIRONMENT), 27 (VIDEO_HINT))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asisdr

Ffmpeg filter: Measure Audio Scale-Invariant Signal-to-Distortion Ratio.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asisdr.create

Ffmpeg filter: Measure Audio Scale-Invariant Signal-to-Distortion Ratio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asoftclip

Ffmpeg filter: Audio Soft Clipper.

Type:

(?type : int?, ?threshold : float?, ?output : float?, ?param : float?,
 ?oversample : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• type (of type int?, which defaults to null): set softclip type. (default: 0, possible values: -1 (hard), 0 (tanh), 1 (atan), 2 (cubic), 3 (exp), 4 (alg), 5 (quintic), 6 (sin), 7 (erf))
• threshold (of type float?, which defaults to null): set softclip threshold. (default: 1)
• output (of type float?, which defaults to null): set softclip output gain. (default: 1)
• param (of type float?, which defaults to null): set softclip parameter. (default: 1)
• oversample (of type int?, which defaults to null): set oversample factor. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asoftclip.create

Ffmpeg filter: Audio Soft Clipper. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?type : int?, ?threshold : float?, ?output : float?, ?param : float?,
 ?oversample : int?, ffmpeg.filter.graph) -> unit

Arguments:

• type (of type int?, which defaults to null): set softclip type. (default: 0, possible values: -1 (hard), 0 (tanh), 1 (atan), 2 (cubic), 3 (exp), 4 (alg), 5 (quintic), 6 (sin), 7 (erf))
• threshold (of type float?, which defaults to null): set softclip threshold. (default: 1)
• output (of type float?, which defaults to null): set softclip output gain. (default: 1)
• param (of type float?, which defaults to null): set softclip parameter. (default: 1)
• oversample (of type int?, which defaults to null): set oversample factor. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.aspectralstats

Ffmpeg filter: Show frequency domain statistics about audio frames.

Type:

(?win_size : int?, ?win_func : int?, ?overlap : float?, ?measure : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• win_size (of type int?, which defaults to null): set the window size. (default: 2048)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 0.5)
• measure (of type int?, which defaults to null): select the parameters which are measured. (default: 4294967295, possible values: 0 (none), 4294967295 (all), 1 (mean), 2 (variance), 4 (centroid), 8 (spread), 16 (skewness), 32 (kurtosis), 64 (entropy), 128 (flatness), 256 (crest), 512 (flux), 1024 (slope), 2048 (decrease), 4096 (rolloff), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.aspectralstats.create

Ffmpeg filter: Show frequency domain statistics about audio frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?win_size : int?, ?win_func : int?, ?overlap : float?, ?measure : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• win_size (of type int?, which defaults to null): set the window size. (default: 2048)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 0.5)
• measure (of type int?, which defaults to null): select the parameters which are measured. (default: 4294967295, possible values: 0 (none), 4294967295 (all), 1 (mean), 2 (variance), 4 (centroid), 8 (spread), 16 (skewness), 32 (kurtosis), 64 (entropy), 128 (flatness), 256 (crest), 512 (flux), 1024 (slope), 2048 (decrease), 4096 (rolloff), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asplit

Ffmpeg filter: Pass on the audio input to N audio outputs. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?outputs : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• outputs (of type int?, which defaults to null): set number of outputs. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asplit.create

Ffmpeg filter: Pass on the audio input to N audio outputs. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?outputs : int?, ffmpeg.filter.graph) -> unit

Arguments:

• outputs (of type int?, which defaults to null): set number of outputs. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ass

Ffmpeg filter: Render ASS subtitles onto input video using the libass library.

Type:

(?filename : string?, ?f : string?, ?original_size : string?,
 ?fontsdir : string?, ?alpha : bool?, ?shaping : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• filename (of type string?, which defaults to null): set the filename of file to read
• f (of type string?, which defaults to null): set the filename of file to read
• original_size (of type string?, which defaults to null): set the size of the original video (used to scale fonts)
• fontsdir (of type string?, which defaults to null): set the directory containing the fonts to read
• alpha (of type bool?, which defaults to null): enable processing of alpha channel. (default: false)
• shaping (of type int?, which defaults to null): set shaping engine. (default: -1, possible values: -1 (auto), 0 (simple), 1 (complex))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.ass.create

Ffmpeg filter: Render ASS subtitles onto input video using the libass library. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filename : string?, ?f : string?, ?original_size : string?,
 ?fontsdir : string?, ?alpha : bool?, ?shaping : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• filename (of type string?, which defaults to null): set the filename of file to read
• f (of type string?, which defaults to null): set the filename of file to read
• original_size (of type string?, which defaults to null): set the size of the original video (used to scale fonts)
• fontsdir (of type string?, which defaults to null): set the directory containing the fonts to read
• alpha (of type bool?, which defaults to null): enable processing of alpha channel. (default: false)
• shaping (of type int?, which defaults to null): set shaping engine. (default: -1, possible values: -1 (auto), 0 (simple), 1 (complex))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.astats

Ffmpeg filter: Show time domain statistics about audio frames.

Type:

(?length : float?, ?metadata : bool?, ?reset : int?,
 ?measure_perchannel : int?, ?measure_overall : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• length (of type float?, which defaults to null): set the window length. (default: 0.05)
• metadata (of type bool?, which defaults to null): inject metadata in the filtergraph. (default: false)
• reset (of type int?, which defaults to null): Set the number of frames over which cumulative stats are calculated before being reset. (default: 0)
• measure_perchannel (of type int?, which defaults to null): Select the parameters which are measured per channel. (default: 4294967295, possible values: 0 (none), 4294967295 (all), 16384 (Bit_depth), 2048 (Crest_factor), 1 (DC_offset), 32768 (Dynamic_range), 16777216 (Entropy), 4096 (Flat_factor), 16 (Max_difference), 4 (Max_level), 32 (Mean_difference), 8 (Min_difference), 2 (Min_level), 4194304 (Noise_floor), 8388608 (Noise_floor_count), 1048576 (Number_of_Infs), 524288 (Number_of_NaNs), 2097152 (Number_of_denormals), 262144 (Number_of_samples), 8192 (Peak_count), 128 (Peak_level), 64 (RMS_difference), 256 (RMS_level), 512 (RMS_peak), 1024 (RMS_trough), 65536 (Zero_crossings), 131072 (Zero_crossings_rate), 33554432 (Abs_Peak_count), combined by addition)
• measure_overall (of type int?, which defaults to null): Select the parameters which are measured overall. (default: 4294967295, possible values: 0 (none), 4294967295 (all), 16384 (Bit_depth), 2048 (Crest_factor), 1 (DC_offset), 32768 (Dynamic_range), 16777216 (Entropy), 4096 (Flat_factor), 16 (Max_difference), 4 (Max_level), 32 (Mean_difference), 8 (Min_difference), 2 (Min_level), 4194304 (Noise_floor), 8388608 (Noise_floor_count), 1048576 (Number_of_Infs), 524288 (Number_of_NaNs), 2097152 (Number_of_denormals), 262144 (Number_of_samples), 8192 (Peak_count), 128 (Peak_level), 64 (RMS_difference), 256 (RMS_level), 512 (RMS_peak), 1024 (RMS_trough), 65536 (Zero_crossings), 131072 (Zero_crossings_rate), 33554432 (Abs_Peak_count), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.astats.create

Ffmpeg filter: Show time domain statistics about audio frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?length : float?, ?metadata : bool?, ?reset : int?,
 ?measure_perchannel : int?, ?measure_overall : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• length (of type float?, which defaults to null): set the window length. (default: 0.05)
• metadata (of type bool?, which defaults to null): inject metadata in the filtergraph. (default: false)
• reset (of type int?, which defaults to null): Set the number of frames over which cumulative stats are calculated before being reset. (default: 0)
• measure_perchannel (of type int?, which defaults to null): Select the parameters which are measured per channel. (default: 4294967295, possible values: 0 (none), 4294967295 (all), 16384 (Bit_depth), 2048 (Crest_factor), 1 (DC_offset), 32768 (Dynamic_range), 16777216 (Entropy), 4096 (Flat_factor), 16 (Max_difference), 4 (Max_level), 32 (Mean_difference), 8 (Min_difference), 2 (Min_level), 4194304 (Noise_floor), 8388608 (Noise_floor_count), 1048576 (Number_of_Infs), 524288 (Number_of_NaNs), 2097152 (Number_of_denormals), 262144 (Number_of_samples), 8192 (Peak_count), 128 (Peak_level), 64 (RMS_difference), 256 (RMS_level), 512 (RMS_peak), 1024 (RMS_trough), 65536 (Zero_crossings), 131072 (Zero_crossings_rate), 33554432 (Abs_Peak_count), combined by addition)
• measure_overall (of type int?, which defaults to null): Select the parameters which are measured overall. (default: 4294967295, possible values: 0 (none), 4294967295 (all), 16384 (Bit_depth), 2048 (Crest_factor), 1 (DC_offset), 32768 (Dynamic_range), 16777216 (Entropy), 4096 (Flat_factor), 16 (Max_difference), 4 (Max_level), 32 (Mean_difference), 8 (Min_difference), 2 (Min_level), 4194304 (Noise_floor), 8388608 (Noise_floor_count), 1048576 (Number_of_Infs), 524288 (Number_of_NaNs), 2097152 (Number_of_denormals), 262144 (Number_of_samples), 8192 (Peak_count), 128 (Peak_level), 64 (RMS_difference), 256 (RMS_level), 512 (RMS_peak), 1024 (RMS_trough), 65536 (Zero_crossings), 131072 (Zero_crossings_rate), 33554432 (Abs_Peak_count), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.astreamselect

Ffmpeg filter: Select audio streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?inputs : int?, ?map : string?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> [ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• inputs (of type int?, which defaults to null): number of input streams. (default: 2)
• map (of type string?, which defaults to null): input indexes to remap to outputs
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.astreamselect.create

Ffmpeg filter: Select audio streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?map : string?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): number of input streams. (default: 2)
• map (of type string?, which defaults to null): input indexes to remap to outputs
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asubboost

Ffmpeg filter: Boost subwoofer frequencies.

Type:

(?dry : float?, ?wet : float?, ?boost : float?, ?decay : float?,
 ?feedback : float?, ?cutoff : float?, ?slope : float?, ?delay : float?,
 ?channels : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• dry (of type float?, which defaults to null): set dry gain. (default: 1)
• wet (of type float?, which defaults to null): set wet gain. (default: 1)
• boost (of type float?, which defaults to null): set max boost. (default: 2)
• decay (of type float?, which defaults to null): set decay. (default: 0)
• feedback (of type float?, which defaults to null): set feedback. (default: 0.9)
• cutoff (of type float?, which defaults to null): set cutoff. (default: 100)
• slope (of type float?, which defaults to null): set slope. (default: 0.5)
• delay (of type float?, which defaults to null): set delay. (default: 20)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asubboost.create

Ffmpeg filter: Boost subwoofer frequencies. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?dry : float?, ?wet : float?, ?boost : float?, ?decay : float?,
 ?feedback : float?, ?cutoff : float?, ?slope : float?, ?delay : float?,
 ?channels : string?, ffmpeg.filter.graph) -> unit

Arguments:

• dry (of type float?, which defaults to null): set dry gain. (default: 1)
• wet (of type float?, which defaults to null): set wet gain. (default: 1)
• boost (of type float?, which defaults to null): set max boost. (default: 2)
• decay (of type float?, which defaults to null): set decay. (default: 0)
• feedback (of type float?, which defaults to null): set feedback. (default: 0.9)
• cutoff (of type float?, which defaults to null): set cutoff. (default: 100)
• slope (of type float?, which defaults to null): set slope. (default: 0.5)
• delay (of type float?, which defaults to null): set delay. (default: 20)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asubcut

Ffmpeg filter: Cut subwoofer frequencies.

Type:

(?cutoff : float?, ?order : int?, ?level : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• cutoff (of type float?, which defaults to null): set cutoff frequency. (default: 20)
• order (of type int?, which defaults to null): set filter order. (default: 10)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asubcut.create

Ffmpeg filter: Cut subwoofer frequencies. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cutoff : float?, ?order : int?, ?level : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• cutoff (of type float?, which defaults to null): set cutoff frequency. (default: 20)
• order (of type int?, which defaults to null): set filter order. (default: 10)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asupercut

Ffmpeg filter: Cut super frequencies.

Type:

(?cutoff : float?, ?order : int?, ?level : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• cutoff (of type float?, which defaults to null): set cutoff frequency. (default: 20000)
• order (of type int?, which defaults to null): set filter order. (default: 10)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asupercut.create

Ffmpeg filter: Cut super frequencies. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cutoff : float?, ?order : int?, ?level : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• cutoff (of type float?, which defaults to null): set cutoff frequency. (default: 20000)
• order (of type int?, which defaults to null): set filter order. (default: 10)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asuperpass

Ffmpeg filter: Apply high order Butterworth band-pass filter.

Type:

(?centerf : float?, ?order : int?, ?qfactor : float?, ?level : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• centerf (of type float?, which defaults to null): set center frequency. (default: 1000)
• order (of type int?, which defaults to null): set filter order. (default: 4)
• qfactor (of type float?, which defaults to null): set Q-factor. (default: 1)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asuperpass.create

Ffmpeg filter: Apply high order Butterworth band-pass filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?centerf : float?, ?order : int?, ?qfactor : float?, ?level : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• centerf (of type float?, which defaults to null): set center frequency. (default: 1000)
• order (of type int?, which defaults to null): set filter order. (default: 4)
• qfactor (of type float?, which defaults to null): set Q-factor. (default: 1)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.asuperstop

Ffmpeg filter: Apply high order Butterworth band-stop filter.

Type:

(?centerf : float?, ?order : int?, ?qfactor : float?, ?level : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• centerf (of type float?, which defaults to null): set center frequency. (default: 1000)
• order (of type int?, which defaults to null): set filter order. (default: 4)
• qfactor (of type float?, which defaults to null): set Q-factor. (default: 1)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asuperstop.create

Ffmpeg filter: Apply high order Butterworth band-stop filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?centerf : float?, ?order : int?, ?qfactor : float?, ?level : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• centerf (of type float?, which defaults to null): set center frequency. (default: 1000)
• order (of type int?, which defaults to null): set filter order. (default: 4)
• qfactor (of type float?, which defaults to null): set Q-factor. (default: 1)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.atadenoise

Ffmpeg filter: Apply an Adaptive Temporal Averaging Denoiser.

Type:

(?0a : float?, ?0b : float?, ?1a : float?, ?1b : float?, ?2a : float?,
 ?2b : float?, ?s : int?, ?p : int?, ?a : int?, ?0s : float?, ?1s : float?,
 ?2s : float?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• 0a (of type float?, which defaults to null): set threshold A for 1st plane. (default: 0.02)
• 0b (of type float?, which defaults to null): set threshold B for 1st plane. (default: 0.04)
• 1a (of type float?, which defaults to null): set threshold A for 2nd plane. (default: 0.02)
• 1b (of type float?, which defaults to null): set threshold B for 2nd plane. (default: 0.04)
• 2a (of type float?, which defaults to null): set threshold A for 3rd plane. (default: 0.02)
• 2b (of type float?, which defaults to null): set threshold B for 3rd plane. (default: 0.04)
• s (of type int?, which defaults to null): set how many frames to use. (default: 9)
• p (of type int?, which defaults to null): set what planes to filter. (default: 7)
• a (of type int?, which defaults to null): set variant of algorithm. (default: 0, possible values: 0 (p), 1 (s))
• 0s (of type float?, which defaults to null): set sigma for 1st plane. (default: 32767)
• 1s (of type float?, which defaults to null): set sigma for 2nd plane. (default: 32767)
• 2s (of type float?, which defaults to null): set sigma for 3rd plane. (default: 32767)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.atadenoise.create

Ffmpeg filter: Apply an Adaptive Temporal Averaging Denoiser. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?0a : float?, ?0b : float?, ?1a : float?, ?1b : float?, ?2a : float?,
 ?2b : float?, ?s : int?, ?p : int?, ?a : int?, ?0s : float?, ?1s : float?,
 ?2s : float?, ffmpeg.filter.graph) -> unit

Arguments:

• 0a (of type float?, which defaults to null): set threshold A for 1st plane. (default: 0.02)
• 0b (of type float?, which defaults to null): set threshold B for 1st plane. (default: 0.04)
• 1a (of type float?, which defaults to null): set threshold A for 2nd plane. (default: 0.02)
• 1b (of type float?, which defaults to null): set threshold B for 2nd plane. (default: 0.04)
• 2a (of type float?, which defaults to null): set threshold A for 3rd plane. (default: 0.02)
• 2b (of type float?, which defaults to null): set threshold B for 3rd plane. (default: 0.04)
• s (of type int?, which defaults to null): set how many frames to use. (default: 9)
• p (of type int?, which defaults to null): set what planes to filter. (default: 7)
• a (of type int?, which defaults to null): set variant of algorithm. (default: 0, possible values: 0 (p), 1 (s))
• 0s (of type float?, which defaults to null): set sigma for 1st plane. (default: 32767)
• 1s (of type float?, which defaults to null): set sigma for 2nd plane. (default: 32767)
• 2s (of type float?, which defaults to null): set sigma for 3rd plane. (default: 32767)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.atempo

Ffmpeg filter: Adjust audio tempo.

Type:

(?tempo : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• tempo (of type float?, which defaults to null): set tempo scale factor. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.atempo.create

Ffmpeg filter: Adjust audio tempo. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?tempo : float?, ffmpeg.filter.graph) -> unit

Arguments:

• tempo (of type float?, which defaults to null): set tempo scale factor. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.atilt

Ffmpeg filter: Apply spectral tilt to audio.

Type:

(?freq : float?, ?slope : float?, ?width : float?, ?order : int?,
 ?level : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• freq (of type float?, which defaults to null): set central frequency. (default: 10000)
• slope (of type float?, which defaults to null): set filter slope. (default: 0)
• width (of type float?, which defaults to null): set filter width. (default: 1000)
• order (of type int?, which defaults to null): set filter order. (default: 5)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.atilt.create

Ffmpeg filter: Apply spectral tilt to audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?freq : float?, ?slope : float?, ?width : float?, ?order : int?,
 ?level : float?, ffmpeg.filter.graph) -> unit

Arguments:

• freq (of type float?, which defaults to null): set central frequency. (default: 10000)
• slope (of type float?, which defaults to null): set filter slope. (default: 0)
• width (of type float?, which defaults to null): set filter width. (default: 1000)
• order (of type int?, which defaults to null): set filter order. (default: 5)
• level (of type float?, which defaults to null): set input level. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.atrim

Ffmpeg filter: Pick one continuous section from the input, drop the rest.

Type:

(?start : int?, ?starti : int?, ?end : int?, ?endi : int?, ?start_pts : int?,
 ?end_pts : int?, ?duration : int?, ?durationi : int?, ?start_sample : int?,
 ?end_sample : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• start (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854.775)
• starti (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854.775)
• end (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854.775)
• endi (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854.775)
• start_pts (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: -9223372036854775808)
• end_pts (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: -9223372036854775808)
• duration (of type int?, which defaults to null): Maximum duration of the output. (default: 0)
• durationi (of type int?, which defaults to null): Maximum duration of the output. (default: 0)
• start_sample (of type int?, which defaults to null): Number of the first audio sample that should be passed to the output. (default: -1)
• end_sample (of type int?, which defaults to null): Number of the first audio sample that should be dropped again. (default: 9223372036854775807)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.atrim.create

Ffmpeg filter: Pick one continuous section from the input, drop the rest. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?start : int?, ?starti : int?, ?end : int?, ?endi : int?, ?start_pts : int?,
 ?end_pts : int?, ?duration : int?, ?durationi : int?, ?start_sample : int?,
 ?end_sample : int?, ffmpeg.filter.graph) -> unit

Arguments:

• start (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854.775)
• starti (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854.775)
• end (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854.775)
• endi (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854.775)
• start_pts (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: -9223372036854775808)
• end_pts (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: -9223372036854775808)
• duration (of type int?, which defaults to null): Maximum duration of the output. (default: 0)
• durationi (of type int?, which defaults to null): Maximum duration of the output. (default: 0)
• start_sample (of type int?, which defaults to null): Number of the first audio sample that should be passed to the output. (default: -1)
• end_sample (of type int?, which defaults to null): Number of the first audio sample that should be dropped again. (default: 9223372036854775807)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.avectorscope

Ffmpeg filter: Convert input audio to vectorscope video output.

Type:

(?mode : int?, ?m : int?, ?rate : string?, ?r : string?, ?size : string?,
 ?s : string?, ?rc : int?, ?gc : int?, ?bc : int?, ?ac : int?, ?rf : int?,
 ?gf : int?, ?bf : int?, ?af : int?, ?zoom : float?, ?draw : int?,
 ?scale : int?, ?swap : bool?, ?mirror : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (lissajous), 1 (lissajous_xy), 2 (polar))
• m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (lissajous), 1 (lissajous_xy), 2 (polar))
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: 400x400)
• s (of type string?, which defaults to null): set video size. (default: 400x400)
• rc (of type int?, which defaults to null): set red contrast. (default: 40)
• gc (of type int?, which defaults to null): set green contrast. (default: 160)
• bc (of type int?, which defaults to null): set blue contrast. (default: 80)
• ac (of type int?, which defaults to null): set alpha contrast. (default: 255)
• rf (of type int?, which defaults to null): set red fade. (default: 15)
• gf (of type int?, which defaults to null): set green fade. (default: 10)
• bf (of type int?, which defaults to null): set blue fade. (default: 5)
• af (of type int?, which defaults to null): set alpha fade. (default: 5)
• zoom (of type float?, which defaults to null): set zoom factor. (default: 1)
• draw (of type int?, which defaults to null): set draw mode. (default: 0, possible values: 0 (dot), 1 (line), 2 (aaline))
• scale (of type int?, which defaults to null): set amplitude scale mode. (default: 0, possible values: 0 (lin), 1 (sqrt), 2 (cbrt), 3 (log))
• swap (of type bool?, which defaults to null): swap x axis with y axis. (default: true)
• mirror (of type int?, which defaults to null): mirror axis. (default: 0, possible values: 0 (none), 1 (x), 2 (y), 3 (xy))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.avectorscope.create

Ffmpeg filter: Convert input audio to vectorscope video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?m : int?, ?rate : string?, ?r : string?, ?size : string?,
 ?s : string?, ?rc : int?, ?gc : int?, ?bc : int?, ?ac : int?, ?rf : int?,
 ?gf : int?, ?bf : int?, ?af : int?, ?zoom : float?, ?draw : int?,
 ?scale : int?, ?swap : bool?, ?mirror : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (lissajous), 1 (lissajous_xy), 2 (polar))
• m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (lissajous), 1 (lissajous_xy), 2 (polar))
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size. (default: 400x400)
• s (of type string?, which defaults to null): set video size. (default: 400x400)
• rc (of type int?, which defaults to null): set red contrast. (default: 40)
• gc (of type int?, which defaults to null): set green contrast. (default: 160)
• bc (of type int?, which defaults to null): set blue contrast. (default: 80)
• ac (of type int?, which defaults to null): set alpha contrast. (default: 255)
• rf (of type int?, which defaults to null): set red fade. (default: 15)
• gf (of type int?, which defaults to null): set green fade. (default: 10)
• bf (of type int?, which defaults to null): set blue fade. (default: 5)
• af (of type int?, which defaults to null): set alpha fade. (default: 5)
• zoom (of type float?, which defaults to null): set zoom factor. (default: 1)
• draw (of type int?, which defaults to null): set draw mode. (default: 0, possible values: 0 (dot), 1 (line), 2 (aaline))
• scale (of type int?, which defaults to null): set amplitude scale mode. (default: 0, possible values: 0 (lin), 1 (sqrt), 2 (cbrt), 3 (log))
• swap (of type bool?, which defaults to null): swap x axis with y axis. (default: true)
• mirror (of type int?, which defaults to null): mirror axis. (default: 0, possible values: 0 (none), 1 (x), 2 (y), 3 (xy))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.avgblur

Ffmpeg filter: Apply Average Blur filter.

Type:

(?sizeX : int?, ?planes : int?, ?sizeY : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• sizeX (of type int?, which defaults to null): set horizontal size. (default: 1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• sizeY (of type int?, which defaults to null): set vertical size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.avgblur.create

Ffmpeg filter: Apply Average Blur filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sizeX : int?, ?planes : int?, ?sizeY : int?, ffmpeg.filter.graph) -> unit

Arguments:

• sizeX (of type int?, which defaults to null): set horizontal size. (default: 1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• sizeY (of type int?, which defaults to null): set vertical size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.avsynctest

Ffmpeg filter: Generate an Audio Video Sync Test.

Type:

(?size : string?, ?s : string?, ?framerate : string?, ?fr : string?,
 ?samplerate : int?, ?sr : int?, ?amplitude : float?, ?a : float?,
 ?period : int?, ?p : int?, ?delay : int?, ?dl : int?, ?cycle : bool?,
 ?c : bool?, ?duration : int?, ?d : int?, ?fg : string?, ?bg : string?,
 ?ag : string?, ffmpeg.filter.graph) ->
ffmpeg.filter.audio * ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set frame size. (default: hd720)
• s (of type string?, which defaults to null): set frame size. (default: hd720)
• framerate (of type string?, which defaults to null): set frame rate. (default: 30)
• fr (of type string?, which defaults to null): set frame rate. (default: 30)
• samplerate (of type int?, which defaults to null): set sample rate. (default: 44100)
• sr (of type int?, which defaults to null): set sample rate. (default: 44100)
• amplitude (of type float?, which defaults to null): set beep amplitude. (default: 0.7)
• a (of type float?, which defaults to null): set beep amplitude. (default: 0.7)
• period (of type int?, which defaults to null): set beep period. (default: 3)
• p (of type int?, which defaults to null): set beep period. (default: 3)
• delay (of type int?, which defaults to null): set flash delay. (default: 0)
• dl (of type int?, which defaults to null): set flash delay. (default: 0)
• cycle (of type bool?, which defaults to null): set delay cycle. (default: false)
• c (of type bool?, which defaults to null): set delay cycle. (default: false)
• duration (of type int?, which defaults to null): set duration. (default: 0)
• d (of type int?, which defaults to null): set duration. (default: 0)
• fg (of type string?, which defaults to null): set foreground color. (default: white)
• bg (of type string?, which defaults to null): set background color. (default: black)
• ag (of type string?, which defaults to null): set additional color. (default: gray)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.avsynctest.create

Ffmpeg filter: Generate an Audio Video Sync Test. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?framerate : string?, ?fr : string?,
 ?samplerate : int?, ?sr : int?, ?amplitude : float?, ?a : float?,
 ?period : int?, ?p : int?, ?delay : int?, ?dl : int?, ?cycle : bool?,
 ?c : bool?, ?duration : int?, ?d : int?, ?fg : string?, ?bg : string?,
 ?ag : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set frame size. (default: hd720)
• s (of type string?, which defaults to null): set frame size. (default: hd720)
• framerate (of type string?, which defaults to null): set frame rate. (default: 30)
• fr (of type string?, which defaults to null): set frame rate. (default: 30)
• samplerate (of type int?, which defaults to null): set sample rate. (default: 44100)
• sr (of type int?, which defaults to null): set sample rate. (default: 44100)
• amplitude (of type float?, which defaults to null): set beep amplitude. (default: 0.7)
• a (of type float?, which defaults to null): set beep amplitude. (default: 0.7)
• period (of type int?, which defaults to null): set beep period. (default: 3)
• p (of type int?, which defaults to null): set beep period. (default: 3)
• delay (of type int?, which defaults to null): set flash delay. (default: 0)
• dl (of type int?, which defaults to null): set flash delay. (default: 0)
• cycle (of type bool?, which defaults to null): set delay cycle. (default: false)
• c (of type bool?, which defaults to null): set delay cycle. (default: false)
• duration (of type int?, which defaults to null): set duration. (default: 0)
• d (of type int?, which defaults to null): set duration. (default: 0)
• fg (of type string?, which defaults to null): set foreground color. (default: white)
• bg (of type string?, which defaults to null): set background color. (default: black)
• ag (of type string?, which defaults to null): set additional color. (default: gray)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio * ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.axcorrelate

Ffmpeg filter: Cross-correlate two audio streams.

Type:

(?size : int?, ?algo : int?, ffmpeg.filter.graph, ffmpeg.filter.audio,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• size (of type int?, which defaults to null): set the segment size. (default: 256)
• algo (of type int?, which defaults to null): set the algorithm. (default: 2, possible values: 0 (slow), 1 (fast), 2 (best))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.axcorrelate.create

Ffmpeg filter: Cross-correlate two audio streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : int?, ?algo : int?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type int?, which defaults to null): set the segment size. (default: 256)
• algo (of type int?, which defaults to null): set the algorithm. (default: 2, possible values: 0 (slow), 1 (fast), 2 (best))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.backgroundkey

Ffmpeg filter: Turns a static background into transparency.

Type:

(?threshold : float?, ?similarity : float?, ?blend : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• threshold (of type float?, which defaults to null): set the scene change threshold. (default: 0.08)
• similarity (of type float?, which defaults to null): set the similarity. (default: 0.1)
• blend (of type float?, which defaults to null): set the blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.backgroundkey.create

Ffmpeg filter: Turns a static background into transparency. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold : float?, ?similarity : float?, ?blend : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• threshold (of type float?, which defaults to null): set the scene change threshold. (default: 0.08)
• similarity (of type float?, which defaults to null): set the similarity. (default: 0.1)
• blend (of type float?, which defaults to null): set the blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bandpass

Ffmpeg filter: Apply a two-pole Butterworth band-pass filter.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?csg : bool?, ?mix : float?, ?m : float?,
 ?channels : string?, ?c : string?, ?normalize : bool?, ?n : bool?,
 ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• csg (of type bool?, which defaults to null): use constant skirt gain. (default: false)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.bandpass.create

Ffmpeg filter: Apply a two-pole Butterworth band-pass filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?csg : bool?, ?mix : float?, ?m : float?,
 ?channels : string?, ?c : string?, ?normalize : bool?, ?n : bool?,
 ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• csg (of type bool?, which defaults to null): use constant skirt gain. (default: false)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bandreject

Ffmpeg filter: Apply a two-pole Butterworth band-reject filter.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?mix : float?, ?m : float?,
 ?channels : string?, ?c : string?, ?normalize : bool?, ?n : bool?,
 ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.bandreject.create

Ffmpeg filter: Apply a two-pole Butterworth band-reject filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?mix : float?, ?m : float?,
 ?channels : string?, ?c : string?, ?normalize : bool?, ?n : bool?,
 ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bass

Ffmpeg filter: Boost or cut lower frequencies.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 100)
• f (of type float?, which defaults to null): set central frequency. (default: 100)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.bass.create

Ffmpeg filter: Boost or cut lower frequencies. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 100)
• f (of type float?, which defaults to null): set central frequency. (default: 100)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bbox

Ffmpeg filter: Compute bounding box for each frame.

Type:

(?min_val : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• min_val (of type int?, which defaults to null): set minimum luminance value for bounding box. (default: 16)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.bbox.create

Ffmpeg filter: Compute bounding box for each frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?min_val : int?, ffmpeg.filter.graph) -> unit

Arguments:

• min_val (of type int?, which defaults to null): set minimum luminance value for bounding box. (default: 16)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bench

Ffmpeg filter: Benchmark part of a filtergraph.

Type:

(?action : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• action (of type int?, which defaults to null): set action. (default: 0, possible values: 0 (start), 1 (stop))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.bench.create

Ffmpeg filter: Benchmark part of a filtergraph. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?action : int?, ffmpeg.filter.graph) -> unit

Arguments:

• action (of type int?, which defaults to null): set action. (default: 0, possible values: 0 (start), 1 (stop))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bilateral

Ffmpeg filter: Apply Bilateral filter.

Type:

(?sigmaS : float?, ?sigmaR : float?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• sigmaS (of type float?, which defaults to null): set spatial sigma. (default: 0.1)
• sigmaR (of type float?, which defaults to null): set range sigma. (default: 0.1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.bilateral.create

Ffmpeg filter: Apply Bilateral filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sigmaS : float?, ?sigmaR : float?, ?planes : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• sigmaS (of type float?, which defaults to null): set spatial sigma. (default: 0.1)
• sigmaR (of type float?, which defaults to null): set range sigma. (default: 0.1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.biquad

Ffmpeg filter: Apply a biquad IIR filter with the given coefficients.

Type:

(?a0 : float?, ?a1 : float?, ?a2 : float?, ?b0 : float?, ?b1 : float?,
 ?b2 : float?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• a0 (of type float?, which defaults to null): Default: 1
• a1 (of type float?, which defaults to null): Default: 0
• a2 (of type float?, which defaults to null): Default: 0
• b0 (of type float?, which defaults to null): Default: 0
• b1 (of type float?, which defaults to null): Default: 0
• b2 (of type float?, which defaults to null): Default: 0
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.biquad.create

Ffmpeg filter: Apply a biquad IIR filter with the given coefficients. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?a0 : float?, ?a1 : float?, ?a2 : float?, ?b0 : float?, ?b1 : float?,
 ?b2 : float?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• a0 (of type float?, which defaults to null): Default: 1
• a1 (of type float?, which defaults to null): Default: 0
• a2 (of type float?, which defaults to null): Default: 0
• b0 (of type float?, which defaults to null): Default: 0
• b1 (of type float?, which defaults to null): Default: 0
• b2 (of type float?, which defaults to null): Default: 0
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bitplanenoise

Ffmpeg filter: Measure bit plane noise.

Type:

(?bitplane : int?, ?filter : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• bitplane (of type int?, which defaults to null): set bit plane to use for measuring noise. (default: 1)
• filter (of type bool?, which defaults to null): show noisy pixels. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.bitplanenoise.create

Ffmpeg filter: Measure bit plane noise. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?bitplane : int?, ?filter : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• bitplane (of type int?, which defaults to null): set bit plane to use for measuring noise. (default: 1)
• filter (of type bool?, which defaults to null): show noisy pixels. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bitstream.aac_adtstoasc

FFmpeg aac_adtstoasc bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.ahx_to_mp2

FFmpeg ahx_to_mp2 bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.apv_metadata

FFmpeg apv_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?color_primaries : int?, ?full_range_flag : int?,
 ?matrix_coefficients : int?, ?transfer_characteristics : int?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• color_primaries (of type int?, which defaults to null): Set color primaries (section 5.3.5). (default: -1)
• full_range_flag (of type int?, which defaults to null): Set full range flag flag (section 5.3.5). (default: -1, possible values: 0 (tv), 1 (pc))
• matrix_coefficients (of type int?, which defaults to null): Set matrix coefficients (section 5.3.5). (default: -1)
• transfer_characteristics (of type int?, which defaults to null): Set transfer characteristics (section 5.3.5). (default: -1)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.av1_frame_merge

FFmpeg av1_frame_merge bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.av1_frame_split

FFmpeg av1_frame_split bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.av1_metadata

FFmpeg av1_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?chroma_sample_position : int?, ?color_primaries : int?,
 ?color_range : int?, ?delete_padding : bool?, ?matrix_coefficients : int?,
 ?num_ticks_per_picture : int?, ?td : int?, ?tick_rate : string?,
 ?transfer_characteristics : int?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• chroma_sample_position (of type int?, which defaults to null): Set chroma sample position (section 6.4.2). (default: -1, possible values: 0 (unknown), 1 (vertical), 2 (colocated))
• color_primaries (of type int?, which defaults to null): Set color primaries (section 6.4.2). (default: -1)
• color_range (of type int?, which defaults to null): Set color range flag (section 6.4.2). (default: -1, possible values: 0 (tv), 1 (pc))
• delete_padding (of type bool?, which defaults to null): Delete all Padding OBUs. (default: false)
• matrix_coefficients (of type int?, which defaults to null): Set matrix coefficients (section 6.4.2). (default: -1)
• num_ticks_per_picture (of type int?, which defaults to null): Set display ticks per picture for CFR streams. (default: -1)
• td (of type int?, which defaults to null): Temporal Delimiter OBU. (default: 0, possible values: 0 (pass), 1 (insert), 2 (remove))
• tick_rate (of type string?, which defaults to null): Set display tick rate (time_scale / num_units_in_display_tick). (default: 0/1)
• transfer_characteristics (of type int?, which defaults to null): Set transfer characteristics (section 6.4.2). (default: -1)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.chomp.audio

FFmpeg chomp.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.chomp.video

FFmpeg chomp.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.dca_core

FFmpeg dca_core bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.dovi_rpu

FFmpeg dovi_rpu bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?compression : int?, ?strip : bool?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• compression (of type int?, which defaults to null): DV metadata compression mode. (default: 1, possible values: 0 (none), 1 (limited), 3 (extended))
• strip (of type bool?, which defaults to null): Strip Dolby Vision metadata. (default: false)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.dovi_split

FFmpeg dovi_split bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?mode : int?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• mode (of type int?, which defaults to null): Which Dolby Vision components to keep in the output bitstream. (default: 0, possible values: 0 (bl), 1 (bl_rpu), 2 (el), 3 (el_rpu))
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.dts2pts

FFmpeg dts2pts bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.dump_extra.audio

FFmpeg dump_extra.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?freq : int?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• freq (of type int?, which defaults to null): When to dump extradata. (default: 0, possible values: 0 (k), 0 (keyframe), 1 (e), 1 (all))
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.dump_extra.video

FFmpeg dump_extra.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?freq : int?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• freq (of type int?, which defaults to null): When to dump extradata. (default: 0, possible values: 0 (k), 0 (keyframe), 1 (e), 1 (all))
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.dv_error_marker

FFmpeg dv_error_marker bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?color : string?, ?sta : int?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• color (of type string?, which defaults to null): set color. (default: yellow)
• sta (of type int?, which defaults to null): specify which error status value to match. (default: 65534, possible values: 1 (ok), 4 (Aa), 16 (Ba), 64 (Ca), 128 (erri), 32768 (erru), 32896 (err), 1024 (Ab), 4096 (Bb), 16384 (Cb), 1028 (A), 4112 (B), 16448 (C), 84 (a), 21504 (b), 11050 (res), 54484 (notok), 54485 (notres), combined by addition)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.eac3_core

FFmpeg eac3_core bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.evc_frame_merge

FFmpeg evc_frame_merge bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.extract_extradata

FFmpeg extract_extradata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?remove : int?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• remove (of type int?, which defaults to null): remove the extradata from the bitstream. (default: 0)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.filter_units

FFmpeg filter_units bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?discard : int?, ?discard_flags : int?,
 ?pass_types : string?, ?remove_types : string?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• discard (of type int?, which defaults to null): Remove the selected frames. (default: -16, possible values: -16 (none), 0 (default), 8 (nonref), 16 (bidir), 24 (nonintra), 32 (nonkey), 48 (all))
• discard_flags (of type int?, which defaults to null): flags to control the discard frame behavior. (default: 0, possible values: 1 (keep_non_vcl), combined by addition)
• pass_types (of type string?, which defaults to null): List of unit types to pass through the filter.
• remove_types (of type string?, which defaults to null): List of unit types to remove in the filter.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.h264_metadata

FFmpeg h264_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?aud : int?, ?chroma_sample_loc_type : int?,
 ?colour_primaries : int?, ?crop_bottom : int?, ?crop_left : int?,
 ?crop_right : int?, ?crop_top : int?, ?delete_filler : int?,
 ?display_orientation : int?, ?fixed_frame_rate_flag : int?, ?flip : int?,
 ?level : int?, ?matrix_coefficients : int?,
 ?overscan_appropriate_flag : int?, ?rotate : float?,
 ?sample_aspect_ratio : string?, ?sei_user_data : string?,
 ?tick_rate : string?, ?transfer_characteristics : int?,
 ?video_format : int?, ?video_full_range_flag : int?,
 ?zero_new_constraint_set_flags : bool?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• aud (of type int?, which defaults to null): Access Unit Delimiter NAL units. (default: 0, possible values: 0 (pass), 1 (insert), 2 (remove))
• chroma_sample_loc_type (of type int?, which defaults to null): Set chroma sample location type (figure E-1). (default: -1)
• colour_primaries (of type int?, which defaults to null): Set colour primaries (table E-3). (default: -1)
• crop_bottom (of type int?, which defaults to null): Set bottom border crop offset. (default: -1)
• crop_left (of type int?, which defaults to null): Set left border crop offset. (default: -1)
• crop_right (of type int?, which defaults to null): Set right border crop offset. (default: -1)
• crop_top (of type int?, which defaults to null): Set top border crop offset. (default: -1)
• delete_filler (of type int?, which defaults to null): Delete all filler (both NAL and SEI). (default: 0)
• display_orientation (of type int?, which defaults to null): Display orientation SEI. (default: 0, possible values: 0 (pass), 1 (insert), 2 (remove), 3 (extract))
• fixed_frame_rate_flag (of type int?, which defaults to null): Set VUI fixed frame rate flag. (default: -1)
• flip (of type int?, which defaults to null): Set flip in display orientation SEI. (default: 0, possible values: 1 (horizontal), 2 (vertical), combined by addition)
• level (of type int?, which defaults to null): Set level (table A-1). (default: -2, possible values: -1 (auto), 10 (1), 9 (1b), 11 (1.1), 12 (1.2), 13 (1.3), 20 (2), 21 (2.1), 22 (2.2), 30 (3), 31 (3.1), 32 (3.2), 40 (4), 41 (4.1), 42 (4.2), 50 (5), 51 (5.1), 52 (5.2), 60 (6), 61 (6.1), 62 (6.2))
• matrix_coefficients (of type int?, which defaults to null): Set matrix coefficients (table E-5). (default: -1)
• overscan_appropriate_flag (of type int?, which defaults to null): Set VUI overscan appropriate flag. (default: -1)
• rotate (of type float?, which defaults to null): Set rotation in display orientation SEI (anticlockwise angle in degrees). (default: nan)
• sample_aspect_ratio (of type string?, which defaults to null): Set sample aspect ratio (table E-1). (default: 0/1)
• sei_user_data (of type string?, which defaults to null): Insert SEI user data (UUID+string)
• tick_rate (of type string?, which defaults to null): Set VUI tick rate (time_scale / num_units_in_tick). (default: 0/1)
• transfer_characteristics (of type int?, which defaults to null): Set transfer characteristics (table E-4). (default: -1)
• video_format (of type int?, which defaults to null): Set video format (table E-2). (default: -1)
• video_full_range_flag (of type int?, which defaults to null): Set video full range flag. (default: -1)
• zero_new_constraint_set_flags (of type bool?, which defaults to null): Set constraint_set4_flag / constraint_set5_flag to zero. (default: false)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.h264_mp4toannexb

FFmpeg h264_mp4toannexb bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.h264_redundant_pps

FFmpeg h264_redundant_pps bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.hapqa_extract

FFmpeg hapqa_extract bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?texture : int?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• texture (of type int?, which defaults to null): texture to keep. (default: 0, possible values: 0 (color), 1 (alpha))
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.hevc_metadata

FFmpeg hevc_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?aud : int?, ?chroma_sample_loc_type : int?,
 ?colour_primaries : int?, ?crop_bottom : int?, ?crop_left : int?,
 ?crop_right : int?, ?crop_top : int?, ?height : int?, ?level : int?,
 ?matrix_coefficients : int?, ?num_ticks_poc_diff_one : int?,
 ?sample_aspect_ratio : string?, ?tick_rate : string?,
 ?transfer_characteristics : int?, ?video_format : int?,
 ?video_full_range_flag : int?, ?width : int?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• aud (of type int?, which defaults to null): Access Unit Delimiter NAL units. (default: 0, possible values: 0 (pass), 1 (insert), 2 (remove))
• chroma_sample_loc_type (of type int?, which defaults to null): Set chroma sample location type (figure E-1). (default: -1)
• colour_primaries (of type int?, which defaults to null): Set colour primaries (table E-3). (default: -1)
• crop_bottom (of type int?, which defaults to null): Set bottom border crop offset. (default: -1)
• crop_left (of type int?, which defaults to null): Set left border crop offset. (default: -1)
• crop_right (of type int?, which defaults to null): Set right border crop offset. (default: -1)
• crop_top (of type int?, which defaults to null): Set top border crop offset. (default: -1)
• height (of type int?, which defaults to null): Set height after crop. (default: -1)
• level (of type int?, which defaults to null): Set level (tables A.6 and A.7). (default: -2, possible values: -1 (auto), 30 (1), 60 (2), 63 (2.1), 90 (3), 93 (3.1), 120 (4), 123 (4.1), 150 (5), 153 (5.1), 156 (5.2), 180 (6), 183 (6.1), 186 (6.2), 255 (8.5))
• matrix_coefficients (of type int?, which defaults to null): Set matrix coefficients (table E-5). (default: -1)
• num_ticks_poc_diff_one (of type int?, which defaults to null): Set VPS and VUI number of ticks per POC increment. (default: -1)
• sample_aspect_ratio (of type string?, which defaults to null): Set sample aspect ratio (table E-1). (default: 0/1)
• tick_rate (of type string?, which defaults to null): Set VPS and VUI tick rate (time_scale / num_units_in_tick). (default: 0/1)
• transfer_characteristics (of type int?, which defaults to null): Set transfer characteristics (table E-4). (default: -1)
• video_format (of type int?, which defaults to null): Set video format (table E-2). (default: -1)
• video_full_range_flag (of type int?, which defaults to null): Set video full range flag. (default: -1)
• width (of type int?, which defaults to null): Set width after crop. (default: -1)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.hevc_mp4toannexb

FFmpeg hevc_mp4toannexb bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.imxdump

FFmpeg imxdump bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.media100_to_mjpegb

FFmpeg media100_to_mjpegb bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.mjpeg2jpeg

FFmpeg mjpeg2jpeg bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.mjpegadump

FFmpeg mjpegadump bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.mov2textsub.audio

FFmpeg mov2textsub.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.mov2textsub.video

FFmpeg mov2textsub.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.mpeg2_metadata

FFmpeg mpeg2_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?colour_primaries : int?, ?display_aspect_ratio : string?,
 ?frame_rate : string?, ?matrix_coefficients : int?,
 ?transfer_characteristics : int?, ?video_format : int?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• colour_primaries (of type int?, which defaults to null): Set colour primaries (table 6-7). (default: -1)
• display_aspect_ratio (of type string?, which defaults to null): Set display aspect ratio (table 6-3). (default: 0/1)
• frame_rate (of type string?, which defaults to null): Set frame rate. (default: 0/1)
• matrix_coefficients (of type int?, which defaults to null): Set matrix coefficients (table 6-9). (default: -1)
• transfer_characteristics (of type int?, which defaults to null): Set transfer characteristics (table 6-8). (default: -1)
• video_format (of type int?, which defaults to null): Set video format (table 6-6). (default: -1)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.mpeg4_unpack_bframes

FFmpeg mpeg4_unpack_bframes bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.noise.audio

FFmpeg noise.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?amount : string?, ?drop : string?, ?dropamount : int?,
 source(audio=ffmpeg.copy('a), 'b)) -> source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• amount (of type string?, which defaults to null)
• drop (of type string?, which defaults to null)
• dropamount (of type int?, which defaults to null): Default: 0
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.noise.video

FFmpeg noise.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?amount : string?, ?drop : string?, ?dropamount : int?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• amount (of type string?, which defaults to null)
• drop (of type string?, which defaults to null)
• dropamount (of type int?, which defaults to null): Default: 0
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.null.audio

FFmpeg null.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.null.video

FFmpeg null.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.opus_metadata

FFmpeg opus_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?gain : int?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• gain (of type int?, which defaults to null): Gain, actual amplification is pow(10, gain/(20.0*256)). (default: 0)
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.pcm_rechunk

FFmpeg pcm_rechunk bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?frame_rate : string?, ?n : int?, ?nb_out_samples : int?,
 ?p : bool?, ?pad : bool?, ?r : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frame_rate (of type string?, which defaults to null): set number of packets per second. (default: 0/1)
• n (of type int?, which defaults to null): set the number of per-packet output samples. (default: 1024)
• nb_out_samples (of type int?, which defaults to null): set the number of per-packet output samples. (default: 1024)
• p (of type bool?, which defaults to null): pad last packet with zeros. (default: true)
• pad (of type bool?, which defaults to null): pad last packet with zeros. (default: true)
• r (of type string?, which defaults to null): set number of packets per second. (default: 0/1)
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.prores_metadata

FFmpeg prores_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?color_primaries : int?, ?color_trc : int?,
 ?colorspace : int?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• color_primaries (of type int?, which defaults to null): select color primaries. (default: -1, possible values: -1 (auto), 0 (unknown), 1 (bt709), 5 (bt470bg), 6 (smpte170m), 9 (bt2020), 11 (smpte431), 12 (smpte432))
• color_trc (of type int?, which defaults to null): select color transfer. (default: -1, possible values: -1 (auto), 0 (unknown), 1 (bt709), 16 (smpte2084), 18 (arib-std-b67))
• colorspace (of type int?, which defaults to null): select colorspace. (default: -1, possible values: -1 (auto), 0 (unknown), 1 (bt709), 6 (smpte170m), 9 (bt2020nc))
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.remove_extra.audio

FFmpeg remove_extra.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?freq : int?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• freq (of type int?, which defaults to null): Default: 0, possible values: 2 (k), 0 (keyframe), 1 (e), 1 (all)
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.remove_extra.video

FFmpeg remove_extra.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?freq : int?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• freq (of type int?, which defaults to null): Default: 0, possible values: 2 (k), 0 (keyframe), 1 (e), 1 (all)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.setts.audio

FFmpeg setts.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?dts : string?, ?duration : string?, ?prescale : bool?,
 ?pts : string?, ?time_base : string?, ?ts : string?,
 source(audio=ffmpeg.copy('a), 'b)) -> source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• dts (of type string?, which defaults to null): set expression for packet DTS
• duration (of type string?, which defaults to null): set expression for packet duration. (default: DURATION)
• prescale (of type bool?, which defaults to null): convert to output timebase before evaluation. (default: false)
• pts (of type string?, which defaults to null): set expression for packet PTS
• time_base (of type string?, which defaults to null): set output timebase. (default: 0/1)
• ts (of type string?, which defaults to null): set expression for packet PTS and DTS. (default: TS)
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.setts.video

FFmpeg setts.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?dts : string?, ?duration : string?, ?prescale : bool?,
 ?pts : string?, ?time_base : string?, ?ts : string?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• dts (of type string?, which defaults to null): set expression for packet DTS
• duration (of type string?, which defaults to null): set expression for packet duration. (default: DURATION)
• prescale (of type bool?, which defaults to null): convert to output timebase before evaluation. (default: false)
• pts (of type string?, which defaults to null): set expression for packet PTS
• time_base (of type string?, which defaults to null): set output timebase. (default: 0/1)
• ts (of type string?, which defaults to null): set expression for packet PTS and DTS. (default: TS)
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.showinfo.audio

FFmpeg showinfo.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.showinfo.video

FFmpeg showinfo.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.text2movsub.audio

FFmpeg text2movsub.audio bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.text2movsub.video

FFmpeg text2movsub.video bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.trace_headers

FFmpeg trace_headers bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.truehd_core

FFmpeg truehd_core bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(audio=ffmpeg.copy('a), 'b)) ->
source(audio=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(audio=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(audio=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(audio=ffmpeg.copy('c), 'b) }) -> source(audio=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.vp9_metadata

FFmpeg vp9_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?color_range : int?, ?color_space : int?,
 source(video=ffmpeg.copy('a), 'b)) -> source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• color_range (of type int?, which defaults to null): Set colour range (section 7.2.2). (default: -1, possible values: 0 (tv), 1 (pc))
• color_space (of type int?, which defaults to null): Set colour space (section 7.2.2). (default: -1, possible values: 0 (unknown), 1 (bt601), 2 (bt709), 3 (smpte170), 4 (smpte240), 5 (bt2020), 7 (rgb))
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.vp9_raw_reorder

FFmpeg vp9_raw_reorder bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.vp9_superframe

FFmpeg vp9_superframe bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.vp9_superframe_split

FFmpeg vp9_superframe_split bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.vvc_metadata

FFmpeg vvc_metadata bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, ?aud : int?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• aud (of type int?, which defaults to null): Access Unit Delimiter NAL units. (default: 0, possible values: 0 (pass), 1 (insert), 2 (remove))
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.bitstream.vvc_mp4toannexb

FFmpeg vvc_mp4toannexb bitstream filter. See ffmpeg documentation for more details. The operator is fallible exactly when its input is. With an infallible input, a persistent data fault is a hard error: wrap the operator in mksafe or a fallback to keep streaming through it.

Type:

(?id : string?, source(video=ffmpeg.copy('a), 'b)) ->
source(video=ffmpeg.copy('c), 'b)

Composition:

This source inherits composition from its effective source.

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(video=ffmpeg.copy('a), 'b))

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• callbacks_count (of type () -> [string * int]): Callbacks a script has registered on this source, as pairs of callback name and count. A count that keeps growing is a function registering on a source it is handed without releasing what it registered.
• clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
• clock (of type clock): The source's clock
• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
• id (of type () -> string): Identifier of the source.
• insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
• log (of type {level : (() -> int).{exchange : (int) -> int, set : (int) -> unit}}): Get or set the source's log level, from 1 to 5.
• register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• reset_last_metadata_on_track (of type (() -> bool).{exchange : (bool) -> bool, set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• self_sync_description (of type () -> string)
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

• on_collect (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source is collected
• on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
• on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> {release : () -> unit}): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
• on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler to execute on each metadata
• on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
• on_shutdown (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called when source shuts down
• on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> {release : () -> unit}): Call a given handler on track marks
• on_wake_up (of type (synchronous : bool, (() -> unit)) -> {release : () -> unit}): Call a given handler to be called after the source is asked to get ready

Composition methods:

• composition_type (of type (() -> string).{exchange : (string) -> string, set : (string) -> unit}): This source inherits composition from its effective source.
• on_leave (of type ({source : source(video=ffmpeg.copy('c), 'b), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
• on_select (of type ( { ending : source(video=ffmpeg.copy('c), 'b)?, replay_metadata : bool, starting : source(video=ffmpeg.copy('c), 'b) }) -> source(video=ffmpeg.copy('c), 'b)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
• single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
• track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

ffmpeg.filter.blackdetect

Ffmpeg filter: Detect video intervals that are (almost) black.

Type:

(?d : float?, ?black_min_duration : float?, ?picture_black_ratio_th : float?,
 ?pic_th : float?, ?pixel_black_th : float?, ?pix_th : float?,
 ?alpha : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• d (of type float?, which defaults to null): set minimum detected black duration in seconds. (default: 2)
• black_min_duration (of type float?, which defaults to null): set minimum detected black duration in seconds. (default: 2)
• picture_black_ratio_th (of type float?, which defaults to null): set the picture black ratio threshold. (default: 0.98)
• pic_th (of type float?, which defaults to null): set the picture black ratio threshold. (default: 0.98)
• pixel_black_th (of type float?, which defaults to null): set the pixel black threshold. (default: 0.1)
• pix_th (of type float?, which defaults to null): set the pixel black threshold. (default: 0.1)
• alpha (of type bool?, which defaults to null): check alpha instead of luma. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.blackdetect.create

Ffmpeg filter: Detect video intervals that are (almost) black. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?d : float?, ?black_min_duration : float?, ?picture_black_ratio_th : float?,
 ?pic_th : float?, ?pixel_black_th : float?, ?pix_th : float?,
 ?alpha : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• d (of type float?, which defaults to null): set minimum detected black duration in seconds. (default: 2)
• black_min_duration (of type float?, which defaults to null): set minimum detected black duration in seconds. (default: 2)
• picture_black_ratio_th (of type float?, which defaults to null): set the picture black ratio threshold. (default: 0.98)
• pic_th (of type float?, which defaults to null): set the picture black ratio threshold. (default: 0.98)
• pixel_black_th (of type float?, which defaults to null): set the pixel black threshold. (default: 0.1)
• pix_th (of type float?, which defaults to null): set the pixel black threshold. (default: 0.1)
• alpha (of type bool?, which defaults to null): check alpha instead of luma. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.blackframe

Ffmpeg filter: Detect frames that are (almost) black.

Type:

(?amount : int?, ?threshold : int?, ?thresh : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• amount (of type int?, which defaults to null): percentage of the pixels that have to be below the threshold for the frame to be considered black. (default: 98)
• threshold (of type int?, which defaults to null): threshold below which a pixel value is considered black. (default: 32)
• thresh (of type int?, which defaults to null): threshold below which a pixel value is considered black. (default: 32)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.blackframe.create

Ffmpeg filter: Detect frames that are (almost) black. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?amount : int?, ?threshold : int?, ?thresh : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• amount (of type int?, which defaults to null): percentage of the pixels that have to be below the threshold for the frame to be considered black. (default: 98)
• threshold (of type int?, which defaults to null): threshold below which a pixel value is considered black. (default: 32)
• thresh (of type int?, which defaults to null): threshold below which a pixel value is considered black. (default: 32)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.blend

Ffmpeg filter: Blend two video frames into each other.

Type:

(?c0_mode : int?, ?c1_mode : int?, ?c2_mode : int?, ?c3_mode : int?,
 ?all_mode : int?, ?c0_expr : string?, ?c1_expr : string?,
 ?c2_expr : string?, ?c3_expr : string?, ?all_expr : string?,
 ?c0_opacity : float?, ?c1_opacity : float?, ?c2_opacity : float?,
 ?c3_opacity : float?, ?all_opacity : float?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• c0_mode (of type int?, which defaults to null): set component #0 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c1_mode (of type int?, which defaults to null): set component #1 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c2_mode (of type int?, which defaults to null): set component #2 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c3_mode (of type int?, which defaults to null): set component #3 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• all_mode (of type int?, which defaults to null): set blend mode for all components. (default: -1, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c0_expr (of type string?, which defaults to null): set color component #0 expression
• c1_expr (of type string?, which defaults to null): set color component #1 expression
• c2_expr (of type string?, which defaults to null): set color component #2 expression
• c3_expr (of type string?, which defaults to null): set color component #3 expression
• all_expr (of type string?, which defaults to null): set expression for all color components
• c0_opacity (of type float?, which defaults to null): set color component #0 opacity. (default: 1)
• c1_opacity (of type float?, which defaults to null): set color component #1 opacity. (default: 1)
• c2_opacity (of type float?, which defaults to null): set color component #2 opacity. (default: 1)
• c3_opacity (of type float?, which defaults to null): set color component #3 opacity. (default: 1)
• all_opacity (of type float?, which defaults to null): set opacity for all color components. (default: 1)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.blend.create

Ffmpeg filter: Blend two video frames into each other. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?c0_mode : int?, ?c1_mode : int?, ?c2_mode : int?, ?c3_mode : int?,
 ?all_mode : int?, ?c0_expr : string?, ?c1_expr : string?,
 ?c2_expr : string?, ?c3_expr : string?, ?all_expr : string?,
 ?c0_opacity : float?, ?c1_opacity : float?, ?c2_opacity : float?,
 ?c3_opacity : float?, ?all_opacity : float?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• c0_mode (of type int?, which defaults to null): set component #0 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c1_mode (of type int?, which defaults to null): set component #1 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c2_mode (of type int?, which defaults to null): set component #2 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c3_mode (of type int?, which defaults to null): set component #3 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• all_mode (of type int?, which defaults to null): set blend mode for all components. (default: -1, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c0_expr (of type string?, which defaults to null): set color component #0 expression
• c1_expr (of type string?, which defaults to null): set color component #1 expression
• c2_expr (of type string?, which defaults to null): set color component #2 expression
• c3_expr (of type string?, which defaults to null): set color component #3 expression
• all_expr (of type string?, which defaults to null): set expression for all color components
• c0_opacity (of type float?, which defaults to null): set color component #0 opacity. (default: 1)
• c1_opacity (of type float?, which defaults to null): set color component #1 opacity. (default: 1)
• c2_opacity (of type float?, which defaults to null): set color component #2 opacity. (default: 1)
• c3_opacity (of type float?, which defaults to null): set color component #3 opacity. (default: 1)
• all_opacity (of type float?, which defaults to null): set opacity for all color components. (default: 1)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.blockdetect

Ffmpeg filter: Blockdetect filter.

Type:

(?period_min : int?, ?period_max : int?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• period_min (of type int?, which defaults to null): Minimum period to search for. (default: 3)
• period_max (of type int?, which defaults to null): Maximum period to search for. (default: 24)
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.blockdetect.create

Ffmpeg filter: Blockdetect filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?period_min : int?, ?period_max : int?, ?planes : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• period_min (of type int?, which defaults to null): Minimum period to search for. (default: 3)
• period_max (of type int?, which defaults to null): Maximum period to search for. (default: 24)
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.blurdetect

Ffmpeg filter: Blurdetect filter.

Type:

(?high : float?, ?low : float?, ?radius : int?, ?block_pct : int?,
 ?block_width : int?, ?block_height : int?, ?planes : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• high (of type float?, which defaults to null): set high threshold. (default: 0.11764705882352941)
• low (of type float?, which defaults to null): set low threshold. (default: 0.058823529411764705)
• radius (of type int?, which defaults to null): search radius for maxima detection. (default: 50)
• block_pct (of type int?, which defaults to null): block pooling threshold when calculating blurriness. (default: 80)
• block_width (of type int?, which defaults to null): block size for block-based abbreviation of blurriness. (default: -1)
• block_height (of type int?, which defaults to null): block size for block-based abbreviation of blurriness. (default: -1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.blurdetect.create

Ffmpeg filter: Blurdetect filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?high : float?, ?low : float?, ?radius : int?, ?block_pct : int?,
 ?block_width : int?, ?block_height : int?, ?planes : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• high (of type float?, which defaults to null): set high threshold. (default: 0.11764705882352941)
• low (of type float?, which defaults to null): set low threshold. (default: 0.058823529411764705)
• radius (of type int?, which defaults to null): search radius for maxima detection. (default: 50)
• block_pct (of type int?, which defaults to null): block pooling threshold when calculating blurriness. (default: 80)
• block_width (of type int?, which defaults to null): block size for block-based abbreviation of blurriness. (default: -1)
• block_height (of type int?, which defaults to null): block size for block-based abbreviation of blurriness. (default: -1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bm3d

Ffmpeg filter: Block-Matching 3D denoiser. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?sigma : float?, ?block : int?, ?bstep : int?, ?group : int?, ?range : int?,
 ?mstep : int?, ?thmse : float?, ?hdthr : float?, ?estim : int?,
 ?ref : bool?, ?planes : int?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• sigma (of type float?, which defaults to null): set denoising strength. (default: 1)
• block (of type int?, which defaults to null): set size of local patch. (default: 16)
• bstep (of type int?, which defaults to null): set sliding step for processing blocks. (default: 4)
• group (of type int?, which defaults to null): set maximal number of similar blocks. (default: 1)
• range (of type int?, which defaults to null): set block matching range. (default: 9)
• mstep (of type int?, which defaults to null): set step for block matching. (default: 1)
• thmse (of type float?, which defaults to null): set threshold of mean square error for block matching. (default: 0)
• hdthr (of type float?, which defaults to null): set hard threshold for 3D transfer domain. (default: 2.7)
• estim (of type int?, which defaults to null): set filtering estimation mode. (default: 0, possible values: 0 (basic), 1 (final))
• ref (of type bool?, which defaults to null): have reference stream. (default: false)
• planes (of type int?, which defaults to null): set planes to filter. (default: 7)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.bm3d.create

Ffmpeg filter: Block-Matching 3D denoiser. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sigma : float?, ?block : int?, ?bstep : int?, ?group : int?, ?range : int?,
 ?mstep : int?, ?thmse : float?, ?hdthr : float?, ?estim : int?,
 ?ref : bool?, ?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• sigma (of type float?, which defaults to null): set denoising strength. (default: 1)
• block (of type int?, which defaults to null): set size of local patch. (default: 16)
• bstep (of type int?, which defaults to null): set sliding step for processing blocks. (default: 4)
• group (of type int?, which defaults to null): set maximal number of similar blocks. (default: 1)
• range (of type int?, which defaults to null): set block matching range. (default: 9)
• mstep (of type int?, which defaults to null): set step for block matching. (default: 1)
• thmse (of type float?, which defaults to null): set threshold of mean square error for block matching. (default: 0)
• hdthr (of type float?, which defaults to null): set hard threshold for 3D transfer domain. (default: 2.7)
• estim (of type int?, which defaults to null): set filtering estimation mode. (default: 0, possible values: 0 (basic), 1 (final))
• ref (of type bool?, which defaults to null): have reference stream. (default: false)
• planes (of type int?, which defaults to null): set planes to filter. (default: 7)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.boxblur

Ffmpeg filter: Blur the input.

Type:

(?luma_radius : string?, ?lr : string?, ?luma_power : int?, ?lp : int?,
 ?chroma_radius : string?, ?cr : string?, ?chroma_power : int?, ?cp : int?,
 ?alpha_radius : string?, ?ar : string?, ?alpha_power : int?, ?ap : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• luma_radius (of type string?, which defaults to null): Radius of the luma blurring box. (default: 2)
• lr (of type string?, which defaults to null): Radius of the luma blurring box. (default: 2)
• luma_power (of type int?, which defaults to null): How many times should the boxblur be applied to luma. (default: 2)
• lp (of type int?, which defaults to null): How many times should the boxblur be applied to luma. (default: 2)
• chroma_radius (of type string?, which defaults to null): Radius of the chroma blurring box
• cr (of type string?, which defaults to null): Radius of the chroma blurring box
• chroma_power (of type int?, which defaults to null): How many times should the boxblur be applied to chroma. (default: -1)
• cp (of type int?, which defaults to null): How many times should the boxblur be applied to chroma. (default: -1)
• alpha_radius (of type string?, which defaults to null): Radius of the alpha blurring box
• ar (of type string?, which defaults to null): Radius of the alpha blurring box
• alpha_power (of type int?, which defaults to null): How many times should the boxblur be applied to alpha. (default: -1)
• ap (of type int?, which defaults to null): How many times should the boxblur be applied to alpha. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.boxblur.create

Ffmpeg filter: Blur the input. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?luma_radius : string?, ?lr : string?, ?luma_power : int?, ?lp : int?,
 ?chroma_radius : string?, ?cr : string?, ?chroma_power : int?, ?cp : int?,
 ?alpha_radius : string?, ?ar : string?, ?alpha_power : int?, ?ap : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• luma_radius (of type string?, which defaults to null): Radius of the luma blurring box. (default: 2)
• lr (of type string?, which defaults to null): Radius of the luma blurring box. (default: 2)
• luma_power (of type int?, which defaults to null): How many times should the boxblur be applied to luma. (default: 2)
• lp (of type int?, which defaults to null): How many times should the boxblur be applied to luma. (default: 2)
• chroma_radius (of type string?, which defaults to null): Radius of the chroma blurring box
• cr (of type string?, which defaults to null): Radius of the chroma blurring box
• chroma_power (of type int?, which defaults to null): How many times should the boxblur be applied to chroma. (default: -1)
• cp (of type int?, which defaults to null): How many times should the boxblur be applied to chroma. (default: -1)
• alpha_radius (of type string?, which defaults to null): Radius of the alpha blurring box
• ar (of type string?, which defaults to null): Radius of the alpha blurring box
• alpha_power (of type int?, which defaults to null): How many times should the boxblur be applied to alpha. (default: -1)
• ap (of type int?, which defaults to null): How many times should the boxblur be applied to alpha. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.bwdif

Ffmpeg filter: Deinterlace the input image.

Type:

(?mode : int?, ?parity : int?, ?deint : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): specify the interlacing mode. (default: 1, possible values: 0 (send_frame), 1 (send_field))
• parity (of type int?, which defaults to null): specify the assumed picture field parity. (default: -1, possible values: 0 (tff), 1 (bff), -1 (auto))
• deint (of type int?, which defaults to null): specify which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.bwdif.create

Ffmpeg filter: Deinterlace the input image. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?parity : int?, ?deint : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): specify the interlacing mode. (default: 1, possible values: 0 (send_frame), 1 (send_field))
• parity (of type int?, which defaults to null): specify the assumed picture field parity. (default: -1, possible values: 0 (tff), 1 (bff), -1 (auto))
• deint (of type int?, which defaults to null): specify which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.cas

Ffmpeg filter: Contrast Adaptive Sharpen.

Type:

(?strength : float?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• strength (of type float?, which defaults to null): set the sharpening strength. (default: 0)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 7)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.cas.create

Ffmpeg filter: Contrast Adaptive Sharpen. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?strength : float?, ?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• strength (of type float?, which defaults to null): set the sharpening strength. (default: 0)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 7)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ccrepack

Ffmpeg filter: Repack CEA-708 closed caption metadata.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.ccrepack.create

Ffmpeg filter: Repack CEA-708 closed caption metadata. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.cellauto

Ffmpeg filter: Create pattern generated by an elementary cellular automaton.

Type:

(?filename : string?, ?f : string?, ?pattern : string?, ?p : string?,
 ?rate : string?, ?r : string?, ?size : string?, ?s : string?, ?rule : int?,
 ?random_fill_ratio : float?, ?ratio : float?, ?random_seed : int?,
 ?seed : int?, ?scroll : bool?, ?start_full : bool?, ?full : bool?,
 ?stitch : bool?, ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• filename (of type string?, which defaults to null): read initial pattern from file
• f (of type string?, which defaults to null): read initial pattern from file
• pattern (of type string?, which defaults to null): set initial pattern
• p (of type string?, which defaults to null): set initial pattern
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size
• s (of type string?, which defaults to null): set video size
• rule (of type int?, which defaults to null): set rule. (default: 110)
• random_fill_ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.6180339887498948)
• ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.6180339887498948)
• random_seed (of type int?, which defaults to null): set the seed for filling the initial grid randomly. (default: -1)
• seed (of type int?, which defaults to null): set the seed for filling the initial grid randomly. (default: -1)
• scroll (of type bool?, which defaults to null): scroll pattern downward. (default: true)
• start_full (of type bool?, which defaults to null): start filling the whole video. (default: false)
• full (of type bool?, which defaults to null): start filling the whole video. (default: true)
• stitch (of type bool?, which defaults to null): stitch boundaries. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.cellauto.create

Ffmpeg filter: Create pattern generated by an elementary cellular automaton. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filename : string?, ?f : string?, ?pattern : string?, ?p : string?,
 ?rate : string?, ?r : string?, ?size : string?, ?s : string?, ?rule : int?,
 ?random_fill_ratio : float?, ?ratio : float?, ?random_seed : int?,
 ?seed : int?, ?scroll : bool?, ?start_full : bool?, ?full : bool?,
 ?stitch : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• filename (of type string?, which defaults to null): read initial pattern from file
• f (of type string?, which defaults to null): read initial pattern from file
• pattern (of type string?, which defaults to null): set initial pattern
• p (of type string?, which defaults to null): set initial pattern
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• size (of type string?, which defaults to null): set video size
• s (of type string?, which defaults to null): set video size
• rule (of type int?, which defaults to null): set rule. (default: 110)
• random_fill_ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.6180339887498948)
• ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.6180339887498948)
• random_seed (of type int?, which defaults to null): set the seed for filling the initial grid randomly. (default: -1)
• seed (of type int?, which defaults to null): set the seed for filling the initial grid randomly. (default: -1)
• scroll (of type bool?, which defaults to null): scroll pattern downward. (default: true)
• start_full (of type bool?, which defaults to null): start filling the whole video. (default: false)
• full (of type bool?, which defaults to null): start filling the whole video. (default: true)
• stitch (of type bool?, which defaults to null): stitch boundaries. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.channelmap

Ffmpeg filter: Remap audio channels.

Type:

(?map : string?, ?channel_layout : string?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• map (of type string?, which defaults to null): A comma-separated list of input channel numbers in output order.
• channel_layout (of type string?, which defaults to null): Output channel layout.
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.channelmap.create

Ffmpeg filter: Remap audio channels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?map : string?, ?channel_layout : string?, ffmpeg.filter.graph) -> unit

Arguments:

• map (of type string?, which defaults to null): A comma-separated list of input channel numbers in output order.
• channel_layout (of type string?, which defaults to null): Output channel layout.
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.channelsplit

Ffmpeg filter: Split audio into per-channel streams. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?channel_layout : string?, ?channels : string?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> [ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• channel_layout (of type string?, which defaults to null): Input channel layout.. (default: stereo)
• channels (of type string?, which defaults to null): Channels to extract.. (default: all)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.channelsplit.create

Ffmpeg filter: Split audio into per-channel streams. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?channel_layout : string?, ?channels : string?, ffmpeg.filter.graph) -> unit

Arguments:

• channel_layout (of type string?, which defaults to null): Input channel layout.. (default: stereo)
• channels (of type string?, which defaults to null): Channels to extract.. (default: all)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.chorus

Ffmpeg filter: Add a chorus effect to the audio.

Type:

(?in_gain : float?, ?out_gain : float?, ?delays : string?, ?decays : string?,
 ?speeds : string?, ?depths : string?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• in_gain (of type float?, which defaults to null): set input gain. (default: 0.4)
• out_gain (of type float?, which defaults to null): set output gain. (default: 0.4)
• delays (of type string?, which defaults to null): set delays
• decays (of type string?, which defaults to null): set decays
• speeds (of type string?, which defaults to null): set speeds
• depths (of type string?, which defaults to null): set depths
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.chorus.create

Ffmpeg filter: Add a chorus effect to the audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?in_gain : float?, ?out_gain : float?, ?delays : string?, ?decays : string?,
 ?speeds : string?, ?depths : string?, ffmpeg.filter.graph) -> unit

Arguments:

• in_gain (of type float?, which defaults to null): set input gain. (default: 0.4)
• out_gain (of type float?, which defaults to null): set output gain. (default: 0.4)
• delays (of type string?, which defaults to null): set delays
• decays (of type string?, which defaults to null): set decays
• speeds (of type string?, which defaults to null): set speeds
• depths (of type string?, which defaults to null): set depths
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.chromahold

Ffmpeg filter: Turns a certain color range into gray.

Type:

(?color : string?, ?similarity : float?, ?blend : float?, ?yuv : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• color (of type string?, which defaults to null): set the chromahold key color. (default: black)
• similarity (of type float?, which defaults to null): set the chromahold similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the chromahold blend value. (default: 0)
• yuv (of type bool?, which defaults to null): color parameter is in yuv instead of rgb. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.chromahold.create

Ffmpeg filter: Turns a certain color range into gray. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?color : string?, ?similarity : float?, ?blend : float?, ?yuv : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• color (of type string?, which defaults to null): set the chromahold key color. (default: black)
• similarity (of type float?, which defaults to null): set the chromahold similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the chromahold blend value. (default: 0)
• yuv (of type bool?, which defaults to null): color parameter is in yuv instead of rgb. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.chromakey

Ffmpeg filter: Turns a certain color into transparency. Operates on YUV colors.

Type:

(?color : string?, ?similarity : float?, ?blend : float?, ?yuv : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• color (of type string?, which defaults to null): set the chromakey key color. (default: black)
• similarity (of type float?, which defaults to null): set the chromakey similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the chromakey key blend value. (default: 0)
• yuv (of type bool?, which defaults to null): color parameter is in yuv instead of rgb. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.chromakey.create

Ffmpeg filter: Turns a certain color into transparency. Operates on YUV colors. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?color : string?, ?similarity : float?, ?blend : float?, ?yuv : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• color (of type string?, which defaults to null): set the chromakey key color. (default: black)
• similarity (of type float?, which defaults to null): set the chromakey similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the chromakey key blend value. (default: 0)
• yuv (of type bool?, which defaults to null): color parameter is in yuv instead of rgb. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.chromanr

Ffmpeg filter: Reduce chrominance noise.

Type:

(?thres : float?, ?sizew : int?, ?sizeh : int?, ?stepw : int?, ?steph : int?,
 ?threy : float?, ?threu : float?, ?threv : float?, ?distance : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• thres (of type float?, which defaults to null): set y+u+v threshold. (default: 30)
• sizew (of type int?, which defaults to null): set horizontal patch size. (default: 5)
• sizeh (of type int?, which defaults to null): set vertical patch size. (default: 5)
• stepw (of type int?, which defaults to null): set horizontal step. (default: 1)
• steph (of type int?, which defaults to null): set vertical step. (default: 1)
• threy (of type float?, which defaults to null): set y threshold. (default: 200)
• threu (of type float?, which defaults to null): set u threshold. (default: 200)
• threv (of type float?, which defaults to null): set v threshold. (default: 200)
• distance (of type int?, which defaults to null): set distance type. (default: 0, possible values: 0 (manhattan), 1 (euclidean))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.chromanr.create

Ffmpeg filter: Reduce chrominance noise. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?thres : float?, ?sizew : int?, ?sizeh : int?, ?stepw : int?, ?steph : int?,
 ?threy : float?, ?threu : float?, ?threv : float?, ?distance : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• thres (of type float?, which defaults to null): set y+u+v threshold. (default: 30)
• sizew (of type int?, which defaults to null): set horizontal patch size. (default: 5)
• sizeh (of type int?, which defaults to null): set vertical patch size. (default: 5)
• stepw (of type int?, which defaults to null): set horizontal step. (default: 1)
• steph (of type int?, which defaults to null): set vertical step. (default: 1)
• threy (of type float?, which defaults to null): set y threshold. (default: 200)
• threu (of type float?, which defaults to null): set u threshold. (default: 200)
• threv (of type float?, which defaults to null): set v threshold. (default: 200)
• distance (of type int?, which defaults to null): set distance type. (default: 0, possible values: 0 (manhattan), 1 (euclidean))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.chromashift

Ffmpeg filter: Shift chroma.

Type:

(?cbh : int?, ?cbv : int?, ?crh : int?, ?crv : int?, ?edge : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• cbh (of type int?, which defaults to null): shift chroma-blue horizontally. (default: 0)
• cbv (of type int?, which defaults to null): shift chroma-blue vertically. (default: 0)
• crh (of type int?, which defaults to null): shift chroma-red horizontally. (default: 0)
• crv (of type int?, which defaults to null): shift chroma-red vertically. (default: 0)
• edge (of type int?, which defaults to null): set edge operation. (default: 0, possible values: 0 (smear), 1 (wrap))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.chromashift.create

Ffmpeg filter: Shift chroma. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cbh : int?, ?cbv : int?, ?crh : int?, ?crv : int?, ?edge : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• cbh (of type int?, which defaults to null): shift chroma-blue horizontally. (default: 0)
• cbv (of type int?, which defaults to null): shift chroma-blue vertically. (default: 0)
• crh (of type int?, which defaults to null): shift chroma-red horizontally. (default: 0)
• crv (of type int?, which defaults to null): shift chroma-red vertically. (default: 0)
• edge (of type int?, which defaults to null): set edge operation. (default: 0, possible values: 0 (smear), 1 (wrap))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ciescope

Ffmpeg filter: Video CIE scope.

Type:

(?system : int?, ?cie : int?, ?gamuts : int?, ?size : int?, ?s : int?,
 ?intensity : float?, ?i : float?, ?contrast : float?, ?corrgamma : bool?,
 ?showwhite : bool?, ?gamma : float?, ?fill : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• system (of type int?, which defaults to null): set color system. (default: 7, possible values: 0 (ntsc), 0 (470m), 1 (ebu), 1 (470bg), 2 (smpte), 3 (240m), 4 (apple), 5 (widergb), 6 (cie1931), 7 (hdtv), 7 (rec709), 8 (uhdtv), 8 (rec2020), 9 (dcip3))
• cie (of type int?, which defaults to null): set cie system. (default: 0, possible values: 0 (xyy), 1 (ucs), 2 (luv))
• gamuts (of type int?, which defaults to null): set what gamuts to draw. (default: 0, possible values: 1 (ntsc), 1 (470m), 2 (ebu), 2 (470bg), 4 (smpte), 8 (240m), 16 (apple), 32 (widergb), 64 (cie1931), 128 (hdtv), 128 (rec709), 256 (uhdtv), 256 (rec2020), 512 (dcip3), combined by addition)
• size (of type int?, which defaults to null): set ciescope size. (default: 512)
• s (of type int?, which defaults to null): set ciescope size. (default: 512)
• intensity (of type float?, which defaults to null): set ciescope intensity. (default: 0.001)
• i (of type float?, which defaults to null): set ciescope intensity. (default: 0.001)
• contrast (of type float?, which defaults to null): Default: 0.75
• corrgamma (of type bool?, which defaults to null): Default: true
• showwhite (of type bool?, which defaults to null): Default: false
• gamma (of type float?, which defaults to null): Default: 2.6
• fill (of type bool?, which defaults to null): fill with CIE colors. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.ciescope.create

Ffmpeg filter: Video CIE scope. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?system : int?, ?cie : int?, ?gamuts : int?, ?size : int?, ?s : int?,
 ?intensity : float?, ?i : float?, ?contrast : float?, ?corrgamma : bool?,
 ?showwhite : bool?, ?gamma : float?, ?fill : bool?, ffmpeg.filter.graph) ->
unit

Arguments:

• system (of type int?, which defaults to null): set color system. (default: 7, possible values: 0 (ntsc), 0 (470m), 1 (ebu), 1 (470bg), 2 (smpte), 3 (240m), 4 (apple), 5 (widergb), 6 (cie1931), 7 (hdtv), 7 (rec709), 8 (uhdtv), 8 (rec2020), 9 (dcip3))
• cie (of type int?, which defaults to null): set cie system. (default: 0, possible values: 0 (xyy), 1 (ucs), 2 (luv))
• gamuts (of type int?, which defaults to null): set what gamuts to draw. (default: 0, possible values: 1 (ntsc), 1 (470m), 2 (ebu), 2 (470bg), 4 (smpte), 8 (240m), 16 (apple), 32 (widergb), 64 (cie1931), 128 (hdtv), 128 (rec709), 256 (uhdtv), 256 (rec2020), 512 (dcip3), combined by addition)
• size (of type int?, which defaults to null): set ciescope size. (default: 512)
• s (of type int?, which defaults to null): set ciescope size. (default: 512)
• intensity (of type float?, which defaults to null): set ciescope intensity. (default: 0.001)
• i (of type float?, which defaults to null): set ciescope intensity. (default: 0.001)
• contrast (of type float?, which defaults to null): Default: 0.75
• corrgamma (of type bool?, which defaults to null): Default: true
• showwhite (of type bool?, which defaults to null): Default: false
• gamma (of type float?, which defaults to null): Default: 2.6
• fill (of type bool?, which defaults to null): fill with CIE colors. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.codecview

Ffmpeg filter: Visualize information about some codecs.

Type:

(?mv : int?, ?qp : bool?, ?mv_type : int?, ?mvt : int?, ?frame_type : int?,
 ?ft : int?, ?block : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mv (of type int?, which defaults to null): set motion vectors to visualize. (default: 0, possible values: 1 (pf), 2 (bf), 4 (bb), combined by addition)
• qp (of type bool?, which defaults to null): Default: false
• mv_type (of type int?, which defaults to null): set motion vectors type. (default: 0, possible values: 1 (fp), 2 (bp), combined by addition)
• mvt (of type int?, which defaults to null): set motion vectors type. (default: 0, possible values: 1 (fp), 2 (bp), combined by addition)
• frame_type (of type int?, which defaults to null): set frame types to visualize motion vectors of. (default: 0, possible values: 1 (if), 2 (pf), 4 (bf), combined by addition)
• ft (of type int?, which defaults to null): set frame types to visualize motion vectors of. (default: 0, possible values: 1 (if), 2 (pf), 4 (bf), combined by addition)
• block (of type bool?, which defaults to null): set block partitioning structure to visualize. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.codecview.create

Ffmpeg filter: Visualize information about some codecs. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mv : int?, ?qp : bool?, ?mv_type : int?, ?mvt : int?, ?frame_type : int?,
 ?ft : int?, ?block : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• mv (of type int?, which defaults to null): set motion vectors to visualize. (default: 0, possible values: 1 (pf), 2 (bf), 4 (bb), combined by addition)
• qp (of type bool?, which defaults to null): Default: false
• mv_type (of type int?, which defaults to null): set motion vectors type. (default: 0, possible values: 1 (fp), 2 (bp), combined by addition)
• mvt (of type int?, which defaults to null): set motion vectors type. (default: 0, possible values: 1 (fp), 2 (bp), combined by addition)
• frame_type (of type int?, which defaults to null): set frame types to visualize motion vectors of. (default: 0, possible values: 1 (if), 2 (pf), 4 (bf), combined by addition)
• ft (of type int?, which defaults to null): set frame types to visualize motion vectors of. (default: 0, possible values: 1 (if), 2 (pf), 4 (bf), combined by addition)
• block (of type bool?, which defaults to null): set block partitioning structure to visualize. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.color

Ffmpeg filter: Provide an uniformly colored input.

Type:

(?color : string?, ?c : string?, ?size : string?, ?s : string?,
 ?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?sar : string?,
 ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• color (of type string?, which defaults to null): set color. (default: black)
• c (of type string?, which defaults to null): set color. (default: black)
• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.color.create

Ffmpeg filter: Provide an uniformly colored input. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?color : string?, ?c : string?, ?size : string?, ?s : string?,
 ?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?sar : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• color (of type string?, which defaults to null): set color. (default: black)
• c (of type string?, which defaults to null): set color. (default: black)
• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorbalance

Ffmpeg filter: Adjust the color balance.

Type:

(?rs : float?, ?gs : float?, ?bs : float?, ?rm : float?, ?gm : float?,
 ?bm : float?, ?rh : float?, ?gh : float?, ?bh : float?, ?pl : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• rs (of type float?, which defaults to null): set red shadows. (default: 0)
• gs (of type float?, which defaults to null): set green shadows. (default: 0)
• bs (of type float?, which defaults to null): set blue shadows. (default: 0)
• rm (of type float?, which defaults to null): set red midtones. (default: 0)
• gm (of type float?, which defaults to null): set green midtones. (default: 0)
• bm (of type float?, which defaults to null): set blue midtones. (default: 0)
• rh (of type float?, which defaults to null): set red highlights. (default: 0)
• gh (of type float?, which defaults to null): set green highlights. (default: 0)
• bh (of type float?, which defaults to null): set blue highlights. (default: 0)
• pl (of type bool?, which defaults to null): preserve lightness. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorbalance.create

Ffmpeg filter: Adjust the color balance. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rs : float?, ?gs : float?, ?bs : float?, ?rm : float?, ?gm : float?,
 ?bm : float?, ?rh : float?, ?gh : float?, ?bh : float?, ?pl : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• rs (of type float?, which defaults to null): set red shadows. (default: 0)
• gs (of type float?, which defaults to null): set green shadows. (default: 0)
• bs (of type float?, which defaults to null): set blue shadows. (default: 0)
• rm (of type float?, which defaults to null): set red midtones. (default: 0)
• gm (of type float?, which defaults to null): set green midtones. (default: 0)
• bm (of type float?, which defaults to null): set blue midtones. (default: 0)
• rh (of type float?, which defaults to null): set red highlights. (default: 0)
• gh (of type float?, which defaults to null): set green highlights. (default: 0)
• bh (of type float?, which defaults to null): set blue highlights. (default: 0)
• pl (of type bool?, which defaults to null): preserve lightness. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorchannelmixer

Ffmpeg filter: Adjust colors by mixing color channels.

Type:

(?rr : float?, ?rg : float?, ?rb : float?, ?ra : float?, ?gr : float?,
 ?gg : float?, ?gb : float?, ?ga : float?, ?br : float?, ?bg : float?,
 ?bb : float?, ?ba : float?, ?ar : float?, ?ag : float?, ?ab : float?,
 ?aa : float?, ?pc : int?, ?pa : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• rr (of type float?, which defaults to null): set the red gain for the red channel. (default: 1)
• rg (of type float?, which defaults to null): set the green gain for the red channel. (default: 0)
• rb (of type float?, which defaults to null): set the blue gain for the red channel. (default: 0)
• ra (of type float?, which defaults to null): set the alpha gain for the red channel. (default: 0)
• gr (of type float?, which defaults to null): set the red gain for the green channel. (default: 0)
• gg (of type float?, which defaults to null): set the green gain for the green channel. (default: 1)
• gb (of type float?, which defaults to null): set the blue gain for the green channel. (default: 0)
• ga (of type float?, which defaults to null): set the alpha gain for the green channel. (default: 0)
• br (of type float?, which defaults to null): set the red gain for the blue channel. (default: 0)
• bg (of type float?, which defaults to null): set the green gain for the blue channel. (default: 0)
• bb (of type float?, which defaults to null): set the blue gain for the blue channel. (default: 1)
• ba (of type float?, which defaults to null): set the alpha gain for the blue channel. (default: 0)
• ar (of type float?, which defaults to null): set the red gain for the alpha channel. (default: 0)
• ag (of type float?, which defaults to null): set the green gain for the alpha channel. (default: 0)
• ab (of type float?, which defaults to null): set the blue gain for the alpha channel. (default: 0)
• aa (of type float?, which defaults to null): set the alpha gain for the alpha channel. (default: 1)
• pc (of type int?, which defaults to null): set the preserve color mode. (default: 0, possible values: 0 (none), 1 (lum), 2 (max), 3 (avg), 4 (sum), 5 (nrm), 6 (pwr))
• pa (of type float?, which defaults to null): set the preserve color amount. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorchannelmixer.create

Ffmpeg filter: Adjust colors by mixing color channels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rr : float?, ?rg : float?, ?rb : float?, ?ra : float?, ?gr : float?,
 ?gg : float?, ?gb : float?, ?ga : float?, ?br : float?, ?bg : float?,
 ?bb : float?, ?ba : float?, ?ar : float?, ?ag : float?, ?ab : float?,
 ?aa : float?, ?pc : int?, ?pa : float?, ffmpeg.filter.graph) -> unit

Arguments:

• rr (of type float?, which defaults to null): set the red gain for the red channel. (default: 1)
• rg (of type float?, which defaults to null): set the green gain for the red channel. (default: 0)
• rb (of type float?, which defaults to null): set the blue gain for the red channel. (default: 0)
• ra (of type float?, which defaults to null): set the alpha gain for the red channel. (default: 0)
• gr (of type float?, which defaults to null): set the red gain for the green channel. (default: 0)
• gg (of type float?, which defaults to null): set the green gain for the green channel. (default: 1)
• gb (of type float?, which defaults to null): set the blue gain for the green channel. (default: 0)
• ga (of type float?, which defaults to null): set the alpha gain for the green channel. (default: 0)
• br (of type float?, which defaults to null): set the red gain for the blue channel. (default: 0)
• bg (of type float?, which defaults to null): set the green gain for the blue channel. (default: 0)
• bb (of type float?, which defaults to null): set the blue gain for the blue channel. (default: 1)
• ba (of type float?, which defaults to null): set the alpha gain for the blue channel. (default: 0)
• ar (of type float?, which defaults to null): set the red gain for the alpha channel. (default: 0)
• ag (of type float?, which defaults to null): set the green gain for the alpha channel. (default: 0)
• ab (of type float?, which defaults to null): set the blue gain for the alpha channel. (default: 0)
• aa (of type float?, which defaults to null): set the alpha gain for the alpha channel. (default: 1)
• pc (of type int?, which defaults to null): set the preserve color mode. (default: 0, possible values: 0 (none), 1 (lum), 2 (max), 3 (avg), 4 (sum), 5 (nrm), 6 (pwr))
• pa (of type float?, which defaults to null): set the preserve color amount. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorchart

Ffmpeg filter: Generate color checker chart.

Type:

(?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?sar : string?,
 ?patch_size : string?, ?preset : int?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• patch_size (of type string?, which defaults to null): set the single patch size. (default: 64x64)
• preset (of type int?, which defaults to null): set the color checker chart preset. (default: 0, possible values: 0 (reference), 1 (skintones))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.colorchart.create

Ffmpeg filter: Generate color checker chart. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?sar : string?,
 ?patch_size : string?, ?preset : int?, ffmpeg.filter.graph) -> unit

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• patch_size (of type string?, which defaults to null): set the single patch size. (default: 64x64)
• preset (of type int?, which defaults to null): set the color checker chart preset. (default: 0, possible values: 0 (reference), 1 (skintones))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorcontrast

Ffmpeg filter: Adjust color contrast between RGB components.

Type:

(?rc : float?, ?gm : float?, ?by : float?, ?rcw : float?, ?gmw : float?,
 ?byw : float?, ?pl : float?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• rc (of type float?, which defaults to null): set the red-cyan contrast. (default: 0)
• gm (of type float?, which defaults to null): set the green-magenta contrast. (default: 0)
• by (of type float?, which defaults to null): set the blue-yellow contrast. (default: 0)
• rcw (of type float?, which defaults to null): set the red-cyan weight. (default: 0)
• gmw (of type float?, which defaults to null): set the green-magenta weight. (default: 0)
• byw (of type float?, which defaults to null): set the blue-yellow weight. (default: 0)
• pl (of type float?, which defaults to null): set the amount of preserving lightness. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorcontrast.create

Ffmpeg filter: Adjust color contrast between RGB components. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rc : float?, ?gm : float?, ?by : float?, ?rcw : float?, ?gmw : float?,
 ?byw : float?, ?pl : float?, ffmpeg.filter.graph) -> unit

Arguments:

• rc (of type float?, which defaults to null): set the red-cyan contrast. (default: 0)
• gm (of type float?, which defaults to null): set the green-magenta contrast. (default: 0)
• by (of type float?, which defaults to null): set the blue-yellow contrast. (default: 0)
• rcw (of type float?, which defaults to null): set the red-cyan weight. (default: 0)
• gmw (of type float?, which defaults to null): set the green-magenta weight. (default: 0)
• byw (of type float?, which defaults to null): set the blue-yellow weight. (default: 0)
• pl (of type float?, which defaults to null): set the amount of preserving lightness. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorcorrect

Ffmpeg filter: Adjust color white balance selectively for blacks and whites.

Type:

(?rl : float?, ?bl : float?, ?rh : float?, ?bh : float?,
 ?saturation : float?, ?analyze : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• rl (of type float?, which defaults to null): set the red shadow spot. (default: 0)
• bl (of type float?, which defaults to null): set the blue shadow spot. (default: 0)
• rh (of type float?, which defaults to null): set the red highlight spot. (default: 0)
• bh (of type float?, which defaults to null): set the blue highlight spot. (default: 0)
• saturation (of type float?, which defaults to null): set the amount of saturation. (default: 1)
• analyze (of type int?, which defaults to null): set the analyze mode. (default: 0, possible values: 0 (manual), 1 (average), 2 (minmax), 3 (median))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorcorrect.create

Ffmpeg filter: Adjust color white balance selectively for blacks and whites. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rl : float?, ?bl : float?, ?rh : float?, ?bh : float?,
 ?saturation : float?, ?analyze : int?, ffmpeg.filter.graph) -> unit

Arguments:

• rl (of type float?, which defaults to null): set the red shadow spot. (default: 0)
• bl (of type float?, which defaults to null): set the blue shadow spot. (default: 0)
• rh (of type float?, which defaults to null): set the red highlight spot. (default: 0)
• bh (of type float?, which defaults to null): set the blue highlight spot. (default: 0)
• saturation (of type float?, which defaults to null): set the amount of saturation. (default: 1)
• analyze (of type int?, which defaults to null): set the analyze mode. (default: 0, possible values: 0 (manual), 1 (average), 2 (minmax), 3 (median))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colordetect

Ffmpeg filter: Detect video color properties.

Type:

(?mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): Image properties to detect. (default: -1, possible values: 1 (color_range), 2 (alpha_mode), -1 (all), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colordetect.create

Ffmpeg filter: Detect video color properties. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): Image properties to detect. (default: -1, possible values: 1 (color_range), 2 (alpha_mode), -1 (all), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorhold

Ffmpeg filter: Turns a certain color range into gray. Operates on RGB colors.

Type:

(?color : string?, ?similarity : float?, ?blend : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• color (of type string?, which defaults to null): set the colorhold key color. (default: black)
• similarity (of type float?, which defaults to null): set the colorhold similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the colorhold blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorhold.create

Ffmpeg filter: Turns a certain color range into gray. Operates on RGB colors. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?color : string?, ?similarity : float?, ?blend : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• color (of type string?, which defaults to null): set the colorhold key color. (default: black)
• similarity (of type float?, which defaults to null): set the colorhold similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the colorhold blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorize

Ffmpeg filter: Overlay a solid color on the video stream.

Type:

(?hue : float?, ?saturation : float?, ?lightness : float?, ?mix : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• hue (of type float?, which defaults to null): set the hue. (default: 0)
• saturation (of type float?, which defaults to null): set the saturation. (default: 0.5)
• lightness (of type float?, which defaults to null): set the lightness. (default: 0.5)
• mix (of type float?, which defaults to null): set the mix of source lightness. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorize.create

Ffmpeg filter: Overlay a solid color on the video stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?hue : float?, ?saturation : float?, ?lightness : float?, ?mix : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• hue (of type float?, which defaults to null): set the hue. (default: 0)
• saturation (of type float?, which defaults to null): set the saturation. (default: 0.5)
• lightness (of type float?, which defaults to null): set the lightness. (default: 0.5)
• mix (of type float?, which defaults to null): set the mix of source lightness. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorkey

Ffmpeg filter: Turns a certain color into transparency. Operates on RGB colors.

Type:

(?color : string?, ?similarity : float?, ?blend : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• color (of type string?, which defaults to null): set the colorkey key color. (default: black)
• similarity (of type float?, which defaults to null): set the colorkey similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the colorkey key blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorkey.create

Ffmpeg filter: Turns a certain color into transparency. Operates on RGB colors. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?color : string?, ?similarity : float?, ?blend : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• color (of type string?, which defaults to null): set the colorkey key color. (default: black)
• similarity (of type float?, which defaults to null): set the colorkey similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the colorkey key blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorlevels

Ffmpeg filter: Adjust the color levels.

Type:

(?rimin : float?, ?gimin : float?, ?bimin : float?, ?aimin : float?,
 ?rimax : float?, ?gimax : float?, ?bimax : float?, ?aimax : float?,
 ?romin : float?, ?gomin : float?, ?bomin : float?, ?aomin : float?,
 ?romax : float?, ?gomax : float?, ?bomax : float?, ?aomax : float?,
 ?preserve : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• rimin (of type float?, which defaults to null): set input red black point. (default: 0)
• gimin (of type float?, which defaults to null): set input green black point. (default: 0)
• bimin (of type float?, which defaults to null): set input blue black point. (default: 0)
• aimin (of type float?, which defaults to null): set input alpha black point. (default: 0)
• rimax (of type float?, which defaults to null): set input red white point. (default: 1)
• gimax (of type float?, which defaults to null): set input green white point. (default: 1)
• bimax (of type float?, which defaults to null): set input blue white point. (default: 1)
• aimax (of type float?, which defaults to null): set input alpha white point. (default: 1)
• romin (of type float?, which defaults to null): set output red black point. (default: 0)
• gomin (of type float?, which defaults to null): set output green black point. (default: 0)
• bomin (of type float?, which defaults to null): set output blue black point. (default: 0)
• aomin (of type float?, which defaults to null): set output alpha black point. (default: 0)
• romax (of type float?, which defaults to null): set output red white point. (default: 1)
• gomax (of type float?, which defaults to null): set output green white point. (default: 1)
• bomax (of type float?, which defaults to null): set output blue white point. (default: 1)
• aomax (of type float?, which defaults to null): set output alpha white point. (default: 1)
• preserve (of type int?, which defaults to null): set preserve color mode. (default: 0, possible values: 0 (none), 1 (lum), 2 (max), 3 (avg), 4 (sum), 5 (nrm), 6 (pwr))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorlevels.create

Ffmpeg filter: Adjust the color levels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rimin : float?, ?gimin : float?, ?bimin : float?, ?aimin : float?,
 ?rimax : float?, ?gimax : float?, ?bimax : float?, ?aimax : float?,
 ?romin : float?, ?gomin : float?, ?bomin : float?, ?aomin : float?,
 ?romax : float?, ?gomax : float?, ?bomax : float?, ?aomax : float?,
 ?preserve : int?, ffmpeg.filter.graph) -> unit

Arguments:

• rimin (of type float?, which defaults to null): set input red black point. (default: 0)
• gimin (of type float?, which defaults to null): set input green black point. (default: 0)
• bimin (of type float?, which defaults to null): set input blue black point. (default: 0)
• aimin (of type float?, which defaults to null): set input alpha black point. (default: 0)
• rimax (of type float?, which defaults to null): set input red white point. (default: 1)
• gimax (of type float?, which defaults to null): set input green white point. (default: 1)
• bimax (of type float?, which defaults to null): set input blue white point. (default: 1)
• aimax (of type float?, which defaults to null): set input alpha white point. (default: 1)
• romin (of type float?, which defaults to null): set output red black point. (default: 0)
• gomin (of type float?, which defaults to null): set output green black point. (default: 0)
• bomin (of type float?, which defaults to null): set output blue black point. (default: 0)
• aomin (of type float?, which defaults to null): set output alpha black point. (default: 0)
• romax (of type float?, which defaults to null): set output red white point. (default: 1)
• gomax (of type float?, which defaults to null): set output green white point. (default: 1)
• bomax (of type float?, which defaults to null): set output blue white point. (default: 1)
• aomax (of type float?, which defaults to null): set output alpha white point. (default: 1)
• preserve (of type int?, which defaults to null): set preserve color mode. (default: 0, possible values: 0 (none), 1 (lum), 2 (max), 3 (avg), 4 (sum), 5 (nrm), 6 (pwr))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colormap

Ffmpeg filter: Apply custom Color Maps to video stream.

Type:

(?patch_size : string?, ?nb_patches : int?, ?type : int?, ?kernel : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• patch_size (of type string?, which defaults to null): set patch size. (default: 64x64)
• nb_patches (of type int?, which defaults to null): set number of patches. (default: 0)
• type (of type int?, which defaults to null): set the target type used. (default: 1, possible values: 0 (relative), 1 (absolute))
• kernel (of type int?, which defaults to null): set the kernel used for measuring color difference. (default: 0, possible values: 0 (euclidean), 1 (weuclidean))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colormap.create

Ffmpeg filter: Apply custom Color Maps to video stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?patch_size : string?, ?nb_patches : int?, ?type : int?, ?kernel : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• patch_size (of type string?, which defaults to null): set patch size. (default: 64x64)
• nb_patches (of type int?, which defaults to null): set number of patches. (default: 0)
• type (of type int?, which defaults to null): set the target type used. (default: 1, possible values: 0 (relative), 1 (absolute))
• kernel (of type int?, which defaults to null): set the kernel used for measuring color difference. (default: 0, possible values: 0 (euclidean), 1 (weuclidean))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colormatrix

Ffmpeg filter: Convert color matrix.

Type:

(?src : int?, ?dst : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• src (of type int?, which defaults to null): set source color matrix. (default: -1, possible values: 0 (bt709), 1 (fcc), 2 (bt601), 2 (bt470), 2 (bt470bg), 2 (smpte170m), 3 (smpte240m), 4 (bt2020))
• dst (of type int?, which defaults to null): set destination color matrix. (default: -1, possible values: 0 (bt709), 1 (fcc), 2 (bt601), 2 (bt470), 2 (bt470bg), 2 (smpte170m), 3 (smpte240m), 4 (bt2020))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colormatrix.create

Ffmpeg filter: Convert color matrix. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?src : int?, ?dst : int?, ffmpeg.filter.graph) -> unit

Arguments:

• src (of type int?, which defaults to null): set source color matrix. (default: -1, possible values: 0 (bt709), 1 (fcc), 2 (bt601), 2 (bt470), 2 (bt470bg), 2 (smpte170m), 3 (smpte240m), 4 (bt2020))
• dst (of type int?, which defaults to null): set destination color matrix. (default: -1, possible values: 0 (bt709), 1 (fcc), 2 (bt601), 2 (bt470), 2 (bt470bg), 2 (smpte170m), 3 (smpte240m), 4 (bt2020))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorspace

Ffmpeg filter: Convert between colorspaces.

Type:

(?all : int?, ?space : int?, ?range : int?, ?primaries : int?, ?trc : int?,
 ?format : int?, ?fast : bool?, ?dither : int?, ?wpadapt : int?,
 ?clipgamut : int?, ?iall : int?, ?ispace : int?, ?irange : int?,
 ?iprimaries : int?, ?itrc : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• all (of type int?, which defaults to null): Set all color properties together. (default: 0, possible values: 1 (bt470m), 2 (bt470bg), 3 (bt601-6-525), 4 (bt601-6-625), 5 (bt709), 6 (smpte170m), 7 (smpte240m), 8 (bt2020))
• space (of type int?, which defaults to null): Output colorspace. (default: 2, possible values: 1 (bt709), 4 (fcc), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (ycgco), 0 (gbr), 9 (bt2020nc), 9 (bt2020ncl))
• range (of type int?, which defaults to null): Output color range. (default: 0, possible values: 1 (tv), 1 (mpeg), 2 (pc), 2 (jpeg))
• primaries (of type int?, which defaults to null): Output color primaries. (default: 2, possible values: 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 10 (smpte428), 8 (film), 11 (smpte431), 12 (smpte432), 9 (bt2020), 22 (jedec-p22), 22 (ebu3213), 256 (vgamut))
• trc (of type int?, which defaults to null): Output transfer characteristics. (default: 2, possible values: 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (srgb), 13 (iec61966-2-1), 11 (xvycc), 11 (iec61966-2-4), 14 (bt2020-10), 15 (bt2020-12), 256 (vlog))
• format (of type int?, which defaults to null): Output pixel format. (default: -1, possible values: 0 (yuv420p), 62 (yuv420p10), 123 (yuv420p12), 4 (yuv422p), 64 (yuv422p10), 127 (yuv422p12), 5 (yuv444p), 68 (yuv444p10), 131 (yuv444p12))
• fast (of type bool?, which defaults to null): Ignore primary chromaticity and gamma correction. (default: false)
• dither (of type int?, which defaults to null): Dithering mode. (default: 0, possible values: 0 (none), 1 (fsb))
• wpadapt (of type int?, which defaults to null): Whitepoint adaptation method. (default: 0, possible values: 0 (bradford), 1 (vonkries), 2 (identity))
• clipgamut (of type int?, which defaults to null): Controls how to clip out-of-gamut colors that arise as a result of colorspace conversion.. (default: 0, possible values: 0 (none), 1 (rgb))
• iall (of type int?, which defaults to null): Set all input color properties together. (default: 0, possible values: 1 (bt470m), 2 (bt470bg), 3 (bt601-6-525), 4 (bt601-6-625), 5 (bt709), 6 (smpte170m), 7 (smpte240m), 8 (bt2020))
• ispace (of type int?, which defaults to null): Input colorspace. (default: 2, possible values: 1 (bt709), 4 (fcc), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (ycgco), 0 (gbr), 9 (bt2020nc), 9 (bt2020ncl))
• irange (of type int?, which defaults to null): Input color range. (default: 0, possible values: 1 (tv), 1 (mpeg), 2 (pc), 2 (jpeg))
• iprimaries (of type int?, which defaults to null): Input color primaries. (default: 2, possible values: 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 10 (smpte428), 8 (film), 11 (smpte431), 12 (smpte432), 9 (bt2020), 22 (jedec-p22), 22 (ebu3213), 256 (vgamut))
• itrc (of type int?, which defaults to null): Input transfer characteristics. (default: 2, possible values: 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (srgb), 13 (iec61966-2-1), 11 (xvycc), 11 (iec61966-2-4), 14 (bt2020-10), 15 (bt2020-12), 256 (vlog))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colorspace.create

Ffmpeg filter: Convert between colorspaces. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?all : int?, ?space : int?, ?range : int?, ?primaries : int?, ?trc : int?,
 ?format : int?, ?fast : bool?, ?dither : int?, ?wpadapt : int?,
 ?clipgamut : int?, ?iall : int?, ?ispace : int?, ?irange : int?,
 ?iprimaries : int?, ?itrc : int?, ffmpeg.filter.graph) -> unit

Arguments:

• all (of type int?, which defaults to null): Set all color properties together. (default: 0, possible values: 1 (bt470m), 2 (bt470bg), 3 (bt601-6-525), 4 (bt601-6-625), 5 (bt709), 6 (smpte170m), 7 (smpte240m), 8 (bt2020))
• space (of type int?, which defaults to null): Output colorspace. (default: 2, possible values: 1 (bt709), 4 (fcc), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (ycgco), 0 (gbr), 9 (bt2020nc), 9 (bt2020ncl))
• range (of type int?, which defaults to null): Output color range. (default: 0, possible values: 1 (tv), 1 (mpeg), 2 (pc), 2 (jpeg))
• primaries (of type int?, which defaults to null): Output color primaries. (default: 2, possible values: 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 10 (smpte428), 8 (film), 11 (smpte431), 12 (smpte432), 9 (bt2020), 22 (jedec-p22), 22 (ebu3213), 256 (vgamut))
• trc (of type int?, which defaults to null): Output transfer characteristics. (default: 2, possible values: 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (srgb), 13 (iec61966-2-1), 11 (xvycc), 11 (iec61966-2-4), 14 (bt2020-10), 15 (bt2020-12), 256 (vlog))
• format (of type int?, which defaults to null): Output pixel format. (default: -1, possible values: 0 (yuv420p), 62 (yuv420p10), 123 (yuv420p12), 4 (yuv422p), 64 (yuv422p10), 127 (yuv422p12), 5 (yuv444p), 68 (yuv444p10), 131 (yuv444p12))
• fast (of type bool?, which defaults to null): Ignore primary chromaticity and gamma correction. (default: false)
• dither (of type int?, which defaults to null): Dithering mode. (default: 0, possible values: 0 (none), 1 (fsb))
• wpadapt (of type int?, which defaults to null): Whitepoint adaptation method. (default: 0, possible values: 0 (bradford), 1 (vonkries), 2 (identity))
• clipgamut (of type int?, which defaults to null): Controls how to clip out-of-gamut colors that arise as a result of colorspace conversion.. (default: 0, possible values: 0 (none), 1 (rgb))
• iall (of type int?, which defaults to null): Set all input color properties together. (default: 0, possible values: 1 (bt470m), 2 (bt470bg), 3 (bt601-6-525), 4 (bt601-6-625), 5 (bt709), 6 (smpte170m), 7 (smpte240m), 8 (bt2020))
• ispace (of type int?, which defaults to null): Input colorspace. (default: 2, possible values: 1 (bt709), 4 (fcc), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (ycgco), 0 (gbr), 9 (bt2020nc), 9 (bt2020ncl))
• irange (of type int?, which defaults to null): Input color range. (default: 0, possible values: 1 (tv), 1 (mpeg), 2 (pc), 2 (jpeg))
• iprimaries (of type int?, which defaults to null): Input color primaries. (default: 2, possible values: 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 10 (smpte428), 8 (film), 11 (smpte431), 12 (smpte432), 9 (bt2020), 22 (jedec-p22), 22 (ebu3213), 256 (vgamut))
• itrc (of type int?, which defaults to null): Input transfer characteristics. (default: 2, possible values: 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (srgb), 13 (iec61966-2-1), 11 (xvycc), 11 (iec61966-2-4), 14 (bt2020-10), 15 (bt2020-12), 256 (vlog))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colorspectrum

Ffmpeg filter: Generate colors spectrum.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?type : int?,
 ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• type (of type int?, which defaults to null): set the color spectrum type. (default: 0, possible values: 0 (black), 1 (white), 2 (all))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.colorspectrum.create

Ffmpeg filter: Generate colors spectrum. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?type : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• type (of type int?, which defaults to null): set the color spectrum type. (default: 0, possible values: 0 (black), 1 (white), 2 (all))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.colortemperature

Ffmpeg filter: Adjust color temperature of video.

Type:

(?temperature : float?, ?mix : float?, ?pl : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• temperature (of type float?, which defaults to null): set the temperature in Kelvin. (default: 6500)
• mix (of type float?, which defaults to null): set the mix with filtered output. (default: 1)
• pl (of type float?, which defaults to null): set the amount of preserving lightness. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.colortemperature.create

Ffmpeg filter: Adjust color temperature of video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?temperature : float?, ?mix : float?, ?pl : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• temperature (of type float?, which defaults to null): set the temperature in Kelvin. (default: 6500)
• mix (of type float?, which defaults to null): set the mix with filtered output. (default: 1)
• pl (of type float?, which defaults to null): set the amount of preserving lightness. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.compand

Ffmpeg filter: Compress or expand audio dynamic range.

Type:

(?attacks : string?, ?decays : string?, ?points : string?,
 ?soft-knee : float?, ?gain : float?, ?volume : float?, ?delay : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• attacks (of type string?, which defaults to null): set time over which increase of volume is determined. (default: 0)
• decays (of type string?, which defaults to null): set time over which decrease of volume is determined. (default: 0.8)
• points (of type string?, which defaults to null): set points of transfer function. (default: -70/-70|-60/-20|1/0)
• soft-knee (of type float?, which defaults to null): set soft-knee. (default: 0.01)
• gain (of type float?, which defaults to null): set output gain. (default: 0)
• volume (of type float?, which defaults to null): set initial volume. (default: 0)
• delay (of type float?, which defaults to null): set delay for samples before sending them to volume adjuster. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.compand.create

Ffmpeg filter: Compress or expand audio dynamic range. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?attacks : string?, ?decays : string?, ?points : string?,
 ?soft-knee : float?, ?gain : float?, ?volume : float?, ?delay : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• attacks (of type string?, which defaults to null): set time over which increase of volume is determined. (default: 0)
• decays (of type string?, which defaults to null): set time over which decrease of volume is determined. (default: 0.8)
• points (of type string?, which defaults to null): set points of transfer function. (default: -70/-70|-60/-20|1/0)
• soft-knee (of type float?, which defaults to null): set soft-knee. (default: 0.01)
• gain (of type float?, which defaults to null): set output gain. (default: 0)
• volume (of type float?, which defaults to null): set initial volume. (default: 0)
• delay (of type float?, which defaults to null): set delay for samples before sending them to volume adjuster. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.compensationdelay

Ffmpeg filter: Audio Compensation Delay Line.

Type:

(?mm : int?, ?cm : int?, ?m : int?, ?dry : float?, ?wet : float?,
 ?temp : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• mm (of type int?, which defaults to null): set mm distance. (default: 0)
• cm (of type int?, which defaults to null): set cm distance. (default: 0)
• m (of type int?, which defaults to null): set meter distance. (default: 0)
• dry (of type float?, which defaults to null): set dry amount. (default: 0)
• wet (of type float?, which defaults to null): set wet amount. (default: 1)
• temp (of type int?, which defaults to null): set temperature °C. (default: 20)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.compensationdelay.create

Ffmpeg filter: Audio Compensation Delay Line. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mm : int?, ?cm : int?, ?m : int?, ?dry : float?, ?wet : float?,
 ?temp : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mm (of type int?, which defaults to null): set mm distance. (default: 0)
• cm (of type int?, which defaults to null): set cm distance. (default: 0)
• m (of type int?, which defaults to null): set meter distance. (default: 0)
• dry (of type float?, which defaults to null): set dry amount. (default: 0)
• wet (of type float?, which defaults to null): set wet amount. (default: 1)
• temp (of type int?, which defaults to null): set temperature °C. (default: 20)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.concat

Ffmpeg filter: Concatenate audio and video streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?n : int?, ?v : int?, ?a : int?, ?unsafe : bool?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• n (of type int?, which defaults to null): specify the number of segments. (default: 2)
• v (of type int?, which defaults to null): specify the number of video streams. (default: 1)
• a (of type int?, which defaults to null): specify the number of audio streams. (default: 0)
• unsafe (of type bool?, which defaults to null): enable unsafe mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.concat.create

Ffmpeg filter: Concatenate audio and video streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?n : int?, ?v : int?, ?a : int?, ?unsafe : bool?, ffmpeg.filter.graph) ->
unit

Arguments:

• n (of type int?, which defaults to null): specify the number of segments. (default: 2)
• v (of type int?, which defaults to null): specify the number of video streams. (default: 1)
• a (of type int?, which defaults to null): specify the number of audio streams. (default: 0)
• unsafe (of type bool?, which defaults to null): enable unsafe mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.convolution

Ffmpeg filter: Apply convolution filter.

Type:

(?0m : string?, ?1m : string?, ?2m : string?, ?3m : string?, ?0rdiv : float?,
 ?1rdiv : float?, ?2rdiv : float?, ?3rdiv : float?, ?0bias : float?,
 ?1bias : float?, ?2bias : float?, ?3bias : float?, ?0mode : int?,
 ?1mode : int?, ?2mode : int?, ?3mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• 0m (of type string?, which defaults to null): set matrix for 1st plane. (default: 0 0 0 0 1 0 0 0 0)
• 1m (of type string?, which defaults to null): set matrix for 2nd plane. (default: 0 0 0 0 1 0 0 0 0)
• 2m (of type string?, which defaults to null): set matrix for 3rd plane. (default: 0 0 0 0 1 0 0 0 0)
• 3m (of type string?, which defaults to null): set matrix for 4th plane. (default: 0 0 0 0 1 0 0 0 0)
• 0rdiv (of type float?, which defaults to null): set rdiv for 1st plane. (default: 0)
• 1rdiv (of type float?, which defaults to null): set rdiv for 2nd plane. (default: 0)
• 2rdiv (of type float?, which defaults to null): set rdiv for 3rd plane. (default: 0)
• 3rdiv (of type float?, which defaults to null): set rdiv for 4th plane. (default: 0)
• 0bias (of type float?, which defaults to null): set bias for 1st plane. (default: 0)
• 1bias (of type float?, which defaults to null): set bias for 2nd plane. (default: 0)
• 2bias (of type float?, which defaults to null): set bias for 3rd plane. (default: 0)
• 3bias (of type float?, which defaults to null): set bias for 4th plane. (default: 0)
• 0mode (of type int?, which defaults to null): set matrix mode for 1st plane. (default: 0, possible values: 0 (square), 1 (row), 2 (column))
• 1mode (of type int?, which defaults to null): set matrix mode for 2nd plane. (default: 0, possible values: 0 (square), 1 (row), 2 (column))
• 2mode (of type int?, which defaults to null): set matrix mode for 3rd plane. (default: 0, possible values: 0 (square), 1 (row), 2 (column))
• 3mode (of type int?, which defaults to null): set matrix mode for 4th plane. (default: 0, possible values: 0 (square), 1 (row), 2 (column))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.convolution.create

Ffmpeg filter: Apply convolution filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?0m : string?, ?1m : string?, ?2m : string?, ?3m : string?, ?0rdiv : float?,
 ?1rdiv : float?, ?2rdiv : float?, ?3rdiv : float?, ?0bias : float?,
 ?1bias : float?, ?2bias : float?, ?3bias : float?, ?0mode : int?,
 ?1mode : int?, ?2mode : int?, ?3mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• 0m (of type string?, which defaults to null): set matrix for 1st plane. (default: 0 0 0 0 1 0 0 0 0)
• 1m (of type string?, which defaults to null): set matrix for 2nd plane. (default: 0 0 0 0 1 0 0 0 0)
• 2m (of type string?, which defaults to null): set matrix for 3rd plane. (default: 0 0 0 0 1 0 0 0 0)
• 3m (of type string?, which defaults to null): set matrix for 4th plane. (default: 0 0 0 0 1 0 0 0 0)
• 0rdiv (of type float?, which defaults to null): set rdiv for 1st plane. (default: 0)
• 1rdiv (of type float?, which defaults to null): set rdiv for 2nd plane. (default: 0)
• 2rdiv (of type float?, which defaults to null): set rdiv for 3rd plane. (default: 0)
• 3rdiv (of type float?, which defaults to null): set rdiv for 4th plane. (default: 0)
• 0bias (of type float?, which defaults to null): set bias for 1st plane. (default: 0)
• 1bias (of type float?, which defaults to null): set bias for 2nd plane. (default: 0)
• 2bias (of type float?, which defaults to null): set bias for 3rd plane. (default: 0)
• 3bias (of type float?, which defaults to null): set bias for 4th plane. (default: 0)
• 0mode (of type int?, which defaults to null): set matrix mode for 1st plane. (default: 0, possible values: 0 (square), 1 (row), 2 (column))
• 1mode (of type int?, which defaults to null): set matrix mode for 2nd plane. (default: 0, possible values: 0 (square), 1 (row), 2 (column))
• 2mode (of type int?, which defaults to null): set matrix mode for 3rd plane. (default: 0, possible values: 0 (square), 1 (row), 2 (column))
• 3mode (of type int?, which defaults to null): set matrix mode for 4th plane. (default: 0, possible values: 0 (square), 1 (row), 2 (column))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.convolve

Ffmpeg filter: Convolve first video stream with second video stream.

Type:

(?planes : int?, ?impulse : int?, ?noise : float?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to convolve. (default: 7)
• impulse (of type int?, which defaults to null): when to process impulses. (default: 1, possible values: 0 (first), 1 (all))
• noise (of type float?, which defaults to null): set noise. (default: 1e-07)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.convolve.create

Ffmpeg filter: Convolve first video stream with second video stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?impulse : int?, ?noise : float?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes to convolve. (default: 7)
• impulse (of type int?, which defaults to null): when to process impulses. (default: 1, possible values: 0 (first), 1 (all))
• noise (of type float?, which defaults to null): set noise. (default: 1e-07)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.copy

Ffmpeg filter: Copy the input video unchanged to the output.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.copy.create

Ffmpeg filter: Copy the input video unchanged to the output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.corr

Ffmpeg filter: Calculate the correlation between two video streams.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.corr.create

Ffmpeg filter: Calculate the correlation between two video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.cover_rect

Ffmpeg filter: Find and cover a user specified object.

Type:

(?cover : string?, ?mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• cover (of type string?, which defaults to null): cover bitmap filename
• mode (of type int?, which defaults to null): set removal mode. (default: 1, possible values: 0 (cover), 1 (blur))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.cover_rect.create

Ffmpeg filter: Find and cover a user specified object. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cover : string?, ?mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• cover (of type string?, which defaults to null): cover bitmap filename
• mode (of type int?, which defaults to null): set removal mode. (default: 1, possible values: 0 (cover), 1 (blur))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.crop

Ffmpeg filter: Crop the input video.

Type:

(?out_w : string?, ?w : string?, ?out_h : string?, ?h : string?,
 ?x : string?, ?y : string?, ?keep_aspect : bool?, ?exact : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• out_w (of type string?, which defaults to null): set the width crop area expression. (default: iw)
• w (of type string?, which defaults to null): set the width crop area expression. (default: iw)
• out_h (of type string?, which defaults to null): set the height crop area expression. (default: ih)
• h (of type string?, which defaults to null): set the height crop area expression. (default: ih)
• x (of type string?, which defaults to null): set the x crop area expression. (default: (in_w-out_w)/2)
• y (of type string?, which defaults to null): set the y crop area expression. (default: (in_h-out_h)/2)
• keep_aspect (of type bool?, which defaults to null): keep aspect ratio. (default: false)
• exact (of type bool?, which defaults to null): do exact cropping. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.crop.create

Ffmpeg filter: Crop the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?out_w : string?, ?w : string?, ?out_h : string?, ?h : string?,
 ?x : string?, ?y : string?, ?keep_aspect : bool?, ?exact : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• out_w (of type string?, which defaults to null): set the width crop area expression. (default: iw)
• w (of type string?, which defaults to null): set the width crop area expression. (default: iw)
• out_h (of type string?, which defaults to null): set the height crop area expression. (default: ih)
• h (of type string?, which defaults to null): set the height crop area expression. (default: ih)
• x (of type string?, which defaults to null): set the x crop area expression. (default: (in_w-out_w)/2)
• y (of type string?, which defaults to null): set the y crop area expression. (default: (in_h-out_h)/2)
• keep_aspect (of type bool?, which defaults to null): keep aspect ratio. (default: false)
• exact (of type bool?, which defaults to null): do exact cropping. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.cropdetect

Ffmpeg filter: Auto-detect crop size.

Type:

(?limit : float?, ?round : int?, ?reset : int?, ?skip : int?,
 ?reset_count : int?, ?max_outliers : int?, ?mode : int?, ?high : float?,
 ?low : float?, ?mv_threshold : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• limit (of type float?, which defaults to null): Threshold below which the pixel is considered black. (default: 0.09411764705882353)
• round (of type int?, which defaults to null): Value by which the width/height should be divisible. (default: 16)
• reset (of type int?, which defaults to null): Recalculate the crop area after this many frames. (default: 0)
• skip (of type int?, which defaults to null): Number of initial frames to skip. (default: 2)
• reset_count (of type int?, which defaults to null): Recalculate the crop area after this many frames. (default: 0)
• max_outliers (of type int?, which defaults to null): Threshold count of outliers. (default: 0)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (black), 1 (mvedges))
• high (of type float?, which defaults to null): Set high threshold for edge detection. (default: 0.09803921568627451)
• low (of type float?, which defaults to null): Set low threshold for edge detection. (default: 0.058823529411764705)
• mv_threshold (of type int?, which defaults to null): motion vector threshold when estimating video window size. (default: 8)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.cropdetect.create

Ffmpeg filter: Auto-detect crop size. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?limit : float?, ?round : int?, ?reset : int?, ?skip : int?,
 ?reset_count : int?, ?max_outliers : int?, ?mode : int?, ?high : float?,
 ?low : float?, ?mv_threshold : int?, ffmpeg.filter.graph) -> unit

Arguments:

• limit (of type float?, which defaults to null): Threshold below which the pixel is considered black. (default: 0.09411764705882353)
• round (of type int?, which defaults to null): Value by which the width/height should be divisible. (default: 16)
• reset (of type int?, which defaults to null): Recalculate the crop area after this many frames. (default: 0)
• skip (of type int?, which defaults to null): Number of initial frames to skip. (default: 2)
• reset_count (of type int?, which defaults to null): Recalculate the crop area after this many frames. (default: 0)
• max_outliers (of type int?, which defaults to null): Threshold count of outliers. (default: 0)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (black), 1 (mvedges))
• high (of type float?, which defaults to null): Set high threshold for edge detection. (default: 0.09803921568627451)
• low (of type float?, which defaults to null): Set low threshold for edge detection. (default: 0.058823529411764705)
• mv_threshold (of type int?, which defaults to null): motion vector threshold when estimating video window size. (default: 8)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.crossfeed

Ffmpeg filter: Apply headphone crossfeed filter.

Type:

(?strength : float?, ?range : float?, ?slope : float?, ?level_in : float?,
 ?level_out : float?, ?block_size : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• strength (of type float?, which defaults to null): set crossfeed strength. (default: 0.2)
• range (of type float?, which defaults to null): set soundstage wideness. (default: 0.5)
• slope (of type float?, which defaults to null): set curve slope. (default: 0.5)
• level_in (of type float?, which defaults to null): set level in. (default: 0.9)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• block_size (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.crossfeed.create

Ffmpeg filter: Apply headphone crossfeed filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?strength : float?, ?range : float?, ?slope : float?, ?level_in : float?,
 ?level_out : float?, ?block_size : int?, ffmpeg.filter.graph) -> unit

Arguments:

• strength (of type float?, which defaults to null): set crossfeed strength. (default: 0.2)
• range (of type float?, which defaults to null): set soundstage wideness. (default: 0.5)
• slope (of type float?, which defaults to null): set curve slope. (default: 0.5)
• level_in (of type float?, which defaults to null): set level in. (default: 0.9)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• block_size (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.crystalizer

Ffmpeg filter: Simple audio noise sharpening filter.

Type:

(?i : float?, ?c : bool?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• i (of type float?, which defaults to null): set intensity. (default: 2)
• c (of type bool?, which defaults to null): enable clipping. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.crystalizer.create

Ffmpeg filter: Simple audio noise sharpening filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?i : float?, ?c : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• i (of type float?, which defaults to null): set intensity. (default: 2)
• c (of type bool?, which defaults to null): enable clipping. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.cue

Ffmpeg filter: Delay filtering to match a cue.

Type:

(?cue : int?, ?preroll : int?, ?buffer : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• cue (of type int?, which defaults to null): cue unix timestamp in microseconds. (default: 0)
• preroll (of type int?, which defaults to null): preroll duration in seconds. (default: 0)
• buffer (of type int?, which defaults to null): buffer duration in seconds. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.cue.create

Ffmpeg filter: Delay filtering to match a cue. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cue : int?, ?preroll : int?, ?buffer : int?, ffmpeg.filter.graph) -> unit

Arguments:

• cue (of type int?, which defaults to null): cue unix timestamp in microseconds. (default: 0)
• preroll (of type int?, which defaults to null): preroll duration in seconds. (default: 0)
• buffer (of type int?, which defaults to null): buffer duration in seconds. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.curves

Ffmpeg filter: Adjust components curves.

Type:

(?preset : int?, ?master : string?, ?m : string?, ?red : string?,
 ?r : string?, ?green : string?, ?g : string?, ?blue : string?, ?b : string?,
 ?all : string?, ?psfile : string?, ?plot : string?, ?interp : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• preset (of type int?, which defaults to null): select a color curves preset. (default: 0, possible values: 0 (none), 1 (color_negative), 2 (cross_process), 3 (darker), 4 (increase_contrast), 5 (lighter), 6 (linear_contrast), 7 (medium_contrast), 8 (negative), 9 (strong_contrast), 10 (vintage))
• master (of type string?, which defaults to null): set master points coordinates
• m (of type string?, which defaults to null): set master points coordinates
• red (of type string?, which defaults to null): set red points coordinates
• r (of type string?, which defaults to null): set red points coordinates
• green (of type string?, which defaults to null): set green points coordinates
• g (of type string?, which defaults to null): set green points coordinates
• blue (of type string?, which defaults to null): set blue points coordinates
• b (of type string?, which defaults to null): set blue points coordinates
• all (of type string?, which defaults to null): set points coordinates for all components
• psfile (of type string?, which defaults to null): set Photoshop curves file name
• plot (of type string?, which defaults to null): save Gnuplot script of the curves in specified file
• interp (of type int?, which defaults to null): specify the kind of interpolation. (default: 0, possible values: 0 (natural), 1 (pchip))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.curves.create

Ffmpeg filter: Adjust components curves. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?preset : int?, ?master : string?, ?m : string?, ?red : string?,
 ?r : string?, ?green : string?, ?g : string?, ?blue : string?, ?b : string?,
 ?all : string?, ?psfile : string?, ?plot : string?, ?interp : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• preset (of type int?, which defaults to null): select a color curves preset. (default: 0, possible values: 0 (none), 1 (color_negative), 2 (cross_process), 3 (darker), 4 (increase_contrast), 5 (lighter), 6 (linear_contrast), 7 (medium_contrast), 8 (negative), 9 (strong_contrast), 10 (vintage))
• master (of type string?, which defaults to null): set master points coordinates
• m (of type string?, which defaults to null): set master points coordinates
• red (of type string?, which defaults to null): set red points coordinates
• r (of type string?, which defaults to null): set red points coordinates
• green (of type string?, which defaults to null): set green points coordinates
• g (of type string?, which defaults to null): set green points coordinates
• blue (of type string?, which defaults to null): set blue points coordinates
• b (of type string?, which defaults to null): set blue points coordinates
• all (of type string?, which defaults to null): set points coordinates for all components
• psfile (of type string?, which defaults to null): set Photoshop curves file name
• plot (of type string?, which defaults to null): save Gnuplot script of the curves in specified file
• interp (of type int?, which defaults to null): specify the kind of interpolation. (default: 0, possible values: 0 (natural), 1 (pchip))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.datascope

Ffmpeg filter: Video data analysis.

Type:

(?size : string?, ?s : string?, ?x : int?, ?y : int?, ?mode : int?,
 ?axis : bool?, ?opacity : float?, ?format : int?, ?components : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set output size. (default: hd720)
• s (of type string?, which defaults to null): set output size. (default: hd720)
• x (of type int?, which defaults to null): set x offset. (default: 0)
• y (of type int?, which defaults to null): set y offset. (default: 0)
• mode (of type int?, which defaults to null): set scope mode. (default: 0, possible values: 0 (mono), 1 (color), 2 (color2))
• axis (of type bool?, which defaults to null): draw column/row numbers. (default: false)
• opacity (of type float?, which defaults to null): set background opacity. (default: 0.75)
• format (of type int?, which defaults to null): set display number format. (default: 0, possible values: 0 (hex), 1 (dec))
• components (of type int?, which defaults to null): set components to display. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.datascope.create

Ffmpeg filter: Video data analysis. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?x : int?, ?y : int?, ?mode : int?,
 ?axis : bool?, ?opacity : float?, ?format : int?, ?components : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set output size. (default: hd720)
• s (of type string?, which defaults to null): set output size. (default: hd720)
• x (of type int?, which defaults to null): set x offset. (default: 0)
• y (of type int?, which defaults to null): set y offset. (default: 0)
• mode (of type int?, which defaults to null): set scope mode. (default: 0, possible values: 0 (mono), 1 (color), 2 (color2))
• axis (of type bool?, which defaults to null): draw column/row numbers. (default: false)
• opacity (of type float?, which defaults to null): set background opacity. (default: 0.75)
• format (of type int?, which defaults to null): set display number format. (default: 0, possible values: 0 (hex), 1 (dec))
• components (of type int?, which defaults to null): set components to display. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.dblur

Ffmpeg filter: Apply Directional Blur filter.

Type:

(?angle : float?, ?radius : float?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• angle (of type float?, which defaults to null): set angle. (default: 45)
• radius (of type float?, which defaults to null): set radius. (default: 5)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.dblur.create

Ffmpeg filter: Apply Directional Blur filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?angle : float?, ?radius : float?, ?planes : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• angle (of type float?, which defaults to null): set angle. (default: 45)
• radius (of type float?, which defaults to null): set radius. (default: 5)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.dcshift

Ffmpeg filter: Apply a DC shift to the audio.

Type:

(?shift : float?, ?limitergain : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• shift (of type float?, which defaults to null): set DC shift. (default: 0)
• limitergain (of type float?, which defaults to null): set limiter gain. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.dcshift.create

Ffmpeg filter: Apply a DC shift to the audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?shift : float?, ?limitergain : float?, ffmpeg.filter.graph) -> unit

Arguments:

• shift (of type float?, which defaults to null): set DC shift. (default: 0)
• limitergain (of type float?, which defaults to null): set limiter gain. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.dctdnoiz

Ffmpeg filter: Denoise frames using 2D DCT.

Type:

(?sigma : float?, ?s : float?, ?overlap : int?, ?expr : string?,
 ?e : string?, ?n : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• sigma (of type float?, which defaults to null): set noise sigma constant. (default: 0)
• s (of type float?, which defaults to null): set noise sigma constant. (default: 0)
• overlap (of type int?, which defaults to null): set number of block overlapping pixels. (default: -1)
• expr (of type string?, which defaults to null): set coefficient factor expression
• e (of type string?, which defaults to null): set coefficient factor expression
• n (of type int?, which defaults to null): set the block size, expressed in bits. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.dctdnoiz.create

Ffmpeg filter: Denoise frames using 2D DCT. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sigma : float?, ?s : float?, ?overlap : int?, ?expr : string?,
 ?e : string?, ?n : int?, ffmpeg.filter.graph) -> unit

Arguments:

• sigma (of type float?, which defaults to null): set noise sigma constant. (default: 0)
• s (of type float?, which defaults to null): set noise sigma constant. (default: 0)
• overlap (of type int?, which defaults to null): set number of block overlapping pixels. (default: -1)
• expr (of type string?, which defaults to null): set coefficient factor expression
• e (of type string?, which defaults to null): set coefficient factor expression
• n (of type int?, which defaults to null): set the block size, expressed in bits. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.deband

Ffmpeg filter: Debands video.

Type:

(?1thr : float?, ?2thr : float?, ?3thr : float?, ?4thr : float?,
 ?range : int?, ?r : int?, ?direction : float?, ?d : float?, ?blur : bool?,
 ?b : bool?, ?coupling : bool?, ?c : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• 1thr (of type float?, which defaults to null): set 1st plane threshold. (default: 0.02)
• 2thr (of type float?, which defaults to null): set 2nd plane threshold. (default: 0.02)
• 3thr (of type float?, which defaults to null): set 3rd plane threshold. (default: 0.02)
• 4thr (of type float?, which defaults to null): set 4th plane threshold. (default: 0.02)
• range (of type int?, which defaults to null): set range. (default: 16)
• r (of type int?, which defaults to null): set range. (default: 16)
• direction (of type float?, which defaults to null): set direction. (default: 6.283185307179586)
• d (of type float?, which defaults to null): set direction. (default: 6.283185307179586)
• blur (of type bool?, which defaults to null): set blur. (default: true)
• b (of type bool?, which defaults to null): set blur. (default: true)
• coupling (of type bool?, which defaults to null): set plane coupling. (default: false)
• c (of type bool?, which defaults to null): set plane coupling. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.deband.create

Ffmpeg filter: Debands video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?1thr : float?, ?2thr : float?, ?3thr : float?, ?4thr : float?,
 ?range : int?, ?r : int?, ?direction : float?, ?d : float?, ?blur : bool?,
 ?b : bool?, ?coupling : bool?, ?c : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• 1thr (of type float?, which defaults to null): set 1st plane threshold. (default: 0.02)
• 2thr (of type float?, which defaults to null): set 2nd plane threshold. (default: 0.02)
• 3thr (of type float?, which defaults to null): set 3rd plane threshold. (default: 0.02)
• 4thr (of type float?, which defaults to null): set 4th plane threshold. (default: 0.02)
• range (of type int?, which defaults to null): set range. (default: 16)
• r (of type int?, which defaults to null): set range. (default: 16)
• direction (of type float?, which defaults to null): set direction. (default: 6.283185307179586)
• d (of type float?, which defaults to null): set direction. (default: 6.283185307179586)
• blur (of type bool?, which defaults to null): set blur. (default: true)
• b (of type bool?, which defaults to null): set blur. (default: true)
• coupling (of type bool?, which defaults to null): set plane coupling. (default: false)
• c (of type bool?, which defaults to null): set plane coupling. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.deblock

Ffmpeg filter: Deblock video.

Type:

(?filter : int?, ?block : int?, ?alpha : float?, ?beta : float?,
 ?gamma : float?, ?delta : float?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• filter (of type int?, which defaults to null): set type of filter. (default: 1, possible values: 0 (weak), 1 (strong))
• block (of type int?, which defaults to null): set size of block. (default: 8)
• alpha (of type float?, which defaults to null): set 1st detection threshold. (default: 0.098)
• beta (of type float?, which defaults to null): set 2nd detection threshold. (default: 0.05)
• gamma (of type float?, which defaults to null): set 3rd detection threshold. (default: 0.05)
• delta (of type float?, which defaults to null): set 4th detection threshold. (default: 0.05)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.deblock.create

Ffmpeg filter: Deblock video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filter : int?, ?block : int?, ?alpha : float?, ?beta : float?,
 ?gamma : float?, ?delta : float?, ?planes : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• filter (of type int?, which defaults to null): set type of filter. (default: 1, possible values: 0 (weak), 1 (strong))
• block (of type int?, which defaults to null): set size of block. (default: 8)
• alpha (of type float?, which defaults to null): set 1st detection threshold. (default: 0.098)
• beta (of type float?, which defaults to null): set 2nd detection threshold. (default: 0.05)
• gamma (of type float?, which defaults to null): set 3rd detection threshold. (default: 0.05)
• delta (of type float?, which defaults to null): set 4th detection threshold. (default: 0.05)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.decimate

Ffmpeg filter: Decimate frames (post field matching filter). This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?cycle : int?, ?dupthresh : float?, ?scthresh : float?, ?blockx : int?,
 ?blocky : int?, ?ppsrc : bool?, ?chroma : bool?, ?mixed : bool?,
 ffmpeg.filter.graph, [ffmpeg.filter.audio], [ffmpeg.filter.video]) ->
ffmpeg.filter.video

Arguments:

• cycle (of type int?, which defaults to null): set the number of frame from which one will be dropped. (default: 5)
• dupthresh (of type float?, which defaults to null): set duplicate threshold. (default: 1.1)
• scthresh (of type float?, which defaults to null): set scene change threshold. (default: 15)
• blockx (of type int?, which defaults to null): set the size of the x-axis blocks used during metric calculations. (default: 32)
• blocky (of type int?, which defaults to null): set the size of the y-axis blocks used during metric calculations. (default: 32)
• ppsrc (of type bool?, which defaults to null): mark main input as a pre-processed input and activate clean source input stream. (default: false)
• chroma (of type bool?, which defaults to null): set whether or not chroma is considered in the metric calculations. (default: true)
• mixed (of type bool?, which defaults to null): set whether or not the input only partially contains content to be decimated. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.decimate.create

Ffmpeg filter: Decimate frames (post field matching filter). This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cycle : int?, ?dupthresh : float?, ?scthresh : float?, ?blockx : int?,
 ?blocky : int?, ?ppsrc : bool?, ?chroma : bool?, ?mixed : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• cycle (of type int?, which defaults to null): set the number of frame from which one will be dropped. (default: 5)
• dupthresh (of type float?, which defaults to null): set duplicate threshold. (default: 1.1)
• scthresh (of type float?, which defaults to null): set scene change threshold. (default: 15)
• blockx (of type int?, which defaults to null): set the size of the x-axis blocks used during metric calculations. (default: 32)
• blocky (of type int?, which defaults to null): set the size of the y-axis blocks used during metric calculations. (default: 32)
• ppsrc (of type bool?, which defaults to null): mark main input as a pre-processed input and activate clean source input stream. (default: false)
• chroma (of type bool?, which defaults to null): set whether or not chroma is considered in the metric calculations. (default: true)
• mixed (of type bool?, which defaults to null): set whether or not the input only partially contains content to be decimated. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.deconvolve

Ffmpeg filter: Deconvolve first video stream with second video stream.

Type:

(?planes : int?, ?impulse : int?, ?noise : float?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to deconvolve. (default: 7)
• impulse (of type int?, which defaults to null): when to process impulses. (default: 1, possible values: 0 (first), 1 (all))
• noise (of type float?, which defaults to null): set noise. (default: 1e-07)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.deconvolve.create

Ffmpeg filter: Deconvolve first video stream with second video stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?impulse : int?, ?noise : float?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes to deconvolve. (default: 7)
• impulse (of type int?, which defaults to null): when to process impulses. (default: 1, possible values: 0 (first), 1 (all))
• noise (of type float?, which defaults to null): set noise. (default: 1e-07)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.dedot

Ffmpeg filter: Reduce cross-luminance and cross-color.

Type:

(?m : int?, ?lt : float?, ?tl : float?, ?tc : float?, ?ct : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• m (of type int?, which defaults to null): set filtering mode. (default: 3, possible values: 1 (dotcrawl), 2 (rainbows), combined by addition)
• lt (of type float?, which defaults to null): set spatial luma threshold. (default: 0.079)
• tl (of type float?, which defaults to null): set tolerance for temporal luma. (default: 0.079)
• tc (of type float?, which defaults to null): set tolerance for chroma temporal variation. (default: 0.058)
• ct (of type float?, which defaults to null): set temporal chroma threshold. (default: 0.019)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.dedot.create

Ffmpeg filter: Reduce cross-luminance and cross-color. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?m : int?, ?lt : float?, ?tl : float?, ?tc : float?, ?ct : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• m (of type int?, which defaults to null): set filtering mode. (default: 3, possible values: 1 (dotcrawl), 2 (rainbows), combined by addition)
• lt (of type float?, which defaults to null): set spatial luma threshold. (default: 0.079)
• tl (of type float?, which defaults to null): set tolerance for temporal luma. (default: 0.079)
• tc (of type float?, which defaults to null): set tolerance for chroma temporal variation. (default: 0.058)
• ct (of type float?, which defaults to null): set temporal chroma threshold. (default: 0.019)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.deesser

Ffmpeg filter: Apply de-essing to the audio.

Type:

(?i : float?, ?m : float?, ?f : float?, ?s : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• i (of type float?, which defaults to null): set intensity. (default: 0)
• m (of type float?, which defaults to null): set max deessing. (default: 0.5)
• f (of type float?, which defaults to null): set frequency. (default: 0.5)
• s (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (e))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.deesser.create

Ffmpeg filter: Apply de-essing to the audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?i : float?, ?m : float?, ?f : float?, ?s : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• i (of type float?, which defaults to null): set intensity. (default: 0)
• m (of type float?, which defaults to null): set max deessing. (default: 0.5)
• f (of type float?, which defaults to null): set frequency. (default: 0.5)
• s (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (e))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.deflate

Ffmpeg filter: Apply deflate effect.

Type:

(?threshold0 : int?, ?threshold1 : int?, ?threshold2 : int?,
 ?threshold3 : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• threshold0 (of type int?, which defaults to null): set threshold for 1st plane. (default: 65535)
• threshold1 (of type int?, which defaults to null): set threshold for 2nd plane. (default: 65535)
• threshold2 (of type int?, which defaults to null): set threshold for 3rd plane. (default: 65535)
• threshold3 (of type int?, which defaults to null): set threshold for 4th plane. (default: 65535)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.deflate.create

Ffmpeg filter: Apply deflate effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold0 : int?, ?threshold1 : int?, ?threshold2 : int?,
 ?threshold3 : int?, ffmpeg.filter.graph) -> unit

Arguments:

• threshold0 (of type int?, which defaults to null): set threshold for 1st plane. (default: 65535)
• threshold1 (of type int?, which defaults to null): set threshold for 2nd plane. (default: 65535)
• threshold2 (of type int?, which defaults to null): set threshold for 3rd plane. (default: 65535)
• threshold3 (of type int?, which defaults to null): set threshold for 4th plane. (default: 65535)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.deflicker

Ffmpeg filter: Remove temporal frame luminance variations.

Type:

(?size : int?, ?s : int?, ?mode : int?, ?m : int?, ?bypass : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• size (of type int?, which defaults to null): set how many frames to use. (default: 5)
• s (of type int?, which defaults to null): set how many frames to use. (default: 5)
• mode (of type int?, which defaults to null): set how to smooth luminance. (default: 0, possible values: 0 (am), 1 (gm), 2 (hm), 3 (qm), 4 (cm), 5 (pm), 6 (median))
• m (of type int?, which defaults to null): set how to smooth luminance. (default: 0, possible values: 0 (am), 1 (gm), 2 (hm), 3 (qm), 4 (cm), 5 (pm), 6 (median))
• bypass (of type bool?, which defaults to null): leave frames unchanged. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.deflicker.create

Ffmpeg filter: Remove temporal frame luminance variations. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : int?, ?s : int?, ?mode : int?, ?m : int?, ?bypass : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type int?, which defaults to null): set how many frames to use. (default: 5)
• s (of type int?, which defaults to null): set how many frames to use. (default: 5)
• mode (of type int?, which defaults to null): set how to smooth luminance. (default: 0, possible values: 0 (am), 1 (gm), 2 (hm), 3 (qm), 4 (cm), 5 (pm), 6 (median))
• m (of type int?, which defaults to null): set how to smooth luminance. (default: 0, possible values: 0 (am), 1 (gm), 2 (hm), 3 (qm), 4 (cm), 5 (pm), 6 (median))
• bypass (of type bool?, which defaults to null): leave frames unchanged. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.dejudder

Ffmpeg filter: Remove judder produced by pullup.

Type:

(?cycle : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• cycle (of type int?, which defaults to null): set the length of the cycle to use for dejuddering. (default: 4)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.dejudder.create

Ffmpeg filter: Remove judder produced by pullup. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cycle : int?, ffmpeg.filter.graph) -> unit

Arguments:

• cycle (of type int?, which defaults to null): set the length of the cycle to use for dejuddering. (default: 4)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.delogo

Ffmpeg filter: Remove logo from input video.

Type:

(?x : string?, ?y : string?, ?w : string?, ?h : string?, ?show : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• x (of type string?, which defaults to null): set logo x position. (default: -1)
• y (of type string?, which defaults to null): set logo y position. (default: -1)
• w (of type string?, which defaults to null): set logo width. (default: -1)
• h (of type string?, which defaults to null): set logo height. (default: -1)
• show (of type bool?, which defaults to null): show delogo area. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.delogo.create

Ffmpeg filter: Remove logo from input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : string?, ?y : string?, ?w : string?, ?h : string?, ?show : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• x (of type string?, which defaults to null): set logo x position. (default: -1)
• y (of type string?, which defaults to null): set logo y position. (default: -1)
• w (of type string?, which defaults to null): set logo width. (default: -1)
• h (of type string?, which defaults to null): set logo height. (default: -1)
• show (of type bool?, which defaults to null): show delogo area. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.deshake

Ffmpeg filter: Stabilize shaky video.

Type:

(?x : int?, ?y : int?, ?w : int?, ?h : int?, ?rx : int?, ?ry : int?,
 ?edge : int?, ?blocksize : int?, ?contrast : int?, ?search : int?,
 ?filename : string?, ?opencl : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• x (of type int?, which defaults to null): set x for the rectangular search area. (default: -1)
• y (of type int?, which defaults to null): set y for the rectangular search area. (default: -1)
• w (of type int?, which defaults to null): set width for the rectangular search area. (default: -1)
• h (of type int?, which defaults to null): set height for the rectangular search area. (default: -1)
• rx (of type int?, which defaults to null): set x for the rectangular search area. (default: 16)
• ry (of type int?, which defaults to null): set y for the rectangular search area. (default: 16)
• edge (of type int?, which defaults to null): set edge mode. (default: 3, possible values: 0 (blank), 1 (original), 2 (clamp), 3 (mirror))
• blocksize (of type int?, which defaults to null): set motion search blocksize. (default: 8)
• contrast (of type int?, which defaults to null): set contrast threshold for blocks. (default: 125)
• search (of type int?, which defaults to null): set search strategy. (default: 0, possible values: 0 (exhaustive), 1 (less))
• filename (of type string?, which defaults to null): set motion search detailed log file name
• opencl (of type bool?, which defaults to null): ignored. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.deshake.create

Ffmpeg filter: Stabilize shaky video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : int?, ?y : int?, ?w : int?, ?h : int?, ?rx : int?, ?ry : int?,
 ?edge : int?, ?blocksize : int?, ?contrast : int?, ?search : int?,
 ?filename : string?, ?opencl : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• x (of type int?, which defaults to null): set x for the rectangular search area. (default: -1)
• y (of type int?, which defaults to null): set y for the rectangular search area. (default: -1)
• w (of type int?, which defaults to null): set width for the rectangular search area. (default: -1)
• h (of type int?, which defaults to null): set height for the rectangular search area. (default: -1)
• rx (of type int?, which defaults to null): set x for the rectangular search area. (default: 16)
• ry (of type int?, which defaults to null): set y for the rectangular search area. (default: 16)
• edge (of type int?, which defaults to null): set edge mode. (default: 3, possible values: 0 (blank), 1 (original), 2 (clamp), 3 (mirror))
• blocksize (of type int?, which defaults to null): set motion search blocksize. (default: 8)
• contrast (of type int?, which defaults to null): set contrast threshold for blocks. (default: 125)
• search (of type int?, which defaults to null): set search strategy. (default: 0, possible values: 0 (exhaustive), 1 (less))
• filename (of type string?, which defaults to null): set motion search detailed log file name
• opencl (of type bool?, which defaults to null): ignored. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.despill

Ffmpeg filter: Despill video.

Type:

(?type : int?, ?mix : float?, ?expand : float?, ?red : float?,
 ?green : float?, ?blue : float?, ?brightness : float?, ?alpha : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• type (of type int?, which defaults to null): set the screen type. (default: 0, possible values: 0 (green), 1 (blue))
• mix (of type float?, which defaults to null): set the spillmap mix. (default: 0.5)
• expand (of type float?, which defaults to null): set the spillmap expand. (default: 0)
• red (of type float?, which defaults to null): set red scale. (default: 0)
• green (of type float?, which defaults to null): set green scale. (default: -1)
• blue (of type float?, which defaults to null): set blue scale. (default: 0)
• brightness (of type float?, which defaults to null): set brightness. (default: 0)
• alpha (of type bool?, which defaults to null): change alpha component. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.despill.create

Ffmpeg filter: Despill video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?type : int?, ?mix : float?, ?expand : float?, ?red : float?,
 ?green : float?, ?blue : float?, ?brightness : float?, ?alpha : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• type (of type int?, which defaults to null): set the screen type. (default: 0, possible values: 0 (green), 1 (blue))
• mix (of type float?, which defaults to null): set the spillmap mix. (default: 0.5)
• expand (of type float?, which defaults to null): set the spillmap expand. (default: 0)
• red (of type float?, which defaults to null): set red scale. (default: 0)
• green (of type float?, which defaults to null): set green scale. (default: -1)
• blue (of type float?, which defaults to null): set blue scale. (default: 0)
• brightness (of type float?, which defaults to null): set brightness. (default: 0)
• alpha (of type bool?, which defaults to null): change alpha component. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.detelecine

Ffmpeg filter: Apply an inverse telecine pattern.

Type:

(?first_field : int?, ?pattern : string?, ?start_frame : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• first_field (of type int?, which defaults to null): select first field. (default: 0, possible values: 0 (top), 0 (t), 1 (bottom), 1 (b))
• pattern (of type string?, which defaults to null): pattern that describe for how many fields a frame is to be displayed. (default: 23)
• start_frame (of type int?, which defaults to null): position of first frame with respect to the pattern if stream is cut. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.detelecine.create

Ffmpeg filter: Apply an inverse telecine pattern. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?first_field : int?, ?pattern : string?, ?start_frame : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• first_field (of type int?, which defaults to null): select first field. (default: 0, possible values: 0 (top), 0 (t), 1 (bottom), 1 (b))
• pattern (of type string?, which defaults to null): pattern that describe for how many fields a frame is to be displayed. (default: 23)
• start_frame (of type int?, which defaults to null): position of first frame with respect to the pattern if stream is cut. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.dialoguenhance

Ffmpeg filter: Audio Dialogue Enhancement.

Type:

(?original : float?, ?enhance : float?, ?voice : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• original (of type float?, which defaults to null): set original center factor. (default: 1)
• enhance (of type float?, which defaults to null): set dialogue enhance factor. (default: 1)
• voice (of type float?, which defaults to null): set voice detection factor. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.dialoguenhance.create

Ffmpeg filter: Audio Dialogue Enhancement. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?original : float?, ?enhance : float?, ?voice : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• original (of type float?, which defaults to null): set original center factor. (default: 1)
• enhance (of type float?, which defaults to null): set dialogue enhance factor. (default: 1)
• voice (of type float?, which defaults to null): set voice detection factor. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.dilation

Ffmpeg filter: Apply dilation effect.

Type:

(?coordinates : int?, ?threshold0 : int?, ?threshold1 : int?,
 ?threshold2 : int?, ?threshold3 : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• coordinates (of type int?, which defaults to null): set coordinates. (default: 255)
• threshold0 (of type int?, which defaults to null): set threshold for 1st plane. (default: 65535)
• threshold1 (of type int?, which defaults to null): set threshold for 2nd plane. (default: 65535)
• threshold2 (of type int?, which defaults to null): set threshold for 3rd plane. (default: 65535)
• threshold3 (of type int?, which defaults to null): set threshold for 4th plane. (default: 65535)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.dilation.create

Ffmpeg filter: Apply dilation effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?coordinates : int?, ?threshold0 : int?, ?threshold1 : int?,
 ?threshold2 : int?, ?threshold3 : int?, ffmpeg.filter.graph) -> unit

Arguments:

• coordinates (of type int?, which defaults to null): set coordinates. (default: 255)
• threshold0 (of type int?, which defaults to null): set threshold for 1st plane. (default: 65535)
• threshold1 (of type int?, which defaults to null): set threshold for 2nd plane. (default: 65535)
• threshold2 (of type int?, which defaults to null): set threshold for 3rd plane. (default: 65535)
• threshold3 (of type int?, which defaults to null): set threshold for 4th plane. (default: 65535)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.displace

Ffmpeg filter: Displace pixels.

Type:

(?edge : int?, ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• edge (of type int?, which defaults to null): set edge mode. (default: 1, possible values: 0 (blank), 1 (smear), 2 (wrap), 3 (mirror))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.displace.create

Ffmpeg filter: Displace pixels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?edge : int?, ffmpeg.filter.graph) -> unit

Arguments:

• edge (of type int?, which defaults to null): set edge mode. (default: 1, possible values: 0 (blank), 1 (smear), 2 (wrap), 3 (mirror))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.doubleweave

Ffmpeg filter: Weave input video fields into double number of frames.

Type:

(?first_field : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• first_field (of type int?, which defaults to null): set first field. (default: 0, possible values: 0 (top), 0 (t), 1 (bottom), 1 (b))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.doubleweave.create

Ffmpeg filter: Weave input video fields into double number of frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?first_field : int?, ffmpeg.filter.graph) -> unit

Arguments:

• first_field (of type int?, which defaults to null): set first field. (default: 0, possible values: 0 (top), 0 (t), 1 (bottom), 1 (b))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.drawbox

Ffmpeg filter: Draw a colored box on the input video.

Type:

(?x : string?, ?y : string?, ?width : string?, ?w : string?,
 ?height : string?, ?h : string?, ?color : string?, ?c : string?,
 ?thickness : string?, ?t : string?, ?replace : bool?, ?box_source : string?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• x (of type string?, which defaults to null): set horizontal position of the left box edge. (default: 0)
• y (of type string?, which defaults to null): set vertical position of the top box edge. (default: 0)
• width (of type string?, which defaults to null): set width of the box. (default: 0)
• w (of type string?, which defaults to null): set width of the box. (default: 0)
• height (of type string?, which defaults to null): set height of the box. (default: 0)
• h (of type string?, which defaults to null): set height of the box. (default: 0)
• color (of type string?, which defaults to null): set color of the box. (default: black)
• c (of type string?, which defaults to null): set color of the box. (default: black)
• thickness (of type string?, which defaults to null): set the box thickness. (default: 3)
• t (of type string?, which defaults to null): set the box thickness. (default: 3)
• replace (of type bool?, which defaults to null): replace color & alpha. (default: false)
• box_source (of type string?, which defaults to null): use data from bounding box in side data
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.drawbox.create

Ffmpeg filter: Draw a colored box on the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : string?, ?y : string?, ?width : string?, ?w : string?,
 ?height : string?, ?h : string?, ?color : string?, ?c : string?,
 ?thickness : string?, ?t : string?, ?replace : bool?, ?box_source : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• x (of type string?, which defaults to null): set horizontal position of the left box edge. (default: 0)
• y (of type string?, which defaults to null): set vertical position of the top box edge. (default: 0)
• width (of type string?, which defaults to null): set width of the box. (default: 0)
• w (of type string?, which defaults to null): set width of the box. (default: 0)
• height (of type string?, which defaults to null): set height of the box. (default: 0)
• h (of type string?, which defaults to null): set height of the box. (default: 0)
• color (of type string?, which defaults to null): set color of the box. (default: black)
• c (of type string?, which defaults to null): set color of the box. (default: black)
• thickness (of type string?, which defaults to null): set the box thickness. (default: 3)
• t (of type string?, which defaults to null): set the box thickness. (default: 3)
• replace (of type bool?, which defaults to null): replace color & alpha. (default: false)
• box_source (of type string?, which defaults to null): use data from bounding box in side data
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.drawgraph

Ffmpeg filter: Draw a graph using input video metadata.

Type:

(?m1 : string?, ?fg1 : string?, ?m2 : string?, ?fg2 : string?, ?m3 : string?,
 ?fg3 : string?, ?m4 : string?, ?fg4 : string?, ?bg : string?, ?min : float?,
 ?max : float?, ?mode : int?, ?slide : int?, ?size : string?, ?s : string?,
 ?rate : string?, ?r : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• m1 (of type string?, which defaults to null): set 1st metadata key. (default: )
• fg1 (of type string?, which defaults to null): set 1st foreground color expression. (default: 0xffff0000)
• m2 (of type string?, which defaults to null): set 2nd metadata key. (default: )
• fg2 (of type string?, which defaults to null): set 2nd foreground color expression. (default: 0xff00ff00)
• m3 (of type string?, which defaults to null): set 3rd metadata key. (default: )
• fg3 (of type string?, which defaults to null): set 3rd foreground color expression. (default: 0xffff00ff)
• m4 (of type string?, which defaults to null): set 4th metadata key. (default: )
• fg4 (of type string?, which defaults to null): set 4th foreground color expression. (default: 0xffffff00)
• bg (of type string?, which defaults to null): set background color. (default: white)
• min (of type float?, which defaults to null): set minimal value. (default: -1)
• max (of type float?, which defaults to null): set maximal value. (default: 1)
• mode (of type int?, which defaults to null): set graph mode. (default: 2, possible values: 0 (bar), 1 (dot), 2 (line))
• slide (of type int?, which defaults to null): set slide mode. (default: 0, possible values: 0 (frame), 1 (replace), 2 (scroll), 3 (rscroll), 4 (picture))
• size (of type string?, which defaults to null): set graph size. (default: 900x256)
• s (of type string?, which defaults to null): set graph size. (default: 900x256)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.drawgraph.create

Ffmpeg filter: Draw a graph using input video metadata. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?m1 : string?, ?fg1 : string?, ?m2 : string?, ?fg2 : string?, ?m3 : string?,
 ?fg3 : string?, ?m4 : string?, ?fg4 : string?, ?bg : string?, ?min : float?,
 ?max : float?, ?mode : int?, ?slide : int?, ?size : string?, ?s : string?,
 ?rate : string?, ?r : string?, ffmpeg.filter.graph) -> unit

Arguments:

• m1 (of type string?, which defaults to null): set 1st metadata key. (default: )
• fg1 (of type string?, which defaults to null): set 1st foreground color expression. (default: 0xffff0000)
• m2 (of type string?, which defaults to null): set 2nd metadata key. (default: )
• fg2 (of type string?, which defaults to null): set 2nd foreground color expression. (default: 0xff00ff00)
• m3 (of type string?, which defaults to null): set 3rd metadata key. (default: )
• fg3 (of type string?, which defaults to null): set 3rd foreground color expression. (default: 0xffff00ff)
• m4 (of type string?, which defaults to null): set 4th metadata key. (default: )
• fg4 (of type string?, which defaults to null): set 4th foreground color expression. (default: 0xffffff00)
• bg (of type string?, which defaults to null): set background color. (default: white)
• min (of type float?, which defaults to null): set minimal value. (default: -1)
• max (of type float?, which defaults to null): set maximal value. (default: 1)
• mode (of type int?, which defaults to null): set graph mode. (default: 2, possible values: 0 (bar), 1 (dot), 2 (line))
• slide (of type int?, which defaults to null): set slide mode. (default: 0, possible values: 0 (frame), 1 (replace), 2 (scroll), 3 (rscroll), 4 (picture))
• size (of type string?, which defaults to null): set graph size. (default: 900x256)
• s (of type string?, which defaults to null): set graph size. (default: 900x256)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.drawgrid

Ffmpeg filter: Draw a colored grid on the input video.

Type:

(?x : string?, ?y : string?, ?width : string?, ?w : string?,
 ?height : string?, ?h : string?, ?color : string?, ?c : string?,
 ?thickness : string?, ?t : string?, ?replace : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• x (of type string?, which defaults to null): set horizontal offset. (default: 0)
• y (of type string?, which defaults to null): set vertical offset. (default: 0)
• width (of type string?, which defaults to null): set width of grid cell. (default: 0)
• w (of type string?, which defaults to null): set width of grid cell. (default: 0)
• height (of type string?, which defaults to null): set height of grid cell. (default: 0)
• h (of type string?, which defaults to null): set height of grid cell. (default: 0)
• color (of type string?, which defaults to null): set color of the grid. (default: black)
• c (of type string?, which defaults to null): set color of the grid. (default: black)
• thickness (of type string?, which defaults to null): set grid line thickness. (default: 1)
• t (of type string?, which defaults to null): set grid line thickness. (default: 1)
• replace (of type bool?, which defaults to null): replace color & alpha. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.drawgrid.create

Ffmpeg filter: Draw a colored grid on the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : string?, ?y : string?, ?width : string?, ?w : string?,
 ?height : string?, ?h : string?, ?color : string?, ?c : string?,
 ?thickness : string?, ?t : string?, ?replace : bool?, ffmpeg.filter.graph) ->
unit

Arguments:

• x (of type string?, which defaults to null): set horizontal offset. (default: 0)
• y (of type string?, which defaults to null): set vertical offset. (default: 0)
• width (of type string?, which defaults to null): set width of grid cell. (default: 0)
• w (of type string?, which defaults to null): set width of grid cell. (default: 0)
• height (of type string?, which defaults to null): set height of grid cell. (default: 0)
• h (of type string?, which defaults to null): set height of grid cell. (default: 0)
• color (of type string?, which defaults to null): set color of the grid. (default: black)
• c (of type string?, which defaults to null): set color of the grid. (default: black)
• thickness (of type string?, which defaults to null): set grid line thickness. (default: 1)
• t (of type string?, which defaults to null): set grid line thickness. (default: 1)
• replace (of type bool?, which defaults to null): replace color & alpha. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.drawtext

Ffmpeg filter: Draw text on top of video frames using libfreetype library.

Type:

(?fontfile : string?, ?text : string?, ?textfile : string?,
 ?fontcolor : string?, ?fontcolor_expr : string?, ?boxcolor : string?,
 ?bordercolor : string?, ?shadowcolor : string?, ?box : bool?,
 ?boxborderw : string?, ?line_spacing : int?, ?fontsize : string?,
 ?text_align : int?, ?x : string?, ?y : string?, ?boxw : int?, ?boxh : int?,
 ?shadowx : int?, ?shadowy : int?, ?borderw : int?, ?tabsize : int?,
 ?basetime : int?, ?font : string?, ?expansion : int?, ?y_align : int?,
 ?timecode : string?, ?tc24hmax : bool?, ?timecode_rate : string?,
 ?r : string?, ?rate : string?, ?reload : int?, ?alpha : string?,
 ?fix_bounds : bool?, ?start_number : int?, ?text_source : string?,
 ?text_shaping : bool?, ?ft_load_flags : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• fontfile (of type string?, which defaults to null): set font file
• text (of type string?, which defaults to null): set text
• textfile (of type string?, which defaults to null): set text file
• fontcolor (of type string?, which defaults to null): set foreground color. (default: black)
• fontcolor_expr (of type string?, which defaults to null): set foreground color expression. (default: )
• boxcolor (of type string?, which defaults to null): set box color. (default: white)
• bordercolor (of type string?, which defaults to null): set border color. (default: black)
• shadowcolor (of type string?, which defaults to null): set shadow color. (default: black)
• box (of type bool?, which defaults to null): set box. (default: false)
• boxborderw (of type string?, which defaults to null): set box borders width. (default: 0)
• line_spacing (of type int?, which defaults to null): set line spacing in pixels. (default: 0)
• fontsize (of type string?, which defaults to null): set font size
• text_align (of type int?, which defaults to null): set text alignment. (default: 0, possible values: 1 (left), 1 (L), 2 (right), 2 (R), 3 (center), 3 (C), 4 (top), 4 (T), 8 (bottom), 8 (B), 12 (middle), 12 (M), combined by addition)
• x (of type string?, which defaults to null): set x expression. (default: 0)
• y (of type string?, which defaults to null): set y expression. (default: 0)
• boxw (of type int?, which defaults to null): set box width. (default: 0)
• boxh (of type int?, which defaults to null): set box height. (default: 0)
• shadowx (of type int?, which defaults to null): set shadow x offset. (default: 0)
• shadowy (of type int?, which defaults to null): set shadow y offset. (default: 0)
• borderw (of type int?, which defaults to null): set border width. (default: 0)
• tabsize (of type int?, which defaults to null): set tab size. (default: 4)
• basetime (of type int?, which defaults to null): set base time. (default: -9223372036854775808)
• font (of type string?, which defaults to null): Font name. (default: Sans)
• expansion (of type int?, which defaults to null): set the expansion mode. (default: 1, possible values: 0 (none), 1 (normal), 2 (strftime))
• y_align (of type int?, which defaults to null): set the y alignment. (default: 0, possible values: 0 (text), 1 (baseline), 2 (font))
• timecode (of type string?, which defaults to null): set initial timecode
• tc24hmax (of type bool?, which defaults to null): set 24 hours max (timecode only). (default: false)
• timecode_rate (of type string?, which defaults to null): set rate (timecode only). (default: 0/1)
• r (of type string?, which defaults to null): set rate (timecode only). (default: 0/1)
• rate (of type string?, which defaults to null): set rate (timecode only). (default: 0/1)
• reload (of type int?, which defaults to null): reload text file at specified frame interval. (default: 0)
• alpha (of type string?, which defaults to null): apply alpha while rendering. (default: 1)
• fix_bounds (of type bool?, which defaults to null): check and fix text coords to avoid clipping. (default: false)
• start_number (of type int?, which defaults to null): start frame number for n/frame_num variable. (default: 0)
• text_source (of type string?, which defaults to null): the source of text
• text_shaping (of type bool?, which defaults to null): attempt to shape text before drawing. (default: true)
• ft_load_flags (of type int?, which defaults to null): set font loading flags for libfreetype. (default: 0, possible values: 0 (default), 1 (no_scale), 2 (no_hinting), 4 (render), 8 (no_bitmap), 16 (vertical_layout), 32 (force_autohint), 64 (crop_bitmap), 128 (pedantic), 512 (ignore_global_advance_width), 1024 (no_recurse), 2048 (ignore_transform), 4096 (monochrome), 8192 (linear_design), 32768 (no_autohint), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.drawtext.create

Ffmpeg filter: Draw text on top of video frames using libfreetype library. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?fontfile : string?, ?text : string?, ?textfile : string?,
 ?fontcolor : string?, ?fontcolor_expr : string?, ?boxcolor : string?,
 ?bordercolor : string?, ?shadowcolor : string?, ?box : bool?,
 ?boxborderw : string?, ?line_spacing : int?, ?fontsize : string?,
 ?text_align : int?, ?x : string?, ?y : string?, ?boxw : int?, ?boxh : int?,
 ?shadowx : int?, ?shadowy : int?, ?borderw : int?, ?tabsize : int?,
 ?basetime : int?, ?font : string?, ?expansion : int?, ?y_align : int?,
 ?timecode : string?, ?tc24hmax : bool?, ?timecode_rate : string?,
 ?r : string?, ?rate : string?, ?reload : int?, ?alpha : string?,
 ?fix_bounds : bool?, ?start_number : int?, ?text_source : string?,
 ?text_shaping : bool?, ?ft_load_flags : int?, ffmpeg.filter.graph) -> unit

Arguments:

• fontfile (of type string?, which defaults to null): set font file
• text (of type string?, which defaults to null): set text
• textfile (of type string?, which defaults to null): set text file
• fontcolor (of type string?, which defaults to null): set foreground color. (default: black)
• fontcolor_expr (of type string?, which defaults to null): set foreground color expression. (default: )
• boxcolor (of type string?, which defaults to null): set box color. (default: white)
• bordercolor (of type string?, which defaults to null): set border color. (default: black)
• shadowcolor (of type string?, which defaults to null): set shadow color. (default: black)
• box (of type bool?, which defaults to null): set box. (default: false)
• boxborderw (of type string?, which defaults to null): set box borders width. (default: 0)
• line_spacing (of type int?, which defaults to null): set line spacing in pixels. (default: 0)
• fontsize (of type string?, which defaults to null): set font size
• text_align (of type int?, which defaults to null): set text alignment. (default: 0, possible values: 1 (left), 1 (L), 2 (right), 2 (R), 3 (center), 3 (C), 4 (top), 4 (T), 8 (bottom), 8 (B), 12 (middle), 12 (M), combined by addition)
• x (of type string?, which defaults to null): set x expression. (default: 0)
• y (of type string?, which defaults to null): set y expression. (default: 0)
• boxw (of type int?, which defaults to null): set box width. (default: 0)
• boxh (of type int?, which defaults to null): set box height. (default: 0)
• shadowx (of type int?, which defaults to null): set shadow x offset. (default: 0)
• shadowy (of type int?, which defaults to null): set shadow y offset. (default: 0)
• borderw (of type int?, which defaults to null): set border width. (default: 0)
• tabsize (of type int?, which defaults to null): set tab size. (default: 4)
• basetime (of type int?, which defaults to null): set base time. (default: -9223372036854775808)
• font (of type string?, which defaults to null): Font name. (default: Sans)
• expansion (of type int?, which defaults to null): set the expansion mode. (default: 1, possible values: 0 (none), 1 (normal), 2 (strftime))
• y_align (of type int?, which defaults to null): set the y alignment. (default: 0, possible values: 0 (text), 1 (baseline), 2 (font))
• timecode (of type string?, which defaults to null): set initial timecode
• tc24hmax (of type bool?, which defaults to null): set 24 hours max (timecode only). (default: false)
• timecode_rate (of type string?, which defaults to null): set rate (timecode only). (default: 0/1)
• r (of type string?, which defaults to null): set rate (timecode only). (default: 0/1)
• rate (of type string?, which defaults to null): set rate (timecode only). (default: 0/1)
• reload (of type int?, which defaults to null): reload text file at specified frame interval. (default: 0)
• alpha (of type string?, which defaults to null): apply alpha while rendering. (default: 1)
• fix_bounds (of type bool?, which defaults to null): check and fix text coords to avoid clipping. (default: false)
• start_number (of type int?, which defaults to null): start frame number for n/frame_num variable. (default: 0)
• text_source (of type string?, which defaults to null): the source of text
• text_shaping (of type bool?, which defaults to null): attempt to shape text before drawing. (default: true)
• ft_load_flags (of type int?, which defaults to null): set font loading flags for libfreetype. (default: 0, possible values: 0 (default), 1 (no_scale), 2 (no_hinting), 4 (render), 8 (no_bitmap), 16 (vertical_layout), 32 (force_autohint), 64 (crop_bitmap), 128 (pedantic), 512 (ignore_global_advance_width), 1024 (no_recurse), 2048 (ignore_transform), 4096 (monochrome), 8192 (linear_design), 32768 (no_autohint), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.drmeter

Ffmpeg filter: Measure audio dynamic range.

Type:

(?length : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• length (of type float?, which defaults to null): set the window length. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.drmeter.create

Ffmpeg filter: Measure audio dynamic range. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?length : float?, ffmpeg.filter.graph) -> unit

Arguments:

• length (of type float?, which defaults to null): set the window length. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.dynaudnorm

Ffmpeg filter: Dynamic Audio Normalizer.

Type:

(?framelen : int?, ?f : int?, ?gausssize : int?, ?g : int?, ?peak : float?,
 ?p : float?, ?maxgain : float?, ?m : float?, ?targetrms : float?,
 ?r : float?, ?coupling : bool?, ?n : bool?, ?correctdc : bool?, ?c : bool?,
 ?altboundary : bool?, ?b : bool?, ?compress : float?, ?s : float?,
 ?threshold : float?, ?t : float?, ?channels : string?, ?h : string?,
 ?overlap : float?, ?o : float?, ?curve : string?, ?v : string?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• framelen (of type int?, which defaults to null): set the frame length in msec. (default: 500)
• f (of type int?, which defaults to null): set the frame length in msec. (default: 500)
• gausssize (of type int?, which defaults to null): set the filter size. (default: 31)
• g (of type int?, which defaults to null): set the filter size. (default: 31)
• peak (of type float?, which defaults to null): set the peak value. (default: 0.95)
• p (of type float?, which defaults to null): set the peak value. (default: 0.95)
• maxgain (of type float?, which defaults to null): set the max amplification. (default: 10)
• m (of type float?, which defaults to null): set the max amplification. (default: 10)
• targetrms (of type float?, which defaults to null): set the target RMS. (default: 0)
• r (of type float?, which defaults to null): set the target RMS. (default: 0)
• coupling (of type bool?, which defaults to null): set channel coupling. (default: true)
• n (of type bool?, which defaults to null): set channel coupling. (default: true)
• correctdc (of type bool?, which defaults to null): set DC correction. (default: false)
• c (of type bool?, which defaults to null): set DC correction. (default: false)
• altboundary (of type bool?, which defaults to null): set alternative boundary mode. (default: false)
• b (of type bool?, which defaults to null): set alternative boundary mode. (default: false)
• compress (of type float?, which defaults to null): set the compress factor. (default: 0)
• s (of type float?, which defaults to null): set the compress factor. (default: 0)
• threshold (of type float?, which defaults to null): set the threshold value. (default: 0)
• t (of type float?, which defaults to null): set the threshold value. (default: 0)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• h (of type string?, which defaults to null): set channels to filter. (default: all)
• overlap (of type float?, which defaults to null): set the frame overlap. (default: 0)
• o (of type float?, which defaults to null): set the frame overlap. (default: 0)
• curve (of type string?, which defaults to null): set the custom peak mapping curve
• v (of type string?, which defaults to null): set the custom peak mapping curve
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.dynaudnorm.create

Ffmpeg filter: Dynamic Audio Normalizer. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?framelen : int?, ?f : int?, ?gausssize : int?, ?g : int?, ?peak : float?,
 ?p : float?, ?maxgain : float?, ?m : float?, ?targetrms : float?,
 ?r : float?, ?coupling : bool?, ?n : bool?, ?correctdc : bool?, ?c : bool?,
 ?altboundary : bool?, ?b : bool?, ?compress : float?, ?s : float?,
 ?threshold : float?, ?t : float?, ?channels : string?, ?h : string?,
 ?overlap : float?, ?o : float?, ?curve : string?, ?v : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• framelen (of type int?, which defaults to null): set the frame length in msec. (default: 500)
• f (of type int?, which defaults to null): set the frame length in msec. (default: 500)
• gausssize (of type int?, which defaults to null): set the filter size. (default: 31)
• g (of type int?, which defaults to null): set the filter size. (default: 31)
• peak (of type float?, which defaults to null): set the peak value. (default: 0.95)
• p (of type float?, which defaults to null): set the peak value. (default: 0.95)
• maxgain (of type float?, which defaults to null): set the max amplification. (default: 10)
• m (of type float?, which defaults to null): set the max amplification. (default: 10)
• targetrms (of type float?, which defaults to null): set the target RMS. (default: 0)
• r (of type float?, which defaults to null): set the target RMS. (default: 0)
• coupling (of type bool?, which defaults to null): set channel coupling. (default: true)
• n (of type bool?, which defaults to null): set channel coupling. (default: true)
• correctdc (of type bool?, which defaults to null): set DC correction. (default: false)
• c (of type bool?, which defaults to null): set DC correction. (default: false)
• altboundary (of type bool?, which defaults to null): set alternative boundary mode. (default: false)
• b (of type bool?, which defaults to null): set alternative boundary mode. (default: false)
• compress (of type float?, which defaults to null): set the compress factor. (default: 0)
• s (of type float?, which defaults to null): set the compress factor. (default: 0)
• threshold (of type float?, which defaults to null): set the threshold value. (default: 0)
• t (of type float?, which defaults to null): set the threshold value. (default: 0)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• h (of type string?, which defaults to null): set channels to filter. (default: all)
• overlap (of type float?, which defaults to null): set the frame overlap. (default: 0)
• o (of type float?, which defaults to null): set the frame overlap. (default: 0)
• curve (of type string?, which defaults to null): set the custom peak mapping curve
• v (of type string?, which defaults to null): set the custom peak mapping curve
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.earwax

Ffmpeg filter: Widen the stereo image.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.earwax.create

Ffmpeg filter: Widen the stereo image. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ebur128

Ffmpeg filter: EBU R128 scanner. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?video : bool?, ?size : string?, ?meter : int?, ?framelog : int?,
 ?metadata : bool?, ?peak : int?, ?dualmono : bool?, ?panlaw : float?,
 ?target : int?, ?gauge : int?, ?scale : int?, ?integrated : float?,
 ?range : float?, ?lra_low : float?, ?lra_high : float?,
 ?sample_peak : float?, ?true_peak : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> [ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• video (of type bool?, which defaults to null): set video output. (default: false)
• size (of type string?, which defaults to null): set video size. (default: 640x480)
• meter (of type int?, which defaults to null): set scale meter (+9 to +18). (default: 9)
• framelog (of type int?, which defaults to null): force frame logging level. (default: -1, possible values: -8 (quiet), 32 (info), 40 (verbose))
• metadata (of type bool?, which defaults to null): inject metadata in the filtergraph. (default: false)
• peak (of type int?, which defaults to null): set peak mode. (default: 0, possible values: 0 (none), 2 (sample), 4 (true), combined by addition)
• dualmono (of type bool?, which defaults to null): treat mono input files as dual-mono. (default: false)
• panlaw (of type float?, which defaults to null): set a specific pan law for dual-mono files. (default: -3.01029995663978)
• target (of type int?, which defaults to null): set a specific target level in LUFS (-23 to 0). (default: -23)
• gauge (of type int?, which defaults to null): set gauge display type. (default: 0, possible values: 0 (momentary), 0 (m), 1 (shortterm), 1 (s))
• scale (of type int?, which defaults to null): sets display method for the stats. (default: 0, possible values: 0 (absolute), 0 (LUFS), 1 (relative), 1 (LU))
• integrated (of type float?, which defaults to null): integrated loudness (LUFS). (default: 0)
• range (of type float?, which defaults to null): loudness range (LU). (default: 0)
• lra_low (of type float?, which defaults to null): LRA low (LUFS). (default: 0)
• lra_high (of type float?, which defaults to null): LRA high (LUFS). (default: 0)
• sample_peak (of type float?, which defaults to null): sample peak (dBFS). (default: 0)
• true_peak (of type float?, which defaults to null): true peak (dBFS). (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.ebur128.create

Ffmpeg filter: EBU R128 scanner. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?video : bool?, ?size : string?, ?meter : int?, ?framelog : int?,
 ?metadata : bool?, ?peak : int?, ?dualmono : bool?, ?panlaw : float?,
 ?target : int?, ?gauge : int?, ?scale : int?, ?integrated : float?,
 ?range : float?, ?lra_low : float?, ?lra_high : float?,
 ?sample_peak : float?, ?true_peak : float?, ffmpeg.filter.graph) -> unit

Arguments:

• video (of type bool?, which defaults to null): set video output. (default: false)
• size (of type string?, which defaults to null): set video size. (default: 640x480)
• meter (of type int?, which defaults to null): set scale meter (+9 to +18). (default: 9)
• framelog (of type int?, which defaults to null): force frame logging level. (default: -1, possible values: -8 (quiet), 32 (info), 40 (verbose))
• metadata (of type bool?, which defaults to null): inject metadata in the filtergraph. (default: false)
• peak (of type int?, which defaults to null): set peak mode. (default: 0, possible values: 0 (none), 2 (sample), 4 (true), combined by addition)
• dualmono (of type bool?, which defaults to null): treat mono input files as dual-mono. (default: false)
• panlaw (of type float?, which defaults to null): set a specific pan law for dual-mono files. (default: -3.01029995663978)
• target (of type int?, which defaults to null): set a specific target level in LUFS (-23 to 0). (default: -23)
• gauge (of type int?, which defaults to null): set gauge display type. (default: 0, possible values: 0 (momentary), 0 (m), 1 (shortterm), 1 (s))
• scale (of type int?, which defaults to null): sets display method for the stats. (default: 0, possible values: 0 (absolute), 0 (LUFS), 1 (relative), 1 (LU))
• integrated (of type float?, which defaults to null): integrated loudness (LUFS). (default: 0)
• range (of type float?, which defaults to null): loudness range (LU). (default: 0)
• lra_low (of type float?, which defaults to null): LRA low (LUFS). (default: 0)
• lra_high (of type float?, which defaults to null): LRA high (LUFS). (default: 0)
• sample_peak (of type float?, which defaults to null): sample peak (dBFS). (default: 0)
• true_peak (of type float?, which defaults to null): true peak (dBFS). (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.edgedetect

Ffmpeg filter: Detect and draw edge.

Type:

(?high : float?, ?low : float?, ?mode : int?, ?planes : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• high (of type float?, which defaults to null): set high threshold. (default: 0.19607843137254902)
• low (of type float?, which defaults to null): set low threshold. (default: 0.0784313725490196)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (wires), 1 (colormix), 2 (canny))
• planes (of type int?, which defaults to null): set planes to filter. (default: 7, possible values: 1 (y), 2 (u), 4 (v), 4 (r), 1 (g), 2 (b), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.edgedetect.create

Ffmpeg filter: Detect and draw edge. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?high : float?, ?low : float?, ?mode : int?, ?planes : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• high (of type float?, which defaults to null): set high threshold. (default: 0.19607843137254902)
• low (of type float?, which defaults to null): set low threshold. (default: 0.0784313725490196)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (wires), 1 (colormix), 2 (canny))
• planes (of type int?, which defaults to null): set planes to filter. (default: 7, possible values: 1 (y), 2 (u), 4 (v), 4 (r), 1 (g), 2 (b), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.elbg

Ffmpeg filter: Apply posterize effect, using the ELBG algorithm.

Type:

(?codebook_length : int?, ?l : int?, ?nb_steps : int?, ?n : int?,
 ?seed : int?, ?s : int?, ?pal8 : bool?, ?use_alpha : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• codebook_length (of type int?, which defaults to null): set codebook length. (default: 256)
• l (of type int?, which defaults to null): set codebook length. (default: 256)
• nb_steps (of type int?, which defaults to null): set max number of steps used to compute the mapping. (default: 1)
• n (of type int?, which defaults to null): set max number of steps used to compute the mapping. (default: 1)
• seed (of type int?, which defaults to null): set the random seed. (default: -1)
• s (of type int?, which defaults to null): set the random seed. (default: -1)
• pal8 (of type bool?, which defaults to null): set the pal8 output. (default: false)
• use_alpha (of type bool?, which defaults to null): use alpha channel for mapping. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.elbg.create

Ffmpeg filter: Apply posterize effect, using the ELBG algorithm. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?codebook_length : int?, ?l : int?, ?nb_steps : int?, ?n : int?,
 ?seed : int?, ?s : int?, ?pal8 : bool?, ?use_alpha : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• codebook_length (of type int?, which defaults to null): set codebook length. (default: 256)
• l (of type int?, which defaults to null): set codebook length. (default: 256)
• nb_steps (of type int?, which defaults to null): set max number of steps used to compute the mapping. (default: 1)
• n (of type int?, which defaults to null): set max number of steps used to compute the mapping. (default: 1)
• seed (of type int?, which defaults to null): set the random seed. (default: -1)
• s (of type int?, which defaults to null): set the random seed. (default: -1)
• pal8 (of type bool?, which defaults to null): set the pal8 output. (default: false)
• use_alpha (of type bool?, which defaults to null): use alpha channel for mapping. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.entropy

Ffmpeg filter: Measure video frames entropy.

Type:

(?mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set kind of histogram entropy measurement. (default: 0, possible values: 0 (normal), 1 (diff))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.entropy.create

Ffmpeg filter: Measure video frames entropy. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set kind of histogram entropy measurement. (default: 0, possible values: 0 (normal), 1 (diff))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.epx

Ffmpeg filter: Scale the input using EPX algorithm.

Type:

(?n : int?, ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• n (of type int?, which defaults to null): set scale factor. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.epx.create

Ffmpeg filter: Scale the input using EPX algorithm. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?n : int?, ffmpeg.filter.graph) -> unit

Arguments:

• n (of type int?, which defaults to null): set scale factor. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.eq

Ffmpeg filter: Adjust brightness, contrast, gamma, and saturation.

Type:

(?contrast : string?, ?brightness : string?, ?saturation : string?,
 ?gamma : string?, ?gamma_r : string?, ?gamma_g : string?,
 ?gamma_b : string?, ?gamma_weight : string?, ?eval : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• contrast (of type string?, which defaults to null): set the contrast adjustment, negative values give a negative image. (default: 1.0)
• brightness (of type string?, which defaults to null): set the brightness adjustment. (default: 0.0)
• saturation (of type string?, which defaults to null): set the saturation adjustment. (default: 1.0)
• gamma (of type string?, which defaults to null): set the initial gamma value. (default: 1.0)
• gamma_r (of type string?, which defaults to null): gamma value for red. (default: 1.0)
• gamma_g (of type string?, which defaults to null): gamma value for green. (default: 1.0)
• gamma_b (of type string?, which defaults to null): gamma value for blue. (default: 1.0)
• gamma_weight (of type string?, which defaults to null): set the gamma weight which reduces the effect of gamma on bright areas. (default: 1.0)
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.eq.create

Ffmpeg filter: Adjust brightness, contrast, gamma, and saturation. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?contrast : string?, ?brightness : string?, ?saturation : string?,
 ?gamma : string?, ?gamma_r : string?, ?gamma_g : string?,
 ?gamma_b : string?, ?gamma_weight : string?, ?eval : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• contrast (of type string?, which defaults to null): set the contrast adjustment, negative values give a negative image. (default: 1.0)
• brightness (of type string?, which defaults to null): set the brightness adjustment. (default: 0.0)
• saturation (of type string?, which defaults to null): set the saturation adjustment. (default: 1.0)
• gamma (of type string?, which defaults to null): set the initial gamma value. (default: 1.0)
• gamma_r (of type string?, which defaults to null): gamma value for red. (default: 1.0)
• gamma_g (of type string?, which defaults to null): gamma value for green. (default: 1.0)
• gamma_b (of type string?, which defaults to null): gamma value for blue. (default: 1.0)
• gamma_weight (of type string?, which defaults to null): set the gamma weight which reduces the effect of gamma on bright areas. (default: 1.0)
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.equalizer

Ffmpeg filter: Apply two-pole peaking equalization (EQ) filter.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?mix : float?,
 ?m : float?, ?channels : string?, ?c : string?, ?normalize : bool?,
 ?n : bool?, ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 0)
• f (of type float?, which defaults to null): set central frequency. (default: 0)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 1)
• w (of type float?, which defaults to null): set width. (default: 1)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.equalizer.create

Ffmpeg filter: Apply two-pole peaking equalization (EQ) filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?mix : float?,
 ?m : float?, ?channels : string?, ?c : string?, ?normalize : bool?,
 ?n : bool?, ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 0)
• f (of type float?, which defaults to null): set central frequency. (default: 0)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 1)
• w (of type float?, which defaults to null): set width. (default: 1)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.erosion

Ffmpeg filter: Apply erosion effect.

Type:

(?coordinates : int?, ?threshold0 : int?, ?threshold1 : int?,
 ?threshold2 : int?, ?threshold3 : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• coordinates (of type int?, which defaults to null): set coordinates. (default: 255)
• threshold0 (of type int?, which defaults to null): set threshold for 1st plane. (default: 65535)
• threshold1 (of type int?, which defaults to null): set threshold for 2nd plane. (default: 65535)
• threshold2 (of type int?, which defaults to null): set threshold for 3rd plane. (default: 65535)
• threshold3 (of type int?, which defaults to null): set threshold for 4th plane. (default: 65535)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.erosion.create

Ffmpeg filter: Apply erosion effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?coordinates : int?, ?threshold0 : int?, ?threshold1 : int?,
 ?threshold2 : int?, ?threshold3 : int?, ffmpeg.filter.graph) -> unit

Arguments:

• coordinates (of type int?, which defaults to null): set coordinates. (default: 255)
• threshold0 (of type int?, which defaults to null): set threshold for 1st plane. (default: 65535)
• threshold1 (of type int?, which defaults to null): set threshold for 2nd plane. (default: 65535)
• threshold2 (of type int?, which defaults to null): set threshold for 3rd plane. (default: 65535)
• threshold3 (of type int?, which defaults to null): set threshold for 4th plane. (default: 65535)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.estdif

Ffmpeg filter: Apply Edge Slope Tracing deinterlace.

Type:

(?mode : int?, ?parity : int?, ?deint : int?, ?rslope : int?, ?redge : int?,
 ?ecost : int?, ?mcost : int?, ?dcost : int?, ?interp : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): specify the mode. (default: 1, possible values: 0 (frame), 1 (field))
• parity (of type int?, which defaults to null): specify the assumed picture field parity. (default: -1, possible values: 0 (tff), 1 (bff), -1 (auto))
• deint (of type int?, which defaults to null): specify which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• rslope (of type int?, which defaults to null): specify the search radius for edge slope tracing. (default: 1)
• redge (of type int?, which defaults to null): specify the search radius for best edge matching. (default: 2)
• ecost (of type int?, which defaults to null): specify the edge cost for edge matching. (default: 2)
• mcost (of type int?, which defaults to null): specify the middle cost for edge matching. (default: 1)
• dcost (of type int?, which defaults to null): specify the distance cost for edge matching. (default: 1)
• interp (of type int?, which defaults to null): specify the type of interpolation. (default: 1, possible values: 0 (2p), 1 (4p), 2 (6p))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.estdif.create

Ffmpeg filter: Apply Edge Slope Tracing deinterlace. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?parity : int?, ?deint : int?, ?rslope : int?, ?redge : int?,
 ?ecost : int?, ?mcost : int?, ?dcost : int?, ?interp : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): specify the mode. (default: 1, possible values: 0 (frame), 1 (field))
• parity (of type int?, which defaults to null): specify the assumed picture field parity. (default: -1, possible values: 0 (tff), 1 (bff), -1 (auto))
• deint (of type int?, which defaults to null): specify which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• rslope (of type int?, which defaults to null): specify the search radius for edge slope tracing. (default: 1)
• redge (of type int?, which defaults to null): specify the search radius for best edge matching. (default: 2)
• ecost (of type int?, which defaults to null): specify the edge cost for edge matching. (default: 2)
• mcost (of type int?, which defaults to null): specify the middle cost for edge matching. (default: 1)
• dcost (of type int?, which defaults to null): specify the distance cost for edge matching. (default: 1)
• interp (of type int?, which defaults to null): specify the type of interpolation. (default: 1, possible values: 0 (2p), 1 (4p), 2 (6p))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.exposure

Ffmpeg filter: Adjust exposure of the video stream.

Type:

(?exposure : float?, ?black : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• exposure (of type float?, which defaults to null): set the exposure correction. (default: 0)
• black (of type float?, which defaults to null): set the black level correction. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.exposure.create

Ffmpeg filter: Adjust exposure of the video stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?exposure : float?, ?black : float?, ffmpeg.filter.graph) -> unit

Arguments:

• exposure (of type float?, which defaults to null): set the exposure correction. (default: 0)
• black (of type float?, which defaults to null): set the black level correction. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.extractplanes

Ffmpeg filter: Extract planes as grayscale frames. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?planes : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 1, possible values: 16 (y), 32 (u), 64 (v), 1 (r), 2 (g), 4 (b), 8 (a), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.extractplanes.create

Ffmpeg filter: Extract planes as grayscale frames. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 1, possible values: 16 (y), 32 (u), 64 (v), 1 (r), 2 (g), 4 (b), 8 (a), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.extrastereo

Ffmpeg filter: Increase difference between stereo audio channels.

Type:

(?m : float?, ?c : bool?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• m (of type float?, which defaults to null): set the difference coefficient. (default: 2.5)
• c (of type bool?, which defaults to null): enable clipping. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.extrastereo.create

Ffmpeg filter: Increase difference between stereo audio channels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?m : float?, ?c : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• m (of type float?, which defaults to null): set the difference coefficient. (default: 2.5)
• c (of type bool?, which defaults to null): enable clipping. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fade

Ffmpeg filter: Fade in/out input video.

Type:

(?type : int?, ?t : int?, ?start_frame : int?, ?s : int?, ?nb_frames : int?,
 ?n : int?, ?alpha : bool?, ?start_time : int?, ?st : int?, ?duration : int?,
 ?d : int?, ?color : string?, ?c : string?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• type (of type int?, which defaults to null): set the fade direction. (default: 0, possible values: 0 (in), 1 (out))
• t (of type int?, which defaults to null): set the fade direction. (default: 0, possible values: 0 (in), 1 (out))
• start_frame (of type int?, which defaults to null): Number of the first frame to which to apply the effect.. (default: 0)
• s (of type int?, which defaults to null): Number of the first frame to which to apply the effect.. (default: 0)
• nb_frames (of type int?, which defaults to null): Number of frames to which the effect should be applied.. (default: 25)
• n (of type int?, which defaults to null): Number of frames to which the effect should be applied.. (default: 25)
• alpha (of type bool?, which defaults to null): fade alpha if it is available on the input. (default: false)
• start_time (of type int?, which defaults to null): Number of seconds of the beginning of the effect.. (default: 0)
• st (of type int?, which defaults to null): Number of seconds of the beginning of the effect.. (default: 0)
• duration (of type int?, which defaults to null): Duration of the effect in seconds.. (default: 0)
• d (of type int?, which defaults to null): Duration of the effect in seconds.. (default: 0)
• color (of type string?, which defaults to null): set color. (default: black)
• c (of type string?, which defaults to null): set color. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fade.create

Ffmpeg filter: Fade in/out input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?type : int?, ?t : int?, ?start_frame : int?, ?s : int?, ?nb_frames : int?,
 ?n : int?, ?alpha : bool?, ?start_time : int?, ?st : int?, ?duration : int?,
 ?d : int?, ?color : string?, ?c : string?, ffmpeg.filter.graph) -> unit

Arguments:

• type (of type int?, which defaults to null): set the fade direction. (default: 0, possible values: 0 (in), 1 (out))
• t (of type int?, which defaults to null): set the fade direction. (default: 0, possible values: 0 (in), 1 (out))
• start_frame (of type int?, which defaults to null): Number of the first frame to which to apply the effect.. (default: 0)
• s (of type int?, which defaults to null): Number of the first frame to which to apply the effect.. (default: 0)
• nb_frames (of type int?, which defaults to null): Number of frames to which the effect should be applied.. (default: 25)
• n (of type int?, which defaults to null): Number of frames to which the effect should be applied.. (default: 25)
• alpha (of type bool?, which defaults to null): fade alpha if it is available on the input. (default: false)
• start_time (of type int?, which defaults to null): Number of seconds of the beginning of the effect.. (default: 0)
• st (of type int?, which defaults to null): Number of seconds of the beginning of the effect.. (default: 0)
• duration (of type int?, which defaults to null): Duration of the effect in seconds.. (default: 0)
• d (of type int?, which defaults to null): Duration of the effect in seconds.. (default: 0)
• color (of type string?, which defaults to null): set color. (default: black)
• c (of type string?, which defaults to null): set color. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.feedback

Ffmpeg filter: Apply feedback video filter.

Type:

(?x : int?, ?y : int?, ?w : int?, ?h : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video * ffmpeg.filter.video

Arguments:

• x (of type int?, which defaults to null): set top left crop position. (default: 0)
• y (of type int?, which defaults to null): set top left crop position. (default: 0)
• w (of type int?, which defaults to null): set crop size. (default: 0)
• h (of type int?, which defaults to null): set crop size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.feedback.create

Ffmpeg filter: Apply feedback video filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : int?, ?y : int?, ?w : int?, ?h : int?, ffmpeg.filter.graph) -> unit

Arguments:

• x (of type int?, which defaults to null): set top left crop position. (default: 0)
• y (of type int?, which defaults to null): set top left crop position. (default: 0)
• w (of type int?, which defaults to null): set crop size. (default: 0)
• h (of type int?, which defaults to null): set crop size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video * ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fftdnoiz

Ffmpeg filter: Denoise frames using 3D FFT.

Type:

(?sigma : float?, ?amount : float?, ?block : int?, ?overlap : float?,
 ?method : int?, ?prev : int?, ?next : int?, ?planes : int?, ?window : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• sigma (of type float?, which defaults to null): set denoise strength. (default: 1)
• amount (of type float?, which defaults to null): set amount of denoising. (default: 1)
• block (of type int?, which defaults to null): set block size. (default: 32)
• overlap (of type float?, which defaults to null): set block overlap. (default: 0.5)
• method (of type int?, which defaults to null): set method of denoising. (default: 0, possible values: 0 (wiener), 1 (hard))
• prev (of type int?, which defaults to null): set number of previous frames for temporal denoising. (default: 0)
• next (of type int?, which defaults to null): set number of next frames for temporal denoising. (default: 0)
• planes (of type int?, which defaults to null): set planes to filter. (default: 7)
• window (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fftdnoiz.create

Ffmpeg filter: Denoise frames using 3D FFT. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sigma : float?, ?amount : float?, ?block : int?, ?overlap : float?,
 ?method : int?, ?prev : int?, ?next : int?, ?planes : int?, ?window : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• sigma (of type float?, which defaults to null): set denoise strength. (default: 1)
• amount (of type float?, which defaults to null): set amount of denoising. (default: 1)
• block (of type int?, which defaults to null): set block size. (default: 32)
• overlap (of type float?, which defaults to null): set block overlap. (default: 0.5)
• method (of type int?, which defaults to null): set method of denoising. (default: 0, possible values: 0 (wiener), 1 (hard))
• prev (of type int?, which defaults to null): set number of previous frames for temporal denoising. (default: 0)
• next (of type int?, which defaults to null): set number of next frames for temporal denoising. (default: 0)
• planes (of type int?, which defaults to null): set planes to filter. (default: 7)
• window (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fftfilt

Ffmpeg filter: Apply arbitrary expressions to pixels in frequency domain.

Type:

(?dc_Y : int?, ?dc_U : int?, ?dc_V : int?, ?weight_Y : string?,
 ?weight_U : string?, ?weight_V : string?, ?eval : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• dc_Y (of type int?, which defaults to null): adjust gain in Y plane. (default: 0)
• dc_U (of type int?, which defaults to null): adjust gain in U plane. (default: 0)
• dc_V (of type int?, which defaults to null): adjust gain in V plane. (default: 0)
• weight_Y (of type string?, which defaults to null): set luminance expression in Y plane. (default: 1)
• weight_U (of type string?, which defaults to null): set chrominance expression in U plane
• weight_V (of type string?, which defaults to null): set chrominance expression in V plane
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fftfilt.create

Ffmpeg filter: Apply arbitrary expressions to pixels in frequency domain. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?dc_Y : int?, ?dc_U : int?, ?dc_V : int?, ?weight_Y : string?,
 ?weight_U : string?, ?weight_V : string?, ?eval : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• dc_Y (of type int?, which defaults to null): adjust gain in Y plane. (default: 0)
• dc_U (of type int?, which defaults to null): adjust gain in U plane. (default: 0)
• dc_V (of type int?, which defaults to null): adjust gain in V plane. (default: 0)
• weight_Y (of type string?, which defaults to null): set luminance expression in Y plane. (default: 1)
• weight_U (of type string?, which defaults to null): set chrominance expression in U plane
• weight_V (of type string?, which defaults to null): set chrominance expression in V plane
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.field

Ffmpeg filter: Extract a field from the input video.

Type:

(?type : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• type (of type int?, which defaults to null): set field type (top or bottom). (default: 0, possible values: 0 (top), 1 (bottom))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.field.create

Ffmpeg filter: Extract a field from the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?type : int?, ffmpeg.filter.graph) -> unit

Arguments:

• type (of type int?, which defaults to null): set field type (top or bottom). (default: 0, possible values: 0 (top), 1 (bottom))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fieldhint

Ffmpeg filter: Field matching using hints.

Type:

(?hint : string?, ?mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• hint (of type string?, which defaults to null): set hint file
• mode (of type int?, which defaults to null): set hint mode. (default: 0, possible values: 0 (absolute), 1 (relative), 2 (pattern))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fieldhint.create

Ffmpeg filter: Field matching using hints. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?hint : string?, ?mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• hint (of type string?, which defaults to null): set hint file
• mode (of type int?, which defaults to null): set hint mode. (default: 0, possible values: 0 (absolute), 1 (relative), 2 (pattern))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fieldmatch

Ffmpeg filter: Field matching for inverse telecine. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?order : int?, ?mode : int?, ?ppsrc : bool?, ?field : int?,
 ?mchroma : bool?, ?y0 : int?, ?y1 : int?, ?scthresh : float?,
 ?combmatch : int?, ?combdbg : int?, ?cthresh : int?, ?chroma : bool?,
 ?blockx : int?, ?blocky : int?, ?combpel : int?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• order (of type int?, which defaults to null): specify the assumed field order. (default: -1, possible values: -1 (auto), 0 (bff), 1 (tff))
• mode (of type int?, which defaults to null): set the matching mode or strategy to use. (default: 1, possible values: 0 (pc), 1 (pc_n), 2 (pc_u), 3 (pc_n_ub), 4 (pcn), 5 (pcn_ub))
• ppsrc (of type bool?, which defaults to null): mark main input as a pre-processed input and activate clean source input stream. (default: false)
• field (of type int?, which defaults to null): set the field to match from. (default: -1, possible values: -1 (auto), 0 (bottom), 1 (top))
• mchroma (of type bool?, which defaults to null): set whether or not chroma is included during the match comparisons. (default: true)
• y0 (of type int?, which defaults to null): define an exclusion band which excludes the lines between y0 and y1 from the field matching decision. (default: 0)
• y1 (of type int?, which defaults to null): define an exclusion band which excludes the lines between y0 and y1 from the field matching decision. (default: 0)
• scthresh (of type float?, which defaults to null): set scene change detection threshold. (default: 12)
• combmatch (of type int?, which defaults to null): set combmatching mode. (default: 1, possible values: 0 (none), 1 (sc), 2 (full))
• combdbg (of type int?, which defaults to null): enable comb debug. (default: 0, possible values: 0 (none), 1 (pcn), 2 (pcnub))
• cthresh (of type int?, which defaults to null): set the area combing threshold used for combed frame detection. (default: 9)
• chroma (of type bool?, which defaults to null): set whether or not chroma is considered in the combed frame decision. (default: false)
• blockx (of type int?, which defaults to null): set the x-axis size of the window used during combed frame detection. (default: 16)
• blocky (of type int?, which defaults to null): set the y-axis size of the window used during combed frame detection. (default: 16)
• combpel (of type int?, which defaults to null): 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. (default: 80)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.fieldmatch.create

Ffmpeg filter: Field matching for inverse telecine. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?order : int?, ?mode : int?, ?ppsrc : bool?, ?field : int?,
 ?mchroma : bool?, ?y0 : int?, ?y1 : int?, ?scthresh : float?,
 ?combmatch : int?, ?combdbg : int?, ?cthresh : int?, ?chroma : bool?,
 ?blockx : int?, ?blocky : int?, ?combpel : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• order (of type int?, which defaults to null): specify the assumed field order. (default: -1, possible values: -1 (auto), 0 (bff), 1 (tff))
• mode (of type int?, which defaults to null): set the matching mode or strategy to use. (default: 1, possible values: 0 (pc), 1 (pc_n), 2 (pc_u), 3 (pc_n_ub), 4 (pcn), 5 (pcn_ub))
• ppsrc (of type bool?, which defaults to null): mark main input as a pre-processed input and activate clean source input stream. (default: false)
• field (of type int?, which defaults to null): set the field to match from. (default: -1, possible values: -1 (auto), 0 (bottom), 1 (top))
• mchroma (of type bool?, which defaults to null): set whether or not chroma is included during the match comparisons. (default: true)
• y0 (of type int?, which defaults to null): define an exclusion band which excludes the lines between y0 and y1 from the field matching decision. (default: 0)
• y1 (of type int?, which defaults to null): define an exclusion band which excludes the lines between y0 and y1 from the field matching decision. (default: 0)
• scthresh (of type float?, which defaults to null): set scene change detection threshold. (default: 12)
• combmatch (of type int?, which defaults to null): set combmatching mode. (default: 1, possible values: 0 (none), 1 (sc), 2 (full))
• combdbg (of type int?, which defaults to null): enable comb debug. (default: 0, possible values: 0 (none), 1 (pcn), 2 (pcnub))
• cthresh (of type int?, which defaults to null): set the area combing threshold used for combed frame detection. (default: 9)
• chroma (of type bool?, which defaults to null): set whether or not chroma is considered in the combed frame decision. (default: false)
• blockx (of type int?, which defaults to null): set the x-axis size of the window used during combed frame detection. (default: 16)
• blocky (of type int?, which defaults to null): set the y-axis size of the window used during combed frame detection. (default: 16)
• combpel (of type int?, which defaults to null): 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. (default: 80)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fieldorder

Ffmpeg filter: Set the field order.

Type:

(?order : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• order (of type int?, which defaults to null): output field order. (default: 1, possible values: 0 (bff), 1 (tff))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fieldorder.create

Ffmpeg filter: Set the field order. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?order : int?, ffmpeg.filter.graph) -> unit

Arguments:

• order (of type int?, which defaults to null): output field order. (default: 1, possible values: 0 (bff), 1 (tff))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fillborders

Ffmpeg filter: Fill borders of the input video.

Type:

(?left : int?, ?right : int?, ?top : int?, ?bottom : int?, ?mode : int?,
 ?color : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• left (of type int?, which defaults to null): set the left fill border. (default: 0)
• right (of type int?, which defaults to null): set the right fill border. (default: 0)
• top (of type int?, which defaults to null): set the top fill border. (default: 0)
• bottom (of type int?, which defaults to null): set the bottom fill border. (default: 0)
• mode (of type int?, which defaults to null): set the fill borders mode. (default: 0, possible values: 0 (smear), 1 (mirror), 2 (fixed), 3 (reflect), 4 (wrap), 5 (fade), 6 (margins))
• color (of type string?, which defaults to null): set the color for the fixed/fade mode. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fillborders.create

Ffmpeg filter: Fill borders of the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?left : int?, ?right : int?, ?top : int?, ?bottom : int?, ?mode : int?,
 ?color : string?, ffmpeg.filter.graph) -> unit

Arguments:

• left (of type int?, which defaults to null): set the left fill border. (default: 0)
• right (of type int?, which defaults to null): set the right fill border. (default: 0)
• top (of type int?, which defaults to null): set the top fill border. (default: 0)
• bottom (of type int?, which defaults to null): set the bottom fill border. (default: 0)
• mode (of type int?, which defaults to null): set the fill borders mode. (default: 0, possible values: 0 (smear), 1 (mirror), 2 (fixed), 3 (reflect), 4 (wrap), 5 (fade), 6 (margins))
• color (of type string?, which defaults to null): set the color for the fixed/fade mode. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.find_rect

Ffmpeg filter: Find a user specified object.

Type:

(?object : string?, ?threshold : float?, ?mipmaps : int?, ?xmin : int?,
 ?ymin : int?, ?xmax : int?, ?ymax : int?, ?discard : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• object (of type string?, which defaults to null): object bitmap filename
• threshold (of type float?, which defaults to null): set threshold. (default: 0.5)
• mipmaps (of type int?, which defaults to null): set mipmaps. (default: 3)
• xmin (of type int?, which defaults to null): Default: 0
• ymin (of type int?, which defaults to null): Default: 0
• xmax (of type int?, which defaults to null): Default: 2147483647
• ymax (of type int?, which defaults to null): Default: 2147483647
• discard (of type bool?, which defaults to null): Default: false
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.find_rect.create

Ffmpeg filter: Find a user specified object. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?object : string?, ?threshold : float?, ?mipmaps : int?, ?xmin : int?,
 ?ymin : int?, ?xmax : int?, ?ymax : int?, ?discard : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• object (of type string?, which defaults to null): object bitmap filename
• threshold (of type float?, which defaults to null): set threshold. (default: 0.5)
• mipmaps (of type int?, which defaults to null): set mipmaps. (default: 3)
• xmin (of type int?, which defaults to null): Default: 0
• ymin (of type int?, which defaults to null): Default: 0
• xmax (of type int?, which defaults to null): Default: 2147483647
• ymax (of type int?, which defaults to null): Default: 2147483647
• discard (of type bool?, which defaults to null): Default: false
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.firequalizer

Ffmpeg filter: Finite Impulse Response Equalizer.

Type:

(?gain : string?, ?gain_entry : string?, ?delay : float?, ?accuracy : float?,
 ?wfunc : int?, ?fixed : bool?, ?multi : bool?, ?zero_phase : bool?,
 ?scale : int?, ?dumpfile : string?, ?dumpscale : int?, ?fft2 : bool?,
 ?min_phase : bool?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• gain (of type string?, which defaults to null): set gain curve. (default: gain_interpolate(f))
• gain_entry (of type string?, which defaults to null): set gain entry
• delay (of type float?, which defaults to null): set delay. (default: 0.01)
• accuracy (of type float?, which defaults to null): set accuracy. (default: 5)
• wfunc (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rectangular), 1 (hann), 2 (hamming), 3 (blackman), 4 (nuttall3), 5 (mnuttall3), 6 (nuttall), 7 (bnuttall), 8 (bharris), 9 (tukey))
• fixed (of type bool?, which defaults to null): set fixed frame samples. (default: false)
• multi (of type bool?, which defaults to null): set multi channels mode. (default: false)
• zero_phase (of type bool?, which defaults to null): set zero phase mode. (default: false)
• scale (of type int?, which defaults to null): set gain scale. (default: 1, possible values: 0 (linlin), 1 (linlog), 2 (loglin), 3 (loglog))
• dumpfile (of type string?, which defaults to null): set dump file
• dumpscale (of type int?, which defaults to null): set dump scale. (default: 1, possible values: 0 (linlin), 1 (linlog), 2 (loglin), 3 (loglog))
• fft2 (of type bool?, which defaults to null): set 2-channels fft. (default: false)
• min_phase (of type bool?, which defaults to null): set minimum phase mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.firequalizer.create

Ffmpeg filter: Finite Impulse Response Equalizer. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?gain : string?, ?gain_entry : string?, ?delay : float?, ?accuracy : float?,
 ?wfunc : int?, ?fixed : bool?, ?multi : bool?, ?zero_phase : bool?,
 ?scale : int?, ?dumpfile : string?, ?dumpscale : int?, ?fft2 : bool?,
 ?min_phase : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• gain (of type string?, which defaults to null): set gain curve. (default: gain_interpolate(f))
• gain_entry (of type string?, which defaults to null): set gain entry
• delay (of type float?, which defaults to null): set delay. (default: 0.01)
• accuracy (of type float?, which defaults to null): set accuracy. (default: 5)
• wfunc (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rectangular), 1 (hann), 2 (hamming), 3 (blackman), 4 (nuttall3), 5 (mnuttall3), 6 (nuttall), 7 (bnuttall), 8 (bharris), 9 (tukey))
• fixed (of type bool?, which defaults to null): set fixed frame samples. (default: false)
• multi (of type bool?, which defaults to null): set multi channels mode. (default: false)
• zero_phase (of type bool?, which defaults to null): set zero phase mode. (default: false)
• scale (of type int?, which defaults to null): set gain scale. (default: 1, possible values: 0 (linlin), 1 (linlog), 2 (loglin), 3 (loglog))
• dumpfile (of type string?, which defaults to null): set dump file
• dumpscale (of type int?, which defaults to null): set dump scale. (default: 1, possible values: 0 (linlin), 1 (linlog), 2 (loglin), 3 (loglog))
• fft2 (of type bool?, which defaults to null): set 2-channels fft. (default: false)
• min_phase (of type bool?, which defaults to null): set minimum phase mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.flanger

Ffmpeg filter: Apply a flanging effect to the audio.

Type:

(?delay : float?, ?depth : float?, ?regen : float?, ?width : float?,
 ?speed : float?, ?shape : int?, ?phase : float?, ?interp : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• delay (of type float?, which defaults to null): base delay in milliseconds. (default: 0)
• depth (of type float?, which defaults to null): added swept delay in milliseconds. (default: 2)
• regen (of type float?, which defaults to null): percentage regeneration (delayed signal feedback). (default: 0)
• width (of type float?, which defaults to null): percentage of delayed signal mixed with original. (default: 71)
• speed (of type float?, which defaults to null): sweeps per second (Hz). (default: 0.5)
• shape (of type int?, which defaults to null): swept wave shape. (default: 0, possible values: 1 (triangular), 1 (t), 0 (sinusoidal), 0 (s))
• phase (of type float?, which defaults to null): swept wave percentage phase-shift for multi-channel. (default: 25)
• interp (of type int?, which defaults to null): delay-line interpolation. (default: 0, possible values: 0 (linear), 1 (quadratic))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.flanger.create

Ffmpeg filter: Apply a flanging effect to the audio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?delay : float?, ?depth : float?, ?regen : float?, ?width : float?,
 ?speed : float?, ?shape : int?, ?phase : float?, ?interp : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• delay (of type float?, which defaults to null): base delay in milliseconds. (default: 0)
• depth (of type float?, which defaults to null): added swept delay in milliseconds. (default: 2)
• regen (of type float?, which defaults to null): percentage regeneration (delayed signal feedback). (default: 0)
• width (of type float?, which defaults to null): percentage of delayed signal mixed with original. (default: 71)
• speed (of type float?, which defaults to null): sweeps per second (Hz). (default: 0.5)
• shape (of type int?, which defaults to null): swept wave shape. (default: 0, possible values: 1 (triangular), 1 (t), 0 (sinusoidal), 0 (s))
• phase (of type float?, which defaults to null): swept wave percentage phase-shift for multi-channel. (default: 25)
• interp (of type int?, which defaults to null): delay-line interpolation. (default: 0, possible values: 0 (linear), 1 (quadratic))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.floodfill

Ffmpeg filter: Fill area with same color with another color.

Type:

(?x : int?, ?y : int?, ?s0 : int?, ?s1 : int?, ?s2 : int?, ?s3 : int?,
 ?d0 : int?, ?d1 : int?, ?d2 : int?, ?d3 : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• x (of type int?, which defaults to null): set pixel x coordinate. (default: 0)
• y (of type int?, which defaults to null): set pixel y coordinate. (default: 0)
• s0 (of type int?, which defaults to null): set source #0 component value. (default: 0)
• s1 (of type int?, which defaults to null): set source #1 component value. (default: 0)
• s2 (of type int?, which defaults to null): set source #2 component value. (default: 0)
• s3 (of type int?, which defaults to null): set source #3 component value. (default: 0)
• d0 (of type int?, which defaults to null): set destination #0 component value. (default: 0)
• d1 (of type int?, which defaults to null): set destination #1 component value. (default: 0)
• d2 (of type int?, which defaults to null): set destination #2 component value. (default: 0)
• d3 (of type int?, which defaults to null): set destination #3 component value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.floodfill.create

Ffmpeg filter: Fill area with same color with another color. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : int?, ?y : int?, ?s0 : int?, ?s1 : int?, ?s2 : int?, ?s3 : int?,
 ?d0 : int?, ?d1 : int?, ?d2 : int?, ?d3 : int?, ffmpeg.filter.graph) -> unit

Arguments:

• x (of type int?, which defaults to null): set pixel x coordinate. (default: 0)
• y (of type int?, which defaults to null): set pixel y coordinate. (default: 0)
• s0 (of type int?, which defaults to null): set source #0 component value. (default: 0)
• s1 (of type int?, which defaults to null): set source #1 component value. (default: 0)
• s2 (of type int?, which defaults to null): set source #2 component value. (default: 0)
• s3 (of type int?, which defaults to null): set source #3 component value. (default: 0)
• d0 (of type int?, which defaults to null): set destination #0 component value. (default: 0)
• d1 (of type int?, which defaults to null): set destination #1 component value. (default: 0)
• d2 (of type int?, which defaults to null): set destination #2 component value. (default: 0)
• d3 (of type int?, which defaults to null): set destination #3 component value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.format

Ffmpeg filter: Convert the input video to one of the specified pixel formats.

Type:

(?pix_fmts : string?, ?color_spaces : string?, ?color_ranges : string?,
 ?alpha_modes : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• pix_fmts (of type string?, which defaults to null): A '|'-separated list of pixel formats
• color_spaces (of type string?, which defaults to null): A '|'-separated list of color spaces
• color_ranges (of type string?, which defaults to null): A '|'-separated list of color ranges
• alpha_modes (of type string?, which defaults to null): A '|'-separated list of alpha modes
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.format.create

Ffmpeg filter: Convert the input video to one of the specified pixel formats. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?pix_fmts : string?, ?color_spaces : string?, ?color_ranges : string?,
 ?alpha_modes : string?, ffmpeg.filter.graph) -> unit

Arguments:

• pix_fmts (of type string?, which defaults to null): A '|'-separated list of pixel formats
• color_spaces (of type string?, which defaults to null): A '|'-separated list of color spaces
• color_ranges (of type string?, which defaults to null): A '|'-separated list of color ranges
• alpha_modes (of type string?, which defaults to null): A '|'-separated list of alpha modes
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fps

Ffmpeg filter: Force constant framerate.

Type:

(?fps : string?, ?start_time : float?, ?round : int?, ?eof_action : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• fps (of type string?, which defaults to null): A string describing desired output framerate. (default: 25)
• start_time (of type float?, which defaults to null): Assume the first PTS should be this value.. (default: 1.7976931348623157e+308)
• round (of type int?, which defaults to null): set rounding method for timestamps. (default: 5, possible values: 0 (zero), 1 (inf), 2 (down), 3 (up), 5 (near))
• eof_action (of type int?, which defaults to null): action performed for last frame. (default: 0, possible values: 0 (round), 1 (pass))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fps.create

Ffmpeg filter: Force constant framerate. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?fps : string?, ?start_time : float?, ?round : int?, ?eof_action : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• fps (of type string?, which defaults to null): A string describing desired output framerate. (default: 25)
• start_time (of type float?, which defaults to null): Assume the first PTS should be this value.. (default: 1.7976931348623157e+308)
• round (of type int?, which defaults to null): set rounding method for timestamps. (default: 5, possible values: 0 (zero), 1 (inf), 2 (down), 3 (up), 5 (near))
• eof_action (of type int?, which defaults to null): action performed for last frame. (default: 0, possible values: 0 (round), 1 (pass))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.framepack

Ffmpeg filter: Generate a frame packed stereoscopic video.

Type:

(?format : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• format (of type int?, which defaults to null): Frame pack output format. (default: 1, possible values: 1 (sbs), 2 (tab), 3 (frameseq), 6 (lines), 7 (columns))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.framepack.create

Ffmpeg filter: Generate a frame packed stereoscopic video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?format : int?, ffmpeg.filter.graph) -> unit

Arguments:

• format (of type int?, which defaults to null): Frame pack output format. (default: 1, possible values: 1 (sbs), 2 (tab), 3 (frameseq), 6 (lines), 7 (columns))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.framerate

Ffmpeg filter: Upsamples or downsamples progressive source between specified frame rates.

Type:

(?fps : string?, ?interp_start : int?, ?interp_end : int?, ?scene : float?,
 ?flags : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• fps (of type string?, which defaults to null): required output frames per second rate. (default: 50)
• interp_start (of type int?, which defaults to null): point to start linear interpolation. (default: 15)
• interp_end (of type int?, which defaults to null): point to end linear interpolation. (default: 240)
• scene (of type float?, which defaults to null): scene change level. (default: 8.2)
• flags (of type int?, which defaults to null): set flags. (default: 1, possible values: 1 (scene_change_detect), 1 (scd), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.framerate.create

Ffmpeg filter: Upsamples or downsamples progressive source between specified frame rates. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?fps : string?, ?interp_start : int?, ?interp_end : int?, ?scene : float?,
 ?flags : int?, ffmpeg.filter.graph) -> unit

Arguments:

• fps (of type string?, which defaults to null): required output frames per second rate. (default: 50)
• interp_start (of type int?, which defaults to null): point to start linear interpolation. (default: 15)
• interp_end (of type int?, which defaults to null): point to end linear interpolation. (default: 240)
• scene (of type float?, which defaults to null): scene change level. (default: 8.2)
• flags (of type int?, which defaults to null): set flags. (default: 1, possible values: 1 (scene_change_detect), 1 (scd), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.framestep

Ffmpeg filter: Select one frame every N frames.

Type:

(?step : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• step (of type int?, which defaults to null): set frame step. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.framestep.create

Ffmpeg filter: Select one frame every N frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?step : int?, ffmpeg.filter.graph) -> unit

Arguments:

• step (of type int?, which defaults to null): set frame step. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.freezedetect

Ffmpeg filter: Detects frozen video input.

Type:

(?n : float?, ?noise : float?, ?d : int?, ?duration : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• n (of type float?, which defaults to null): set noise tolerance. (default: 0.001)
• noise (of type float?, which defaults to null): set noise tolerance. (default: 0.001)
• d (of type int?, which defaults to null): set minimum duration in seconds. (default: 2)
• duration (of type int?, which defaults to null): set minimum duration in seconds. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.freezedetect.create

Ffmpeg filter: Detects frozen video input. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?n : float?, ?noise : float?, ?d : int?, ?duration : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• n (of type float?, which defaults to null): set noise tolerance. (default: 0.001)
• noise (of type float?, which defaults to null): set noise tolerance. (default: 0.001)
• d (of type int?, which defaults to null): set minimum duration in seconds. (default: 2)
• duration (of type int?, which defaults to null): set minimum duration in seconds. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.freezeframes

Ffmpeg filter: Freeze video frames.

Type:

(?first : int?, ?last : int?, ?replace : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• first (of type int?, which defaults to null): set first frame to freeze. (default: 0)
• last (of type int?, which defaults to null): set last frame to freeze. (default: 0)
• replace (of type int?, which defaults to null): set frame to replace. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.freezeframes.create

Ffmpeg filter: Freeze video frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?first : int?, ?last : int?, ?replace : int?, ffmpeg.filter.graph) -> unit

Arguments:

• first (of type int?, which defaults to null): set first frame to freeze. (default: 0)
• last (of type int?, which defaults to null): set last frame to freeze. (default: 0)
• replace (of type int?, which defaults to null): set frame to replace. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fspp

Ffmpeg filter: Apply Fast Simple Post-processing filter.

Type:

(?quality : int?, ?qp : int?, ?strength : int?, ?use_bframe_qp : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• quality (of type int?, which defaults to null): set quality. (default: 4)
• qp (of type int?, which defaults to null): force a constant quantizer parameter. (default: 0)
• strength (of type int?, which defaults to null): set filter strength. (default: 0)
• use_bframe_qp (of type bool?, which defaults to null): use B-frames' QP. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fspp.create

Ffmpeg filter: Apply Fast Simple Post-processing filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?quality : int?, ?qp : int?, ?strength : int?, ?use_bframe_qp : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• quality (of type int?, which defaults to null): set quality. (default: 4)
• qp (of type int?, which defaults to null): force a constant quantizer parameter. (default: 0)
• strength (of type int?, which defaults to null): set filter strength. (default: 0)
• use_bframe_qp (of type bool?, which defaults to null): use B-frames' QP. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.fsync

Ffmpeg filter: Synchronize video frames from external source.

Type:

(?file : string?, ?f : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• file (of type string?, which defaults to null): set the file name to use for frame sync. (default: )
• f (of type string?, which defaults to null): set the file name to use for frame sync. (default: )
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.fsync.create

Ffmpeg filter: Synchronize video frames from external source. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?file : string?, ?f : string?, ffmpeg.filter.graph) -> unit

Arguments:

• file (of type string?, which defaults to null): set the file name to use for frame sync. (default: )
• f (of type string?, which defaults to null): set the file name to use for frame sync. (default: )
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.gblur

Ffmpeg filter: Apply Gaussian Blur filter.

Type:

(?sigma : float?, ?steps : int?, ?planes : int?, ?sigmaV : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• sigma (of type float?, which defaults to null): set sigma. (default: 0.5)
• steps (of type int?, which defaults to null): set number of steps. (default: 1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• sigmaV (of type float?, which defaults to null): set vertical sigma. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.gblur.create

Ffmpeg filter: Apply Gaussian Blur filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sigma : float?, ?steps : int?, ?planes : int?, ?sigmaV : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• sigma (of type float?, which defaults to null): set sigma. (default: 0.5)
• steps (of type int?, which defaults to null): set number of steps. (default: 1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• sigmaV (of type float?, which defaults to null): set vertical sigma. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.geq

Ffmpeg filter: Apply generic equation to each pixel.

Type:

(?lum_expr : string?, ?lum : string?, ?cb_expr : string?, ?cb : string?,
 ?cr_expr : string?, ?cr : string?, ?alpha_expr : string?, ?a : string?,
 ?red_expr : string?, ?r : string?, ?green_expr : string?, ?g : string?,
 ?blue_expr : string?, ?b : string?, ?interpolation : int?, ?i : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• lum_expr (of type string?, which defaults to null): set luminance expression
• lum (of type string?, which defaults to null): set luminance expression
• cb_expr (of type string?, which defaults to null): set chroma blue expression
• cb (of type string?, which defaults to null): set chroma blue expression
• cr_expr (of type string?, which defaults to null): set chroma red expression
• cr (of type string?, which defaults to null): set chroma red expression
• alpha_expr (of type string?, which defaults to null): set alpha expression
• a (of type string?, which defaults to null): set alpha expression
• red_expr (of type string?, which defaults to null): set red expression
• r (of type string?, which defaults to null): set red expression
• green_expr (of type string?, which defaults to null): set green expression
• g (of type string?, which defaults to null): set green expression
• blue_expr (of type string?, which defaults to null): set blue expression
• b (of type string?, which defaults to null): set blue expression
• interpolation (of type int?, which defaults to null): set interpolation method. (default: 1, possible values: 0 (nearest), 0 (n), 1 (bilinear), 1 (b))
• i (of type int?, which defaults to null): set interpolation method. (default: 1, possible values: 0 (nearest), 0 (n), 1 (bilinear), 1 (b))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.geq.create

Ffmpeg filter: Apply generic equation to each pixel. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?lum_expr : string?, ?lum : string?, ?cb_expr : string?, ?cb : string?,
 ?cr_expr : string?, ?cr : string?, ?alpha_expr : string?, ?a : string?,
 ?red_expr : string?, ?r : string?, ?green_expr : string?, ?g : string?,
 ?blue_expr : string?, ?b : string?, ?interpolation : int?, ?i : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• lum_expr (of type string?, which defaults to null): set luminance expression
• lum (of type string?, which defaults to null): set luminance expression
• cb_expr (of type string?, which defaults to null): set chroma blue expression
• cb (of type string?, which defaults to null): set chroma blue expression
• cr_expr (of type string?, which defaults to null): set chroma red expression
• cr (of type string?, which defaults to null): set chroma red expression
• alpha_expr (of type string?, which defaults to null): set alpha expression
• a (of type string?, which defaults to null): set alpha expression
• red_expr (of type string?, which defaults to null): set red expression
• r (of type string?, which defaults to null): set red expression
• green_expr (of type string?, which defaults to null): set green expression
• g (of type string?, which defaults to null): set green expression
• blue_expr (of type string?, which defaults to null): set blue expression
• b (of type string?, which defaults to null): set blue expression
• interpolation (of type int?, which defaults to null): set interpolation method. (default: 1, possible values: 0 (nearest), 0 (n), 1 (bilinear), 1 (b))
• i (of type int?, which defaults to null): set interpolation method. (default: 1, possible values: 0 (nearest), 0 (n), 1 (bilinear), 1 (b))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.gradfun

Ffmpeg filter: Debands video quickly using gradients.

Type:

(?strength : float?, ?radius : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• strength (of type float?, which defaults to null): The maximum amount by which the filter will change any one pixel.. (default: 1.2)
• radius (of type int?, which defaults to null): The neighborhood to fit the gradient to.. (default: 16)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.gradfun.create

Ffmpeg filter: Debands video quickly using gradients. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?strength : float?, ?radius : int?, ffmpeg.filter.graph) -> unit

Arguments:

• strength (of type float?, which defaults to null): The maximum amount by which the filter will change any one pixel.. (default: 1.2)
• radius (of type int?, which defaults to null): The neighborhood to fit the gradient to.. (default: 16)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.gradients

Ffmpeg filter: Draw a gradients.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?, ?c0 : string?,
 ?c1 : string?, ?c2 : string?, ?c3 : string?, ?c4 : string?, ?c5 : string?,
 ?c6 : string?, ?c7 : string?, ?x0 : int?, ?y0 : int?, ?x1 : int?,
 ?y1 : int?, ?nb_colors : int?, ?n : int?, ?seed : int?, ?duration : int?,
 ?d : int?, ?speed : float?, ?type : int?, ?t : int?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set frame size. (default: 640x480)
• s (of type string?, which defaults to null): set frame size. (default: 640x480)
• rate (of type string?, which defaults to null): set frame rate. (default: 25)
• r (of type string?, which defaults to null): set frame rate. (default: 25)
• c0 (of type string?, which defaults to null): set 1st color. (default: random)
• c1 (of type string?, which defaults to null): set 2nd color. (default: random)
• c2 (of type string?, which defaults to null): set 3rd color. (default: random)
• c3 (of type string?, which defaults to null): set 4th color. (default: random)
• c4 (of type string?, which defaults to null): set 5th color. (default: random)
• c5 (of type string?, which defaults to null): set 6th color. (default: random)
• c6 (of type string?, which defaults to null): set 7th color. (default: random)
• c7 (of type string?, which defaults to null): set 8th color. (default: random)
• x0 (of type int?, which defaults to null): set gradient line source x0. (default: -1)
• y0 (of type int?, which defaults to null): set gradient line source y0. (default: -1)
• x1 (of type int?, which defaults to null): set gradient line destination x1. (default: -1)
• y1 (of type int?, which defaults to null): set gradient line destination y1. (default: -1)
• nb_colors (of type int?, which defaults to null): set the number of colors. (default: 2)
• n (of type int?, which defaults to null): set the number of colors. (default: 2)
• seed (of type int?, which defaults to null): set the seed. (default: -1)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• speed (of type float?, which defaults to null): set gradients rotation speed. (default: 0.01)
• type (of type int?, which defaults to null): set gradient type. (default: 0, possible values: 0 (linear), 1 (radial), 2 (circular), 3 (spiral), 4 (square))
• t (of type int?, which defaults to null): set gradient type. (default: 0, possible values: 0 (linear), 1 (radial), 2 (circular), 3 (spiral), 4 (square))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.gradients.create

Ffmpeg filter: Draw a gradients. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?, ?c0 : string?,
 ?c1 : string?, ?c2 : string?, ?c3 : string?, ?c4 : string?, ?c5 : string?,
 ?c6 : string?, ?c7 : string?, ?x0 : int?, ?y0 : int?, ?x1 : int?,
 ?y1 : int?, ?nb_colors : int?, ?n : int?, ?seed : int?, ?duration : int?,
 ?d : int?, ?speed : float?, ?type : int?, ?t : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• size (of type string?, which defaults to null): set frame size. (default: 640x480)
• s (of type string?, which defaults to null): set frame size. (default: 640x480)
• rate (of type string?, which defaults to null): set frame rate. (default: 25)
• r (of type string?, which defaults to null): set frame rate. (default: 25)
• c0 (of type string?, which defaults to null): set 1st color. (default: random)
• c1 (of type string?, which defaults to null): set 2nd color. (default: random)
• c2 (of type string?, which defaults to null): set 3rd color. (default: random)
• c3 (of type string?, which defaults to null): set 4th color. (default: random)
• c4 (of type string?, which defaults to null): set 5th color. (default: random)
• c5 (of type string?, which defaults to null): set 6th color. (default: random)
• c6 (of type string?, which defaults to null): set 7th color. (default: random)
• c7 (of type string?, which defaults to null): set 8th color. (default: random)
• x0 (of type int?, which defaults to null): set gradient line source x0. (default: -1)
• y0 (of type int?, which defaults to null): set gradient line source y0. (default: -1)
• x1 (of type int?, which defaults to null): set gradient line destination x1. (default: -1)
• y1 (of type int?, which defaults to null): set gradient line destination y1. (default: -1)
• nb_colors (of type int?, which defaults to null): set the number of colors. (default: 2)
• n (of type int?, which defaults to null): set the number of colors. (default: 2)
• seed (of type int?, which defaults to null): set the seed. (default: -1)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• speed (of type float?, which defaults to null): set gradients rotation speed. (default: 0.01)
• type (of type int?, which defaults to null): set gradient type. (default: 0, possible values: 0 (linear), 1 (radial), 2 (circular), 3 (spiral), 4 (square))
• t (of type int?, which defaults to null): set gradient type. (default: 0, possible values: 0 (linear), 1 (radial), 2 (circular), 3 (spiral), 4 (square))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.graphmonitor

Ffmpeg filter: Show various filtergraph stats.

Type:

(?size : string?, ?s : string?, ?opacity : float?, ?o : float?, ?mode : int?,
 ?m : int?, ?flags : int?, ?f : int?, ?rate : string?, ?r : string?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set monitor size. (default: hd720)
• s (of type string?, which defaults to null): set monitor size. (default: hd720)
• opacity (of type float?, which defaults to null): set video opacity. (default: 0.9)
• o (of type float?, which defaults to null): set video opacity. (default: 0.9)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact), 2 (nozero), 4 (noeof), 8 (nodisabled), combined by addition)
• m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact), 2 (nozero), 4 (noeof), 8 (nodisabled), combined by addition)
• flags (of type int?, which defaults to null): set flags. (default: 1, possible values: 0 (none), 2147483647 (all), 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 16384 (frame_count_delta), 8 (pts), 4096 (pts_delta), 16 (time), 8192 (time_delta), 32 (timebase), 64 (format), 128 (size), 256 (rate), 512 (eof), 2048 (sample_count_in), 1024 (sample_count_out), 32768 (sample_count_delta), 65536 (disabled), combined by addition)
• f (of type int?, which defaults to null): set flags. (default: 1, possible values: 0 (none), 2147483647 (all), 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 16384 (frame_count_delta), 8 (pts), 4096 (pts_delta), 16 (time), 8192 (time_delta), 32 (timebase), 64 (format), 128 (size), 256 (rate), 512 (eof), 2048 (sample_count_in), 1024 (sample_count_out), 32768 (sample_count_delta), 65536 (disabled), combined by addition)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.graphmonitor.create

Ffmpeg filter: Show various filtergraph stats. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?opacity : float?, ?o : float?, ?mode : int?,
 ?m : int?, ?flags : int?, ?f : int?, ?rate : string?, ?r : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set monitor size. (default: hd720)
• s (of type string?, which defaults to null): set monitor size. (default: hd720)
• opacity (of type float?, which defaults to null): set video opacity. (default: 0.9)
• o (of type float?, which defaults to null): set video opacity. (default: 0.9)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact), 2 (nozero), 4 (noeof), 8 (nodisabled), combined by addition)
• m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact), 2 (nozero), 4 (noeof), 8 (nodisabled), combined by addition)
• flags (of type int?, which defaults to null): set flags. (default: 1, possible values: 0 (none), 2147483647 (all), 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 16384 (frame_count_delta), 8 (pts), 4096 (pts_delta), 16 (time), 8192 (time_delta), 32 (timebase), 64 (format), 128 (size), 256 (rate), 512 (eof), 2048 (sample_count_in), 1024 (sample_count_out), 32768 (sample_count_delta), 65536 (disabled), combined by addition)
• f (of type int?, which defaults to null): set flags. (default: 1, possible values: 0 (none), 2147483647 (all), 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 16384 (frame_count_delta), 8 (pts), 4096 (pts_delta), 16 (time), 8192 (time_delta), 32 (timebase), 64 (format), 128 (size), 256 (rate), 512 (eof), 2048 (sample_count_in), 1024 (sample_count_out), 32768 (sample_count_delta), 65536 (disabled), combined by addition)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.grayworld

Ffmpeg filter: Adjust white balance using LAB gray world algorithm.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.grayworld.create

Ffmpeg filter: Adjust white balance using LAB gray world algorithm. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.greyedge

Ffmpeg filter: Estimates scene illumination by grey edge assumption.

Type:

(?difford : int?, ?minknorm : int?, ?sigma : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• difford (of type int?, which defaults to null): set differentiation order. (default: 1)
• minknorm (of type int?, which defaults to null): set Minkowski norm. (default: 1)
• sigma (of type float?, which defaults to null): set sigma. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.greyedge.create

Ffmpeg filter: Estimates scene illumination by grey edge assumption. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?difford : int?, ?minknorm : int?, ?sigma : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• difford (of type int?, which defaults to null): set differentiation order. (default: 1)
• minknorm (of type int?, which defaults to null): set Minkowski norm. (default: 1)
• sigma (of type float?, which defaults to null): set sigma. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.guided

Ffmpeg filter: Apply Guided filter. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?radius : int?, ?eps : float?, ?mode : int?, ?sub : int?, ?guidance : int?,
 ?planes : int?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• radius (of type int?, which defaults to null): set the box radius. (default: 3)
• eps (of type float?, which defaults to null): set the regularization parameter (with square). (default: 0.01)
• mode (of type int?, which defaults to null): set filtering mode (0: basic mode; 1: fast mode). (default: 0, possible values: 0 (basic), 1 (fast))
• sub (of type int?, which defaults to null): subsampling ratio for fast mode. (default: 4)
• guidance (of type int?, which defaults to null): set guidance mode (0: off mode; 1: on mode). (default: 0, possible values: 0 (off), 1 (on))
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.guided.create

Ffmpeg filter: Apply Guided filter. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?radius : int?, ?eps : float?, ?mode : int?, ?sub : int?, ?guidance : int?,
 ?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• radius (of type int?, which defaults to null): set the box radius. (default: 3)
• eps (of type float?, which defaults to null): set the regularization parameter (with square). (default: 0.01)
• mode (of type int?, which defaults to null): set filtering mode (0: basic mode; 1: fast mode). (default: 0, possible values: 0 (basic), 1 (fast))
• sub (of type int?, which defaults to null): subsampling ratio for fast mode. (default: 4)
• guidance (of type int?, which defaults to null): set guidance mode (0: off mode; 1: on mode). (default: 0, possible values: 0 (off), 1 (on))
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.haas

Ffmpeg filter: Apply Haas Stereo Enhancer.

Type:

(?level_in : float?, ?level_out : float?, ?side_gain : float?,
 ?middle_source : int?, ?middle_phase : bool?, ?left_delay : float?,
 ?left_balance : float?, ?left_gain : float?, ?left_phase : bool?,
 ?right_delay : float?, ?right_balance : float?, ?right_gain : float?,
 ?right_phase : bool?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set level in. (default: 1)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• side_gain (of type float?, which defaults to null): set side gain. (default: 1)
• middle_source (of type int?, which defaults to null): set middle source. (default: 2, possible values: 0 (left), 1 (right), 2 (mid), 3 (side))
• middle_phase (of type bool?, which defaults to null): set middle phase. (default: false)
• left_delay (of type float?, which defaults to null): set left delay. (default: 2.05)
• left_balance (of type float?, which defaults to null): set left balance. (default: -1)
• left_gain (of type float?, which defaults to null): set left gain. (default: 1)
• left_phase (of type bool?, which defaults to null): set left phase. (default: false)
• right_delay (of type float?, which defaults to null): set right delay. (default: 2.12)
• right_balance (of type float?, which defaults to null): set right balance. (default: 1)
• right_gain (of type float?, which defaults to null): set right gain. (default: 1)
• right_phase (of type bool?, which defaults to null): set right phase. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.haas.create

Ffmpeg filter: Apply Haas Stereo Enhancer. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?level_out : float?, ?side_gain : float?,
 ?middle_source : int?, ?middle_phase : bool?, ?left_delay : float?,
 ?left_balance : float?, ?left_gain : float?, ?left_phase : bool?,
 ?right_delay : float?, ?right_balance : float?, ?right_gain : float?,
 ?right_phase : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set level in. (default: 1)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• side_gain (of type float?, which defaults to null): set side gain. (default: 1)
• middle_source (of type int?, which defaults to null): set middle source. (default: 2, possible values: 0 (left), 1 (right), 2 (mid), 3 (side))
• middle_phase (of type bool?, which defaults to null): set middle phase. (default: false)
• left_delay (of type float?, which defaults to null): set left delay. (default: 2.05)
• left_balance (of type float?, which defaults to null): set left balance. (default: -1)
• left_gain (of type float?, which defaults to null): set left gain. (default: 1)
• left_phase (of type bool?, which defaults to null): set left phase. (default: false)
• right_delay (of type float?, which defaults to null): set right delay. (default: 2.12)
• right_balance (of type float?, which defaults to null): set right balance. (default: 1)
• right_gain (of type float?, which defaults to null): set right gain. (default: 1)
• right_phase (of type bool?, which defaults to null): set right phase. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.haldclut

Ffmpeg filter: Adjust colors using a Hald CLUT.

Type:

(?clut : int?, ?interp : int?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• clut (of type int?, which defaults to null): when to process CLUT. (default: 1, possible values: 0 (first), 1 (all))
• interp (of type int?, which defaults to null): select interpolation mode. (default: 2, possible values: 0 (nearest), 1 (trilinear), 2 (tetrahedral), 3 (pyramid), 4 (prism))
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.haldclut.create

Ffmpeg filter: Adjust colors using a Hald CLUT. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?clut : int?, ?interp : int?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• clut (of type int?, which defaults to null): when to process CLUT. (default: 1, possible values: 0 (first), 1 (all))
• interp (of type int?, which defaults to null): select interpolation mode. (default: 2, possible values: 0 (nearest), 1 (trilinear), 2 (tetrahedral), 3 (pyramid), 4 (prism))
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.haldclutsrc

Ffmpeg filter: Provide an identity Hald CLUT.

Type:

(?level : int?, ?rate : string?, ?r : string?, ?duration : int?, ?d : int?,
 ?sar : string?, ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• level (of type int?, which defaults to null): set level. (default: 6)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.haldclutsrc.create

Ffmpeg filter: Provide an identity Hald CLUT. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level : int?, ?rate : string?, ?r : string?, ?duration : int?, ?d : int?,
 ?sar : string?, ffmpeg.filter.graph) -> unit

Arguments:

• level (of type int?, which defaults to null): set level. (default: 6)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hdcd

Ffmpeg filter: Apply High Definition Compatible Digital (HDCD) decoding.

Type:

(?disable_autoconvert : bool?, ?process_stereo : bool?, ?cdt_ms : int?,
 ?force_pe : bool?, ?analyze_mode : int?, ?bits_per_sample : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• disable_autoconvert (of type bool?, which defaults to null): Disable any format conversion or resampling in the filter graph.. (default: true)
• process_stereo (of type bool?, which defaults to null): Process stereo channels together. Only apply target_gain when both channels match.. (default: true)
• cdt_ms (of type int?, which defaults to null): Code detect timer period in ms.. (default: 2000)
• force_pe (of type bool?, which defaults to null): Always extend peaks above -3dBFS even when PE is not signaled.. (default: false)
• analyze_mode (of type int?, which defaults to null): Replace audio with solid tone and signal some processing aspect in the amplitude.. (default: 0, possible values: 0 (off), 1 (lle), 2 (pe), 3 (cdt), 4 (tgm))
• bits_per_sample (of type int?, which defaults to null): Valid bits per sample (location of the true LSB).. (default: 16, possible values: 16 (16), 20 (20), 24 (24))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.hdcd.create

Ffmpeg filter: Apply High Definition Compatible Digital (HDCD) decoding. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?disable_autoconvert : bool?, ?process_stereo : bool?, ?cdt_ms : int?,
 ?force_pe : bool?, ?analyze_mode : int?, ?bits_per_sample : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• disable_autoconvert (of type bool?, which defaults to null): Disable any format conversion or resampling in the filter graph.. (default: true)
• process_stereo (of type bool?, which defaults to null): Process stereo channels together. Only apply target_gain when both channels match.. (default: true)
• cdt_ms (of type int?, which defaults to null): Code detect timer period in ms.. (default: 2000)
• force_pe (of type bool?, which defaults to null): Always extend peaks above -3dBFS even when PE is not signaled.. (default: false)
• analyze_mode (of type int?, which defaults to null): Replace audio with solid tone and signal some processing aspect in the amplitude.. (default: 0, possible values: 0 (off), 1 (lle), 2 (pe), 3 (cdt), 4 (tgm))
• bits_per_sample (of type int?, which defaults to null): Valid bits per sample (location of the true LSB).. (default: 16, possible values: 16 (16), 20 (20), 24 (24))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.headphone

Ffmpeg filter: Apply headphone binaural spatialization with HRTFs in additional streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?map : string?, ?gain : float?, ?lfe : float?, ?type : int?, ?size : int?,
 ?hrir : int?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.audio

Arguments:

• map (of type string?, which defaults to null): set channels convolution mappings
• gain (of type float?, which defaults to null): set gain in dB. (default: 0)
• lfe (of type float?, which defaults to null): set lfe gain in dB. (default: 0)
• type (of type int?, which defaults to null): set processing. (default: 1, possible values: 0 (time), 1 (freq))
• size (of type int?, which defaults to null): set frame size. (default: 1024)
• hrir (of type int?, which defaults to null): set hrir format. (default: 0, possible values: 0 (stereo), 1 (multich))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.headphone.create

Ffmpeg filter: Apply headphone binaural spatialization with HRTFs in additional streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?map : string?, ?gain : float?, ?lfe : float?, ?type : int?, ?size : int?,
 ?hrir : int?, ffmpeg.filter.graph) -> unit

Arguments:

• map (of type string?, which defaults to null): set channels convolution mappings
• gain (of type float?, which defaults to null): set gain in dB. (default: 0)
• lfe (of type float?, which defaults to null): set lfe gain in dB. (default: 0)
• type (of type int?, which defaults to null): set processing. (default: 1, possible values: 0 (time), 1 (freq))
• size (of type int?, which defaults to null): set frame size. (default: 1024)
• hrir (of type int?, which defaults to null): set hrir format. (default: 0, possible values: 0 (stereo), 1 (multich))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hflip

Ffmpeg filter: Horizontally flip the input video.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hflip.create

Ffmpeg filter: Horizontally flip the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.highpass

Ffmpeg filter: Apply a high-pass filter with 3dB point frequency.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?poles : int?, ?p : int?, ?mix : float?,
 ?m : float?, ?channels : string?, ?c : string?, ?normalize : bool?,
 ?n : bool?, ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set frequency. (default: 3000)
• f (of type float?, which defaults to null): set frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.707)
• w (of type float?, which defaults to null): set width. (default: 0.707)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.highpass.create

Ffmpeg filter: Apply a high-pass filter with 3dB point frequency. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?poles : int?, ?p : int?, ?mix : float?,
 ?m : float?, ?channels : string?, ?c : string?, ?normalize : bool?,
 ?n : bool?, ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set frequency. (default: 3000)
• f (of type float?, which defaults to null): set frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.707)
• w (of type float?, which defaults to null): set width. (default: 0.707)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.highshelf

Ffmpeg filter: Apply a high shelf filter.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.highshelf.create

Ffmpeg filter: Apply a high shelf filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hilbert

Ffmpeg filter: Generate a Hilbert transform FIR coefficients.

Type:

(?sample_rate : int?, ?r : int?, ?taps : int?, ?t : int?, ?nb_samples : int?,
 ?n : int?, ?win_func : int?, ?w : int?, ffmpeg.filter.graph) ->
ffmpeg.filter.audio

Arguments:

• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• taps (of type int?, which defaults to null): set number of taps. (default: 22051)
• t (of type int?, which defaults to null): set number of taps. (default: 22051)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• win_func (of type int?, which defaults to null): set window function. (default: 3, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser), 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• w (of type int?, which defaults to null): set window function. (default: 3, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser), 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.hilbert.create

Ffmpeg filter: Generate a Hilbert transform FIR coefficients. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sample_rate : int?, ?r : int?, ?taps : int?, ?t : int?, ?nb_samples : int?,
 ?n : int?, ?win_func : int?, ?w : int?, ffmpeg.filter.graph) -> unit

Arguments:

• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• taps (of type int?, which defaults to null): set number of taps. (default: 22051)
• t (of type int?, which defaults to null): set number of taps. (default: 22051)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• win_func (of type int?, which defaults to null): set window function. (default: 3, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser), 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• w (of type int?, which defaults to null): set window function. (default: 3, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser), 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.histeq

Ffmpeg filter: Apply global color histogram equalization.

Type:

(?strength : float?, ?intensity : float?, ?antibanding : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• strength (of type float?, which defaults to null): set the strength. (default: 0.2)
• intensity (of type float?, which defaults to null): set the intensity. (default: 0.21)
• antibanding (of type int?, which defaults to null): set the antibanding level. (default: 0, possible values: 0 (none), 1 (weak), 2 (strong))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.histeq.create

Ffmpeg filter: Apply global color histogram equalization. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?strength : float?, ?intensity : float?, ?antibanding : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• strength (of type float?, which defaults to null): set the strength. (default: 0.2)
• intensity (of type float?, which defaults to null): set the intensity. (default: 0.21)
• antibanding (of type int?, which defaults to null): set the antibanding level. (default: 0, possible values: 0 (none), 1 (weak), 2 (strong))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.histogram

Ffmpeg filter: Compute and draw a histogram.

Type:

(?level_height : int?, ?scale_height : int?, ?display_mode : int?, ?d : int?,
 ?levels_mode : int?, ?m : int?, ?components : int?, ?c : int?,
 ?fgopacity : float?, ?f : float?, ?bgopacity : float?, ?b : float?,
 ?colors_mode : int?, ?l : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• level_height (of type int?, which defaults to null): set level height. (default: 200)
• scale_height (of type int?, which defaults to null): set scale height. (default: 12)
• display_mode (of type int?, which defaults to null): set display mode. (default: 2, possible values: 0 (overlay), 1 (parade), 2 (stack))
• d (of type int?, which defaults to null): set display mode. (default: 2, possible values: 0 (overlay), 1 (parade), 2 (stack))
• levels_mode (of type int?, which defaults to null): set levels mode. (default: 0, possible values: 0 (linear), 1 (logarithmic))
• m (of type int?, which defaults to null): set levels mode. (default: 0, possible values: 0 (linear), 1 (logarithmic))
• components (of type int?, which defaults to null): set color components to display. (default: 7)
• c (of type int?, which defaults to null): set color components to display. (default: 7)
• fgopacity (of type float?, which defaults to null): set foreground opacity. (default: 0.7)
• f (of type float?, which defaults to null): set foreground opacity. (default: 0.7)
• bgopacity (of type float?, which defaults to null): set background opacity. (default: 0.5)
• b (of type float?, which defaults to null): set background opacity. (default: 0.5)
• colors_mode (of type int?, which defaults to null): set colors mode. (default: 0, possible values: 0 (whiteonblack), 1 (blackonwhite), 2 (whiteongray), 3 (blackongray), 4 (coloronblack), 5 (coloronwhite), 6 (colorongray), 7 (blackoncolor), 8 (whiteoncolor), 9 (grayoncolor))
• l (of type int?, which defaults to null): set colors mode. (default: 0, possible values: 0 (whiteonblack), 1 (blackonwhite), 2 (whiteongray), 3 (blackongray), 4 (coloronblack), 5 (coloronwhite), 6 (colorongray), 7 (blackoncolor), 8 (whiteoncolor), 9 (grayoncolor))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.histogram.create

Ffmpeg filter: Compute and draw a histogram. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_height : int?, ?scale_height : int?, ?display_mode : int?, ?d : int?,
 ?levels_mode : int?, ?m : int?, ?components : int?, ?c : int?,
 ?fgopacity : float?, ?f : float?, ?bgopacity : float?, ?b : float?,
 ?colors_mode : int?, ?l : int?, ffmpeg.filter.graph) -> unit

Arguments:

• level_height (of type int?, which defaults to null): set level height. (default: 200)
• scale_height (of type int?, which defaults to null): set scale height. (default: 12)
• display_mode (of type int?, which defaults to null): set display mode. (default: 2, possible values: 0 (overlay), 1 (parade), 2 (stack))
• d (of type int?, which defaults to null): set display mode. (default: 2, possible values: 0 (overlay), 1 (parade), 2 (stack))
• levels_mode (of type int?, which defaults to null): set levels mode. (default: 0, possible values: 0 (linear), 1 (logarithmic))
• m (of type int?, which defaults to null): set levels mode. (default: 0, possible values: 0 (linear), 1 (logarithmic))
• components (of type int?, which defaults to null): set color components to display. (default: 7)
• c (of type int?, which defaults to null): set color components to display. (default: 7)
• fgopacity (of type float?, which defaults to null): set foreground opacity. (default: 0.7)
• f (of type float?, which defaults to null): set foreground opacity. (default: 0.7)
• bgopacity (of type float?, which defaults to null): set background opacity. (default: 0.5)
• b (of type float?, which defaults to null): set background opacity. (default: 0.5)
• colors_mode (of type int?, which defaults to null): set colors mode. (default: 0, possible values: 0 (whiteonblack), 1 (blackonwhite), 2 (whiteongray), 3 (blackongray), 4 (coloronblack), 5 (coloronwhite), 6 (colorongray), 7 (blackoncolor), 8 (whiteoncolor), 9 (grayoncolor))
• l (of type int?, which defaults to null): set colors mode. (default: 0, possible values: 0 (whiteonblack), 1 (blackonwhite), 2 (whiteongray), 3 (blackongray), 4 (coloronblack), 5 (coloronwhite), 6 (colorongray), 7 (blackoncolor), 8 (whiteoncolor), 9 (grayoncolor))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hqdn3d

Ffmpeg filter: Apply a High Quality 3D Denoiser.

Type:

(?luma_spatial : float?, ?chroma_spatial : float?, ?luma_tmp : float?,
 ?chroma_tmp : float?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• luma_spatial (of type float?, which defaults to null): spatial luma strength. (default: 0)
• chroma_spatial (of type float?, which defaults to null): spatial chroma strength. (default: 0)
• luma_tmp (of type float?, which defaults to null): temporal luma strength. (default: 0)
• chroma_tmp (of type float?, which defaults to null): temporal chroma strength. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hqdn3d.create

Ffmpeg filter: Apply a High Quality 3D Denoiser. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?luma_spatial : float?, ?chroma_spatial : float?, ?luma_tmp : float?,
 ?chroma_tmp : float?, ffmpeg.filter.graph) -> unit

Arguments:

• luma_spatial (of type float?, which defaults to null): spatial luma strength. (default: 0)
• chroma_spatial (of type float?, which defaults to null): spatial chroma strength. (default: 0)
• luma_tmp (of type float?, which defaults to null): temporal luma strength. (default: 0)
• chroma_tmp (of type float?, which defaults to null): temporal chroma strength. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hqx

Ffmpeg filter: Scale the input by 2, 3 or 4 using the hq*x magnification algorithm.

Type:

(?n : int?, ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• n (of type int?, which defaults to null): set scale factor. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hqx.create

Ffmpeg filter: Scale the input by 2, 3 or 4 using the hq*x magnification algorithm. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?n : int?, ffmpeg.filter.graph) -> unit

Arguments:

• n (of type int?, which defaults to null): set scale factor. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hstack

Ffmpeg filter: Stack video inputs horizontally. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?shortest : bool?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.hstack.create

Ffmpeg filter: Stack video inputs horizontally. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?shortest : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hsvhold

Ffmpeg filter: Turns a certain HSV range into gray.

Type:

(?hue : float?, ?sat : float?, ?val : float?, ?similarity : float?,
 ?blend : float?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• hue (of type float?, which defaults to null): set the hue value. (default: 0)
• sat (of type float?, which defaults to null): set the saturation value. (default: 0)
• val (of type float?, which defaults to null): set the value value. (default: 0)
• similarity (of type float?, which defaults to null): set the hsvhold similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the hsvhold blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hsvhold.create

Ffmpeg filter: Turns a certain HSV range into gray. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?hue : float?, ?sat : float?, ?val : float?, ?similarity : float?,
 ?blend : float?, ffmpeg.filter.graph) -> unit

Arguments:

• hue (of type float?, which defaults to null): set the hue value. (default: 0)
• sat (of type float?, which defaults to null): set the saturation value. (default: 0)
• val (of type float?, which defaults to null): set the value value. (default: 0)
• similarity (of type float?, which defaults to null): set the hsvhold similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the hsvhold blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hsvkey

Ffmpeg filter: Turns a certain HSV range into transparency. Operates on YUV colors.

Type:

(?hue : float?, ?sat : float?, ?val : float?, ?similarity : float?,
 ?blend : float?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• hue (of type float?, which defaults to null): set the hue value. (default: 0)
• sat (of type float?, which defaults to null): set the saturation value. (default: 0)
• val (of type float?, which defaults to null): set the value value. (default: 0)
• similarity (of type float?, which defaults to null): set the hsvkey similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the hsvkey blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hsvkey.create

Ffmpeg filter: Turns a certain HSV range into transparency. Operates on YUV colors. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?hue : float?, ?sat : float?, ?val : float?, ?similarity : float?,
 ?blend : float?, ffmpeg.filter.graph) -> unit

Arguments:

• hue (of type float?, which defaults to null): set the hue value. (default: 0)
• sat (of type float?, which defaults to null): set the saturation value. (default: 0)
• val (of type float?, which defaults to null): set the value value. (default: 0)
• similarity (of type float?, which defaults to null): set the hsvkey similarity value. (default: 0.01)
• blend (of type float?, which defaults to null): set the hsvkey blend value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hue

Ffmpeg filter: Adjust the hue and saturation of the input video.

Type:

(?h : string?, ?s : string?, ?H : string?, ?b : string?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• h (of type string?, which defaults to null): set the hue angle degrees expression
• s (of type string?, which defaults to null): set the saturation expression. (default: 1)
• H (of type string?, which defaults to null): set the hue angle radians expression
• b (of type string?, which defaults to null): set the brightness expression. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hue.create

Ffmpeg filter: Adjust the hue and saturation of the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?h : string?, ?s : string?, ?H : string?, ?b : string?, ffmpeg.filter.graph) ->
unit

Arguments:

• h (of type string?, which defaults to null): set the hue angle degrees expression
• s (of type string?, which defaults to null): set the saturation expression. (default: 1)
• H (of type string?, which defaults to null): set the hue angle radians expression
• b (of type string?, which defaults to null): set the brightness expression. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.huesaturation

Ffmpeg filter: Apply hue-saturation-intensity adjustments.

Type:

(?hue : float?, ?saturation : float?, ?intensity : float?, ?colors : int?,
 ?strength : float?, ?rw : float?, ?gw : float?, ?bw : float?,
 ?lightness : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• hue (of type float?, which defaults to null): set the hue shift. (default: 0)
• saturation (of type float?, which defaults to null): set the saturation shift. (default: 0)
• intensity (of type float?, which defaults to null): set the intensity shift. (default: 0)
• colors (of type int?, which defaults to null): set colors range. (default: 63, possible values: 1 (r), 2 (y), 4 (g), 8 (c), 16 (b), 32 (m), 63 (a), combined by addition)
• strength (of type float?, which defaults to null): set the filtering strength. (default: 1)
• rw (of type float?, which defaults to null): set the red weight. (default: 0.333)
• gw (of type float?, which defaults to null): set the green weight. (default: 0.334)
• bw (of type float?, which defaults to null): set the blue weight. (default: 0.333)
• lightness (of type bool?, which defaults to null): set the preserve lightness. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.huesaturation.create

Ffmpeg filter: Apply hue-saturation-intensity adjustments. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?hue : float?, ?saturation : float?, ?intensity : float?, ?colors : int?,
 ?strength : float?, ?rw : float?, ?gw : float?, ?bw : float?,
 ?lightness : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• hue (of type float?, which defaults to null): set the hue shift. (default: 0)
• saturation (of type float?, which defaults to null): set the saturation shift. (default: 0)
• intensity (of type float?, which defaults to null): set the intensity shift. (default: 0)
• colors (of type int?, which defaults to null): set colors range. (default: 63, possible values: 1 (r), 2 (y), 4 (g), 8 (c), 16 (b), 32 (m), 63 (a), combined by addition)
• strength (of type float?, which defaults to null): set the filtering strength. (default: 1)
• rw (of type float?, which defaults to null): set the red weight. (default: 0.333)
• gw (of type float?, which defaults to null): set the green weight. (default: 0.334)
• bw (of type float?, which defaults to null): set the blue weight. (default: 0.333)
• lightness (of type bool?, which defaults to null): set the preserve lightness. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hwdownload

Ffmpeg filter: Download a hardware frame to a normal frame.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hwdownload.create

Ffmpeg filter: Download a hardware frame to a normal frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hwmap

Ffmpeg filter: Map hardware frames.

Type:

(?mode : int?, ?derive_device : string?, ?reverse : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): Frame mapping mode. (default: 3, possible values: 1 (read), 2 (write), 4 (overwrite), 8 (direct), combined by addition)
• derive_device (of type string?, which defaults to null): Derive a new device of this type
• reverse (of type int?, which defaults to null): Map in reverse (create and allocate in the sink). (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hwmap.create

Ffmpeg filter: Map hardware frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?derive_device : string?, ?reverse : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): Frame mapping mode. (default: 3, possible values: 1 (read), 2 (write), 4 (overwrite), 8 (direct), combined by addition)
• derive_device (of type string?, which defaults to null): Derive a new device of this type
• reverse (of type int?, which defaults to null): Map in reverse (create and allocate in the sink). (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hwupload

Ffmpeg filter: Upload a normal frame to a hardware frame.

Type:

(?derive_device : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• derive_device (of type string?, which defaults to null): Derive a new device of this type
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hwupload.create

Ffmpeg filter: Upload a normal frame to a hardware frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?derive_device : string?, ffmpeg.filter.graph) -> unit

Arguments:

• derive_device (of type string?, which defaults to null): Derive a new device of this type
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.hysteresis

Ffmpeg filter: Grow first stream into second stream by connecting components.

Type:

(?planes : int?, ?threshold : int?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• threshold (of type int?, which defaults to null): set threshold. (default: 0)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.hysteresis.create

Ffmpeg filter: Grow first stream into second stream by connecting components. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?threshold : int?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• threshold (of type int?, which defaults to null): set threshold. (default: 0)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.identity

Ffmpeg filter: Calculate the Identity between two video streams.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.identity.create

Ffmpeg filter: Calculate the Identity between two video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.idet

Ffmpeg filter: Interlace detect Filter.

Type:

(?intl_thres : float?, ?prog_thres : float?, ?rep_thres : float?,
 ?half_life : float?, ?analyze_interlaced_flag : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• intl_thres (of type float?, which defaults to null): set interlacing threshold. (default: 1.04)
• prog_thres (of type float?, which defaults to null): set progressive threshold. (default: 1.5)
• rep_thres (of type float?, which defaults to null): set repeat threshold. (default: 3)
• half_life (of type float?, which defaults to null): half life of cumulative statistics. (default: 0)
• analyze_interlaced_flag (of type int?, which defaults to null): set number of frames to use to determine if the interlace flag is accurate. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.idet.create

Ffmpeg filter: Interlace detect Filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?intl_thres : float?, ?prog_thres : float?, ?rep_thres : float?,
 ?half_life : float?, ?analyze_interlaced_flag : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• intl_thres (of type float?, which defaults to null): set interlacing threshold. (default: 1.04)
• prog_thres (of type float?, which defaults to null): set progressive threshold. (default: 1.5)
• rep_thres (of type float?, which defaults to null): set repeat threshold. (default: 3)
• half_life (of type float?, which defaults to null): half life of cumulative statistics. (default: 0)
• analyze_interlaced_flag (of type int?, which defaults to null): set number of frames to use to determine if the interlace flag is accurate. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.il

Ffmpeg filter: Deinterleave or interleave fields.

Type:

(?luma_mode : int?, ?l : int?, ?chroma_mode : int?, ?c : int?,
 ?alpha_mode : int?, ?a : int?, ?luma_swap : bool?, ?ls : bool?,
 ?chroma_swap : bool?, ?cs : bool?, ?alpha_swap : bool?, ?as : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• luma_mode (of type int?, which defaults to null): select luma mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• l (of type int?, which defaults to null): select luma mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• chroma_mode (of type int?, which defaults to null): select chroma mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• c (of type int?, which defaults to null): select chroma mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• alpha_mode (of type int?, which defaults to null): select alpha mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• a (of type int?, which defaults to null): select alpha mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• luma_swap (of type bool?, which defaults to null): swap luma fields. (default: false)
• ls (of type bool?, which defaults to null): swap luma fields. (default: false)
• chroma_swap (of type bool?, which defaults to null): swap chroma fields. (default: false)
• cs (of type bool?, which defaults to null): swap chroma fields. (default: false)
• alpha_swap (of type bool?, which defaults to null): swap alpha fields. (default: false)
• as (of type bool?, which defaults to null): swap alpha fields. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.il.create

Ffmpeg filter: Deinterleave or interleave fields. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?luma_mode : int?, ?l : int?, ?chroma_mode : int?, ?c : int?,
 ?alpha_mode : int?, ?a : int?, ?luma_swap : bool?, ?ls : bool?,
 ?chroma_swap : bool?, ?cs : bool?, ?alpha_swap : bool?, ?as : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• luma_mode (of type int?, which defaults to null): select luma mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• l (of type int?, which defaults to null): select luma mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• chroma_mode (of type int?, which defaults to null): select chroma mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• c (of type int?, which defaults to null): select chroma mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• alpha_mode (of type int?, which defaults to null): select alpha mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• a (of type int?, which defaults to null): select alpha mode. (default: 0, possible values: 0 (none), 1 (interleave), 1 (i), 2 (deinterleave), 2 (d))
• luma_swap (of type bool?, which defaults to null): swap luma fields. (default: false)
• ls (of type bool?, which defaults to null): swap luma fields. (default: false)
• chroma_swap (of type bool?, which defaults to null): swap chroma fields. (default: false)
• cs (of type bool?, which defaults to null): swap chroma fields. (default: false)
• alpha_swap (of type bool?, which defaults to null): swap alpha fields. (default: false)
• as (of type bool?, which defaults to null): swap alpha fields. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.inflate

Ffmpeg filter: Apply inflate effect.

Type:

(?threshold0 : int?, ?threshold1 : int?, ?threshold2 : int?,
 ?threshold3 : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• threshold0 (of type int?, which defaults to null): set threshold for 1st plane. (default: 65535)
• threshold1 (of type int?, which defaults to null): set threshold for 2nd plane. (default: 65535)
• threshold2 (of type int?, which defaults to null): set threshold for 3rd plane. (default: 65535)
• threshold3 (of type int?, which defaults to null): set threshold for 4th plane. (default: 65535)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.inflate.create

Ffmpeg filter: Apply inflate effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold0 : int?, ?threshold1 : int?, ?threshold2 : int?,
 ?threshold3 : int?, ffmpeg.filter.graph) -> unit

Arguments:

• threshold0 (of type int?, which defaults to null): set threshold for 1st plane. (default: 65535)
• threshold1 (of type int?, which defaults to null): set threshold for 2nd plane. (default: 65535)
• threshold2 (of type int?, which defaults to null): set threshold for 3rd plane. (default: 65535)
• threshold3 (of type int?, which defaults to null): set threshold for 4th plane. (default: 65535)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.interlace

Ffmpeg filter: Convert progressive video into interlaced.

Type:

(?scan : int?, ?lowpass : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• scan (of type int?, which defaults to null): scanning mode. (default: 0, possible values: 0 (tff), 1 (bff))
• lowpass (of type int?, which defaults to null): set vertical low-pass filter. (default: 1, possible values: 0 (off), 1 (linear), 2 (complex))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.interlace.create

Ffmpeg filter: Convert progressive video into interlaced. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?scan : int?, ?lowpass : int?, ffmpeg.filter.graph) -> unit

Arguments:

• scan (of type int?, which defaults to null): scanning mode. (default: 0, possible values: 0 (tff), 1 (bff))
• lowpass (of type int?, which defaults to null): set vertical low-pass filter. (default: 1, possible values: 0 (off), 1 (linear), 2 (complex))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.interleave

Ffmpeg filter: Temporally interleave video inputs. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?nb_inputs : int?, ?n : int?, ?duration : int?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• nb_inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• n (of type int?, which defaults to null): set number of inputs. (default: 2)
• duration (of type int?, which defaults to null): how to determine the end-of-stream. (default: 0, possible values: 0 (longest), 1 (shortest), 2 (first))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.interleave.create

Ffmpeg filter: Temporally interleave video inputs. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?nb_inputs : int?, ?n : int?, ?duration : int?, ffmpeg.filter.graph) -> unit

Arguments:

• nb_inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• n (of type int?, which defaults to null): set number of inputs. (default: 2)
• duration (of type int?, which defaults to null): how to determine the end-of-stream. (default: 0, possible values: 0 (longest), 1 (shortest), 2 (first))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.join

Ffmpeg filter: Join multiple audio streams into multi-channel output. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?channel_layout : string?, ?map : string?,
 ffmpeg.filter.graph, [ffmpeg.filter.audio], [ffmpeg.filter.video]) ->
ffmpeg.filter.audio

Arguments:

• inputs (of type int?, which defaults to null): Number of input streams.. (default: 2)
• channel_layout (of type string?, which defaults to null): Channel layout of the output stream.. (default: stereo)
• map (of type string?, which defaults to null): A comma-separated list of channels maps in the format 'input_stream.input_channel-output_channel.
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.join.create

Ffmpeg filter: Join multiple audio streams into multi-channel output. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?channel_layout : string?, ?map : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): Number of input streams.. (default: 2)
• channel_layout (of type string?, which defaults to null): Channel layout of the output stream.. (default: stereo)
• map (of type string?, which defaults to null): A comma-separated list of channels maps in the format 'input_stream.input_channel-output_channel.
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.kerndeint

Ffmpeg filter: Apply kernel deinterlacing to the input.

Type:

(?thresh : int?, ?map : bool?, ?order : bool?, ?sharp : bool?,
 ?twoway : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• thresh (of type int?, which defaults to null): set the threshold. (default: 10)
• map (of type bool?, which defaults to null): set the map. (default: false)
• order (of type bool?, which defaults to null): set the order. (default: false)
• sharp (of type bool?, which defaults to null): set sharpening. (default: false)
• twoway (of type bool?, which defaults to null): set twoway. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.kerndeint.create

Ffmpeg filter: Apply kernel deinterlacing to the input. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?thresh : int?, ?map : bool?, ?order : bool?, ?sharp : bool?,
 ?twoway : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• thresh (of type int?, which defaults to null): set the threshold. (default: 10)
• map (of type bool?, which defaults to null): set the map. (default: false)
• order (of type bool?, which defaults to null): set the order. (default: false)
• sharp (of type bool?, which defaults to null): set sharpening. (default: false)
• twoway (of type bool?, which defaults to null): set twoway. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.kirsch

Ffmpeg filter: Apply kirsch operator.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.kirsch.create

Ffmpeg filter: Apply kirsch operator. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lagfun

Ffmpeg filter: Slowly update darker pixels.

Type:

(?decay : float?, ?planes : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• decay (of type float?, which defaults to null): set decay. (default: 0.95)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lagfun.create

Ffmpeg filter: Slowly update darker pixels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?decay : float?, ?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• decay (of type float?, which defaults to null): set decay. (default: 0.95)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.latency

Ffmpeg filter: Report video filtering latency.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.latency.create

Ffmpeg filter: Report video filtering latency. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lenscorrection

Ffmpeg filter: Rectify the image by correcting for lens distortion.

Type:

(?cx : float?, ?cy : float?, ?k1 : float?, ?k2 : float?, ?i : int?,
 ?fc : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• cx (of type float?, which defaults to null): set relative center x. (default: 0.5)
• cy (of type float?, which defaults to null): set relative center y. (default: 0.5)
• k1 (of type float?, which defaults to null): set quadratic distortion factor. (default: 0)
• k2 (of type float?, which defaults to null): set double quadratic distortion factor. (default: 0)
• i (of type int?, which defaults to null): set interpolation type. (default: 0, possible values: 0 (nearest), 1 (bilinear))
• fc (of type string?, which defaults to null): set the color of the unmapped pixels. (default: black@0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lenscorrection.create

Ffmpeg filter: Rectify the image by correcting for lens distortion. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cx : float?, ?cy : float?, ?k1 : float?, ?k2 : float?, ?i : int?,
 ?fc : string?, ffmpeg.filter.graph) -> unit

Arguments:

• cx (of type float?, which defaults to null): set relative center x. (default: 0.5)
• cy (of type float?, which defaults to null): set relative center y. (default: 0.5)
• k1 (of type float?, which defaults to null): set quadratic distortion factor. (default: 0)
• k2 (of type float?, which defaults to null): set double quadratic distortion factor. (default: 0)
• i (of type int?, which defaults to null): set interpolation type. (default: 0, possible values: 0 (nearest), 1 (bilinear))
• fc (of type string?, which defaults to null): set the color of the unmapped pixels. (default: black@0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.life

Ffmpeg filter: Create life.

Type:

(?filename : string?, ?f : string?, ?size : string?, ?s : string?,
 ?rate : string?, ?r : string?, ?rule : string?, ?random_fill_ratio : float?,
 ?ratio : float?, ?random_seed : int?, ?seed : int?, ?stitch : bool?,
 ?mold : int?, ?life_color : string?, ?death_color : string?,
 ?mold_color : string?, ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• filename (of type string?, which defaults to null): set source file
• f (of type string?, which defaults to null): set source file
• size (of type string?, which defaults to null): set video size
• s (of type string?, which defaults to null): set video size
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• rule (of type string?, which defaults to null): set rule. (default: B3/S23)
• random_fill_ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.6180339887498948)
• ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.6180339887498948)
• random_seed (of type int?, which defaults to null): set the seed for filling the initial grid randomly. (default: -1)
• seed (of type int?, which defaults to null): set the seed for filling the initial grid randomly. (default: -1)
• stitch (of type bool?, which defaults to null): stitch boundaries. (default: true)
• mold (of type int?, which defaults to null): set mold speed for dead cells. (default: 0)
• life_color (of type string?, which defaults to null): set life color. (default: white)
• death_color (of type string?, which defaults to null): set death color. (default: black)
• mold_color (of type string?, which defaults to null): set mold color. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.life.create

Ffmpeg filter: Create life. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filename : string?, ?f : string?, ?size : string?, ?s : string?,
 ?rate : string?, ?r : string?, ?rule : string?, ?random_fill_ratio : float?,
 ?ratio : float?, ?random_seed : int?, ?seed : int?, ?stitch : bool?,
 ?mold : int?, ?life_color : string?, ?death_color : string?,
 ?mold_color : string?, ffmpeg.filter.graph) -> unit

Arguments:

• filename (of type string?, which defaults to null): set source file
• f (of type string?, which defaults to null): set source file
• size (of type string?, which defaults to null): set video size
• s (of type string?, which defaults to null): set video size
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• rule (of type string?, which defaults to null): set rule. (default: B3/S23)
• random_fill_ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.6180339887498948)
• ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.6180339887498948)
• random_seed (of type int?, which defaults to null): set the seed for filling the initial grid randomly. (default: -1)
• seed (of type int?, which defaults to null): set the seed for filling the initial grid randomly. (default: -1)
• stitch (of type bool?, which defaults to null): stitch boundaries. (default: true)
• mold (of type int?, which defaults to null): set mold speed for dead cells. (default: 0)
• life_color (of type string?, which defaults to null): set life color. (default: white)
• death_color (of type string?, which defaults to null): set death color. (default: black)
• mold_color (of type string?, which defaults to null): set mold color. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.limitdiff

Ffmpeg filter: Apply filtering with limiting difference. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?threshold : float?, ?elasticity : float?, ?reference : bool?,
 ?planes : int?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• threshold (of type float?, which defaults to null): set the threshold. (default: 0.003921568859368563)
• elasticity (of type float?, which defaults to null): set the elasticity. (default: 2)
• reference (of type bool?, which defaults to null): enable reference stream. (default: false)
• planes (of type int?, which defaults to null): set the planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.limitdiff.create

Ffmpeg filter: Apply filtering with limiting difference. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold : float?, ?elasticity : float?, ?reference : bool?,
 ?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• threshold (of type float?, which defaults to null): set the threshold. (default: 0.003921568859368563)
• elasticity (of type float?, which defaults to null): set the elasticity. (default: 2)
• reference (of type bool?, which defaults to null): enable reference stream. (default: false)
• planes (of type int?, which defaults to null): set the planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.limiter

Ffmpeg filter: Limit pixels components to the specified range.

Type:

(?min : int?, ?max : int?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• min (of type int?, which defaults to null): set min value. (default: 0)
• max (of type int?, which defaults to null): set max value. (default: 65535)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.limiter.create

Ffmpeg filter: Limit pixels components to the specified range. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?min : int?, ?max : int?, ?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• min (of type int?, which defaults to null): set min value. (default: 0)
• max (of type int?, which defaults to null): set max value. (default: 65535)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.loop

Ffmpeg filter: Loop video frames.

Type:

(?loop : int?, ?size : int?, ?start : int?, ?time : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• loop (of type int?, which defaults to null): number of loops. (default: 0)
• size (of type int?, which defaults to null): max number of frames to loop. (default: 0)
• start (of type int?, which defaults to null): set the loop start frame. (default: 0)
• time (of type int?, which defaults to null): set the loop start time. (default: 9223372036854.775)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.loop.create

Ffmpeg filter: Loop video frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?loop : int?, ?size : int?, ?start : int?, ?time : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• loop (of type int?, which defaults to null): number of loops. (default: 0)
• size (of type int?, which defaults to null): max number of frames to loop. (default: 0)
• start (of type int?, which defaults to null): set the loop start frame. (default: 0)
• time (of type int?, which defaults to null): set the loop start time. (default: 9223372036854.775)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.loudnorm

Ffmpeg filter: EBU R128 loudness normalization.

Type:

(?I : float?, ?i : float?, ?LRA : float?, ?lra : float?, ?TP : float?,
 ?tp : float?, ?measured_I : float?, ?measured_i : float?,
 ?measured_LRA : float?, ?measured_lra : float?, ?measured_TP : float?,
 ?measured_tp : float?, ?measured_thresh : float?, ?offset : float?,
 ?linear : bool?, ?dual_mono : bool?, ?print_format : int?,
 ?stats_file : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• I (of type float?, which defaults to null): set integrated loudness target. (default: -24)
• i (of type float?, which defaults to null): set integrated loudness target. (default: -24)
• LRA (of type float?, which defaults to null): set loudness range target. (default: 7)
• lra (of type float?, which defaults to null): set loudness range target. (default: 7)
• TP (of type float?, which defaults to null): set maximum true peak. (default: -2)
• tp (of type float?, which defaults to null): set maximum true peak. (default: -2)
• measured_I (of type float?, which defaults to null): measured IL of input file. (default: 0)
• measured_i (of type float?, which defaults to null): measured IL of input file. (default: 0)
• measured_LRA (of type float?, which defaults to null): measured LRA of input file. (default: 0)
• measured_lra (of type float?, which defaults to null): measured LRA of input file. (default: 0)
• measured_TP (of type float?, which defaults to null): measured true peak of input file. (default: 99)
• measured_tp (of type float?, which defaults to null): measured true peak of input file. (default: 99)
• measured_thresh (of type float?, which defaults to null): measured threshold of input file. (default: -70)
• offset (of type float?, which defaults to null): set offset gain. (default: 0)
• linear (of type bool?, which defaults to null): normalize linearly if possible. (default: true)
• dual_mono (of type bool?, which defaults to null): treat mono input as dual-mono. (default: false)
• print_format (of type int?, which defaults to null): set print format for stats. (default: 0, possible values: 0 (none), 1 (json), 2 (summary))
• stats_file (of type string?, which defaults to null): set stats output file
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.loudnorm.create

Ffmpeg filter: EBU R128 loudness normalization. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?I : float?, ?i : float?, ?LRA : float?, ?lra : float?, ?TP : float?,
 ?tp : float?, ?measured_I : float?, ?measured_i : float?,
 ?measured_LRA : float?, ?measured_lra : float?, ?measured_TP : float?,
 ?measured_tp : float?, ?measured_thresh : float?, ?offset : float?,
 ?linear : bool?, ?dual_mono : bool?, ?print_format : int?,
 ?stats_file : string?, ffmpeg.filter.graph) -> unit

Arguments:

• I (of type float?, which defaults to null): set integrated loudness target. (default: -24)
• i (of type float?, which defaults to null): set integrated loudness target. (default: -24)
• LRA (of type float?, which defaults to null): set loudness range target. (default: 7)
• lra (of type float?, which defaults to null): set loudness range target. (default: 7)
• TP (of type float?, which defaults to null): set maximum true peak. (default: -2)
• tp (of type float?, which defaults to null): set maximum true peak. (default: -2)
• measured_I (of type float?, which defaults to null): measured IL of input file. (default: 0)
• measured_i (of type float?, which defaults to null): measured IL of input file. (default: 0)
• measured_LRA (of type float?, which defaults to null): measured LRA of input file. (default: 0)
• measured_lra (of type float?, which defaults to null): measured LRA of input file. (default: 0)
• measured_TP (of type float?, which defaults to null): measured true peak of input file. (default: 99)
• measured_tp (of type float?, which defaults to null): measured true peak of input file. (default: 99)
• measured_thresh (of type float?, which defaults to null): measured threshold of input file. (default: -70)
• offset (of type float?, which defaults to null): set offset gain. (default: 0)
• linear (of type bool?, which defaults to null): normalize linearly if possible. (default: true)
• dual_mono (of type bool?, which defaults to null): treat mono input as dual-mono. (default: false)
• print_format (of type int?, which defaults to null): set print format for stats. (default: 0, possible values: 0 (none), 1 (json), 2 (summary))
• stats_file (of type string?, which defaults to null): set stats output file
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lowpass

Ffmpeg filter: Apply a low-pass filter with 3dB point frequency.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?poles : int?, ?p : int?, ?mix : float?,
 ?m : float?, ?channels : string?, ?c : string?, ?normalize : bool?,
 ?n : bool?, ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set frequency. (default: 500)
• f (of type float?, which defaults to null): set frequency. (default: 500)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.707)
• w (of type float?, which defaults to null): set width. (default: 0.707)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.lowpass.create

Ffmpeg filter: Apply a low-pass filter with 3dB point frequency. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?poles : int?, ?p : int?, ?mix : float?,
 ?m : float?, ?channels : string?, ?c : string?, ?normalize : bool?,
 ?n : bool?, ?transform : int?, ?a : int?, ?precision : int?, ?r : int?,
 ?blocksize : int?, ?b : int?, ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set frequency. (default: 500)
• f (of type float?, which defaults to null): set frequency. (default: 500)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.707)
• w (of type float?, which defaults to null): set width. (default: 0.707)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lowshelf

Ffmpeg filter: Apply a low shelf filter.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 100)
• f (of type float?, which defaults to null): set central frequency. (default: 100)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.lowshelf.create

Ffmpeg filter: Apply a low shelf filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 100)
• f (of type float?, which defaults to null): set central frequency. (default: 100)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lumakey

Ffmpeg filter: Turns a certain luma into transparency.

Type:

(?threshold : float?, ?tolerance : float?, ?softness : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• threshold (of type float?, which defaults to null): set the threshold value. (default: 0)
• tolerance (of type float?, which defaults to null): set the tolerance value. (default: 0.01)
• softness (of type float?, which defaults to null): set the softness value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lumakey.create

Ffmpeg filter: Turns a certain luma into transparency. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold : float?, ?tolerance : float?, ?softness : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• threshold (of type float?, which defaults to null): set the threshold value. (default: 0)
• tolerance (of type float?, which defaults to null): set the tolerance value. (default: 0.01)
• softness (of type float?, which defaults to null): set the softness value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lut

Ffmpeg filter: Compute and apply a lookup table to the RGB/YUV input video.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?y : string?,
 ?u : string?, ?v : string?, ?r : string?, ?g : string?, ?b : string?,
 ?a : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: clipval)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: clipval)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: clipval)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: clipval)
• y (of type string?, which defaults to null): set Y expression. (default: clipval)
• u (of type string?, which defaults to null): set U expression. (default: clipval)
• v (of type string?, which defaults to null): set V expression. (default: clipval)
• r (of type string?, which defaults to null): set R expression. (default: clipval)
• g (of type string?, which defaults to null): set G expression. (default: clipval)
• b (of type string?, which defaults to null): set B expression. (default: clipval)
• a (of type string?, which defaults to null): set A expression. (default: clipval)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lut.create

Ffmpeg filter: Compute and apply a lookup table to the RGB/YUV input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?y : string?,
 ?u : string?, ?v : string?, ?r : string?, ?g : string?, ?b : string?,
 ?a : string?, ffmpeg.filter.graph) -> unit

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: clipval)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: clipval)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: clipval)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: clipval)
• y (of type string?, which defaults to null): set Y expression. (default: clipval)
• u (of type string?, which defaults to null): set U expression. (default: clipval)
• v (of type string?, which defaults to null): set V expression. (default: clipval)
• r (of type string?, which defaults to null): set R expression. (default: clipval)
• g (of type string?, which defaults to null): set G expression. (default: clipval)
• b (of type string?, which defaults to null): set B expression. (default: clipval)
• a (of type string?, which defaults to null): set A expression. (default: clipval)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lut1d

Ffmpeg filter: Adjust colors using a 1D LUT.

Type:

(?file : string?, ?interp : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• file (of type string?, which defaults to null): set 1D LUT file name
• interp (of type int?, which defaults to null): select interpolation mode. (default: 1, possible values: 0 (nearest), 1 (linear), 3 (cosine), 2 (cubic), 4 (spline))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lut1d.create

Ffmpeg filter: Adjust colors using a 1D LUT. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?file : string?, ?interp : int?, ffmpeg.filter.graph) -> unit

Arguments:

• file (of type string?, which defaults to null): set 1D LUT file name
• interp (of type int?, which defaults to null): select interpolation mode. (default: 1, possible values: 0 (nearest), 1 (linear), 3 (cosine), 2 (cubic), 4 (spline))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lut2

Ffmpeg filter: Compute and apply a lookup table from two video inputs.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?d : int?,
 ?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: x)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: x)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: x)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: x)
• d (of type int?, which defaults to null): set output depth. (default: 0)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lut2.create

Ffmpeg filter: Compute and apply a lookup table from two video inputs. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?d : int?,
 ?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: x)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: x)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: x)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: x)
• d (of type int?, which defaults to null): set output depth. (default: 0)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lut3d

Ffmpeg filter: Adjust colors using a 3D LUT.

Type:

(?file : string?, ?clut : int?, ?interp : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• file (of type string?, which defaults to null): set 3D LUT file name
• clut (of type int?, which defaults to null): when to process CLUT. (default: 1, possible values: 0 (first), 1 (all))
• interp (of type int?, which defaults to null): select interpolation mode. (default: 2, possible values: 0 (nearest), 1 (trilinear), 2 (tetrahedral), 3 (pyramid), 4 (prism))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lut3d.create

Ffmpeg filter: Adjust colors using a 3D LUT. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?file : string?, ?clut : int?, ?interp : int?, ffmpeg.filter.graph) -> unit

Arguments:

• file (of type string?, which defaults to null): set 3D LUT file name
• clut (of type int?, which defaults to null): when to process CLUT. (default: 1, possible values: 0 (first), 1 (all))
• interp (of type int?, which defaults to null): select interpolation mode. (default: 2, possible values: 0 (nearest), 1 (trilinear), 2 (tetrahedral), 3 (pyramid), 4 (prism))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lutrgb

Ffmpeg filter: Compute and apply a lookup table to the RGB input video.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?y : string?,
 ?u : string?, ?v : string?, ?r : string?, ?g : string?, ?b : string?,
 ?a : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: clipval)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: clipval)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: clipval)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: clipval)
• y (of type string?, which defaults to null): set Y expression. (default: clipval)
• u (of type string?, which defaults to null): set U expression. (default: clipval)
• v (of type string?, which defaults to null): set V expression. (default: clipval)
• r (of type string?, which defaults to null): set R expression. (default: clipval)
• g (of type string?, which defaults to null): set G expression. (default: clipval)
• b (of type string?, which defaults to null): set B expression. (default: clipval)
• a (of type string?, which defaults to null): set A expression. (default: clipval)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lutrgb.create

Ffmpeg filter: Compute and apply a lookup table to the RGB input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?y : string?,
 ?u : string?, ?v : string?, ?r : string?, ?g : string?, ?b : string?,
 ?a : string?, ffmpeg.filter.graph) -> unit

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: clipval)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: clipval)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: clipval)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: clipval)
• y (of type string?, which defaults to null): set Y expression. (default: clipval)
• u (of type string?, which defaults to null): set U expression. (default: clipval)
• v (of type string?, which defaults to null): set V expression. (default: clipval)
• r (of type string?, which defaults to null): set R expression. (default: clipval)
• g (of type string?, which defaults to null): set G expression. (default: clipval)
• b (of type string?, which defaults to null): set B expression. (default: clipval)
• a (of type string?, which defaults to null): set A expression. (default: clipval)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.lutyuv

Ffmpeg filter: Compute and apply a lookup table to the YUV input video.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?y : string?,
 ?u : string?, ?v : string?, ?r : string?, ?g : string?, ?b : string?,
 ?a : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: clipval)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: clipval)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: clipval)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: clipval)
• y (of type string?, which defaults to null): set Y expression. (default: clipval)
• u (of type string?, which defaults to null): set U expression. (default: clipval)
• v (of type string?, which defaults to null): set V expression. (default: clipval)
• r (of type string?, which defaults to null): set R expression. (default: clipval)
• g (of type string?, which defaults to null): set G expression. (default: clipval)
• b (of type string?, which defaults to null): set B expression. (default: clipval)
• a (of type string?, which defaults to null): set A expression. (default: clipval)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.lutyuv.create

Ffmpeg filter: Compute and apply a lookup table to the YUV input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?y : string?,
 ?u : string?, ?v : string?, ?r : string?, ?g : string?, ?b : string?,
 ?a : string?, ffmpeg.filter.graph) -> unit

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: clipval)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: clipval)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: clipval)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: clipval)
• y (of type string?, which defaults to null): set Y expression. (default: clipval)
• u (of type string?, which defaults to null): set U expression. (default: clipval)
• v (of type string?, which defaults to null): set V expression. (default: clipval)
• r (of type string?, which defaults to null): set R expression. (default: clipval)
• g (of type string?, which defaults to null): set G expression. (default: clipval)
• b (of type string?, which defaults to null): set B expression. (default: clipval)
• a (of type string?, which defaults to null): set A expression. (default: clipval)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.mandelbrot

Ffmpeg filter: Render a Mandelbrot fractal.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?maxiter : int?, ?start_x : float?, ?start_y : float?,
 ?start_scale : float?, ?end_scale : float?, ?end_pts : float?,
 ?bailout : float?, ?morphxf : float?, ?morphyf : float?, ?morphamp : float?,
 ?outer : int?, ?inner : int?, ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set frame size. (default: 640x480)
• s (of type string?, which defaults to null): set frame size. (default: 640x480)
• rate (of type string?, which defaults to null): set frame rate. (default: 25)
• r (of type string?, which defaults to null): set frame rate. (default: 25)
• maxiter (of type int?, which defaults to null): set max iterations number. (default: 7189)
• start_x (of type float?, which defaults to null): set the initial x position. (default: -0.7436438870371587)
• start_y (of type float?, which defaults to null): set the initial y position. (default: -0.13182590420531198)
• start_scale (of type float?, which defaults to null): set the initial scale value. (default: 3)
• end_scale (of type float?, which defaults to null): set the terminal scale value. (default: 0.3)
• end_pts (of type float?, which defaults to null): set the terminal pts value. (default: 400)
• bailout (of type float?, which defaults to null): set the bailout value. (default: 10)
• morphxf (of type float?, which defaults to null): set morph x frequency. (default: 0.01)
• morphyf (of type float?, which defaults to null): set morph y frequency. (default: 0.0123)
• morphamp (of type float?, which defaults to null): set morph amplitude. (default: 0)
• outer (of type int?, which defaults to null): set outer coloring mode. (default: 1, possible values: 0 (iteration_count), 1 (normalized_iteration_count), 2 (white), 3 (outz))
• inner (of type int?, which defaults to null): set inner coloring mode. (default: 3, possible values: 0 (black), 1 (period), 2 (convergence), 3 (mincol))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.mandelbrot.create

Ffmpeg filter: Render a Mandelbrot fractal. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?maxiter : int?, ?start_x : float?, ?start_y : float?,
 ?start_scale : float?, ?end_scale : float?, ?end_pts : float?,
 ?bailout : float?, ?morphxf : float?, ?morphyf : float?, ?morphamp : float?,
 ?outer : int?, ?inner : int?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set frame size. (default: 640x480)
• s (of type string?, which defaults to null): set frame size. (default: 640x480)
• rate (of type string?, which defaults to null): set frame rate. (default: 25)
• r (of type string?, which defaults to null): set frame rate. (default: 25)
• maxiter (of type int?, which defaults to null): set max iterations number. (default: 7189)
• start_x (of type float?, which defaults to null): set the initial x position. (default: -0.7436438870371587)
• start_y (of type float?, which defaults to null): set the initial y position. (default: -0.13182590420531198)
• start_scale (of type float?, which defaults to null): set the initial scale value. (default: 3)
• end_scale (of type float?, which defaults to null): set the terminal scale value. (default: 0.3)
• end_pts (of type float?, which defaults to null): set the terminal pts value. (default: 400)
• bailout (of type float?, which defaults to null): set the bailout value. (default: 10)
• morphxf (of type float?, which defaults to null): set morph x frequency. (default: 0.01)
• morphyf (of type float?, which defaults to null): set morph y frequency. (default: 0.0123)
• morphamp (of type float?, which defaults to null): set morph amplitude. (default: 0)
• outer (of type int?, which defaults to null): set outer coloring mode. (default: 1, possible values: 0 (iteration_count), 1 (normalized_iteration_count), 2 (white), 3 (outz))
• inner (of type int?, which defaults to null): set inner coloring mode. (default: 3, possible values: 0 (black), 1 (period), 2 (convergence), 3 (mincol))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.maskedclamp

Ffmpeg filter: Clamp first stream with second stream and third stream.

Type:

(?undershoot : int?, ?overshoot : int?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• undershoot (of type int?, which defaults to null): set undershoot. (default: 0)
• overshoot (of type int?, which defaults to null): set overshoot. (default: 0)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.maskedclamp.create

Ffmpeg filter: Clamp first stream with second stream and third stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?undershoot : int?, ?overshoot : int?, ?planes : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• undershoot (of type int?, which defaults to null): set undershoot. (default: 0)
• overshoot (of type int?, which defaults to null): set overshoot. (default: 0)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.maskedmax

Ffmpeg filter: Apply filtering with maximum difference of two streams.

Type:

(?planes : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.maskedmax.create

Ffmpeg filter: Apply filtering with maximum difference of two streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.maskedmerge

Ffmpeg filter: Merge first stream with second stream using third stream as mask.

Type:

(?planes : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.maskedmerge.create

Ffmpeg filter: Merge first stream with second stream using third stream as mask. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.maskedmin

Ffmpeg filter: Apply filtering with minimum difference of two streams.

Type:

(?planes : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.maskedmin.create

Ffmpeg filter: Apply filtering with minimum difference of two streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.maskedthreshold

Ffmpeg filter: Pick pixels comparing absolute difference of two streams with threshold.

Type:

(?threshold : int?, ?planes : int?, ?mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• threshold (of type int?, which defaults to null): set threshold. (default: 1)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (abs), 1 (diff))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.maskedthreshold.create

Ffmpeg filter: Pick pixels comparing absolute difference of two streams with threshold. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold : int?, ?planes : int?, ?mode : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• threshold (of type int?, which defaults to null): set threshold. (default: 1)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (abs), 1 (diff))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.maskfun

Ffmpeg filter: Create Mask.

Type:

(?low : int?, ?high : int?, ?planes : int?, ?fill : int?, ?sum : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• low (of type int?, which defaults to null): set low threshold. (default: 10)
• high (of type int?, which defaults to null): set high threshold. (default: 10)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• fill (of type int?, which defaults to null): set fill value. (default: 0)
• sum (of type int?, which defaults to null): set sum value. (default: 10)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.maskfun.create

Ffmpeg filter: Create Mask. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?low : int?, ?high : int?, ?planes : int?, ?fill : int?, ?sum : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• low (of type int?, which defaults to null): set low threshold. (default: 10)
• high (of type int?, which defaults to null): set high threshold. (default: 10)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• fill (of type int?, which defaults to null): set fill value. (default: 0)
• sum (of type int?, which defaults to null): set sum value. (default: 10)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.mcdeint

Ffmpeg filter: Apply motion compensating deinterlacing.

Type:

(?mode : int?, ?parity : int?, ?qp : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (fast), 1 (medium), 2 (slow), 3 (extra_slow))
• parity (of type int?, which defaults to null): set the assumed picture field parity. (default: 1, possible values: 0 (tff), 1 (bff))
• qp (of type int?, which defaults to null): set qp. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.mcdeint.create

Ffmpeg filter: Apply motion compensating deinterlacing. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?parity : int?, ?qp : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (fast), 1 (medium), 2 (slow), 3 (extra_slow))
• parity (of type int?, which defaults to null): set the assumed picture field parity. (default: 1, possible values: 0 (tff), 1 (bff))
• qp (of type int?, which defaults to null): set qp. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.mcompand

Ffmpeg filter: Multiband Compress or expand audio dynamic range.

Type:

(?args : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• args (of type string?, which defaults to null): set parameters for each band. (default: 0.005,0.1 6 -47/-40,-34/-34,-17/-33 100 | 0.003,0.05 6 -47/-40,-34/-34,-17/-33 400 | 0.000625,0.0125 6 -47/-40,-34/-34,-15/-33 1600 | 0.0001,0.025 6 -47/-40,-34/-34,-31/-31,-0/-30 6400 | 0,0.025 6 -38/-31,-28/-28,-0/-25 22000)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.mcompand.create

Ffmpeg filter: Multiband Compress or expand audio dynamic range. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?args : string?, ffmpeg.filter.graph) -> unit

Arguments:

• args (of type string?, which defaults to null): set parameters for each band. (default: 0.005,0.1 6 -47/-40,-34/-34,-17/-33 100 | 0.003,0.05 6 -47/-40,-34/-34,-17/-33 400 | 0.000625,0.0125 6 -47/-40,-34/-34,-15/-33 1600 | 0.0001,0.025 6 -47/-40,-34/-34,-31/-31,-0/-30 6400 | 0,0.025 6 -38/-31,-28/-28,-0/-25 22000)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.median

Ffmpeg filter: Apply Median filter.

Type:

(?radius : int?, ?planes : int?, ?radiusV : int?, ?percentile : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• radius (of type int?, which defaults to null): set median radius. (default: 1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• radiusV (of type int?, which defaults to null): set median vertical radius. (default: 0)
• percentile (of type float?, which defaults to null): set median percentile. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.median.create

Ffmpeg filter: Apply Median filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?radius : int?, ?planes : int?, ?radiusV : int?, ?percentile : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• radius (of type int?, which defaults to null): set median radius. (default: 1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• radiusV (of type int?, which defaults to null): set median vertical radius. (default: 0)
• percentile (of type float?, which defaults to null): set median percentile. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.mergeplanes

Ffmpeg filter: Merge planes. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?mapping : int?, ?format : string?, ?map0s : int?, ?map0p : int?,
 ?map1s : int?, ?map1p : int?, ?map2s : int?, ?map2p : int?, ?map3s : int?,
 ?map3p : int?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• mapping (of type int?, which defaults to null): set input to output plane mapping. (default: -1)
• format (of type string?, which defaults to null): set output pixel format. (default: yuva444p)
• map0s (of type int?, which defaults to null): set 1st input to output stream mapping. (default: 0)
• map0p (of type int?, which defaults to null): set 1st input to output plane mapping. (default: 0)
• map1s (of type int?, which defaults to null): set 2nd input to output stream mapping. (default: 0)
• map1p (of type int?, which defaults to null): set 2nd input to output plane mapping. (default: 0)
• map2s (of type int?, which defaults to null): set 3rd input to output stream mapping. (default: 0)
• map2p (of type int?, which defaults to null): set 3rd input to output plane mapping. (default: 0)
• map3s (of type int?, which defaults to null): set 4th input to output stream mapping. (default: 0)
• map3p (of type int?, which defaults to null): set 4th input to output plane mapping. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.mergeplanes.create

Ffmpeg filter: Merge planes. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mapping : int?, ?format : string?, ?map0s : int?, ?map0p : int?,
 ?map1s : int?, ?map1p : int?, ?map2s : int?, ?map2p : int?, ?map3s : int?,
 ?map3p : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mapping (of type int?, which defaults to null): set input to output plane mapping. (default: -1)
• format (of type string?, which defaults to null): set output pixel format. (default: yuva444p)
• map0s (of type int?, which defaults to null): set 1st input to output stream mapping. (default: 0)
• map0p (of type int?, which defaults to null): set 1st input to output plane mapping. (default: 0)
• map1s (of type int?, which defaults to null): set 2nd input to output stream mapping. (default: 0)
• map1p (of type int?, which defaults to null): set 2nd input to output plane mapping. (default: 0)
• map2s (of type int?, which defaults to null): set 3rd input to output stream mapping. (default: 0)
• map2p (of type int?, which defaults to null): set 3rd input to output plane mapping. (default: 0)
• map3s (of type int?, which defaults to null): set 4th input to output stream mapping. (default: 0)
• map3p (of type int?, which defaults to null): set 4th input to output plane mapping. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.mestimate

Ffmpeg filter: Generate motion vectors.

Type:

(?method : int?, ?mb_size : int?, ?search_param : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• method (of type int?, which defaults to null): motion estimation method. (default: 1, possible values: 1 (esa), 2 (tss), 3 (tdls), 4 (ntss), 5 (fss), 6 (ds), 7 (hexbs), 8 (epzs), 9 (umh))
• mb_size (of type int?, which defaults to null): macroblock size. (default: 16)
• search_param (of type int?, which defaults to null): search parameter. (default: 7)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.mestimate.create

Ffmpeg filter: Generate motion vectors. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?method : int?, ?mb_size : int?, ?search_param : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• method (of type int?, which defaults to null): motion estimation method. (default: 1, possible values: 1 (esa), 2 (tss), 3 (tdls), 4 (ntss), 5 (fss), 6 (ds), 7 (hexbs), 8 (epzs), 9 (umh))
• mb_size (of type int?, which defaults to null): macroblock size. (default: 16)
• search_param (of type int?, which defaults to null): search parameter. (default: 7)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.metadata

Ffmpeg filter: Manipulate video frame metadata.

Type:

(?mode : int?, ?key : string?, ?value : string?, ?function : int?,
 ?expr : string?, ?file : string?, ?direct : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set a mode of operation. (default: 0, possible values: 0 (select), 1 (add), 2 (modify), 3 (delete), 4 (print))
• key (of type string?, which defaults to null): set metadata key
• value (of type string?, which defaults to null): set metadata value
• function (of type int?, which defaults to null): function for comparing values. (default: 0, possible values: 0 (same_str), 1 (starts_with), 2 (less), 3 (equal), 4 (greater), 5 (expr), 6 (ends_with))
• expr (of type string?, which defaults to null): set expression for expr function
• file (of type string?, which defaults to null): set file where to print metadata information
• direct (of type bool?, which defaults to null): reduce buffering when printing to user-set file or pipe. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.metadata.create

Ffmpeg filter: Manipulate video frame metadata. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?key : string?, ?value : string?, ?function : int?,
 ?expr : string?, ?file : string?, ?direct : bool?, ffmpeg.filter.graph) ->
unit

Arguments:

• mode (of type int?, which defaults to null): set a mode of operation. (default: 0, possible values: 0 (select), 1 (add), 2 (modify), 3 (delete), 4 (print))
• key (of type string?, which defaults to null): set metadata key
• value (of type string?, which defaults to null): set metadata value
• function (of type int?, which defaults to null): function for comparing values. (default: 0, possible values: 0 (same_str), 1 (starts_with), 2 (less), 3 (equal), 4 (greater), 5 (expr), 6 (ends_with))
• expr (of type string?, which defaults to null): set expression for expr function
• file (of type string?, which defaults to null): set file where to print metadata information
• direct (of type bool?, which defaults to null): reduce buffering when printing to user-set file or pipe. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.midequalizer

Ffmpeg filter: Apply Midway Equalization.

Type:

(?planes : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.midequalizer.create

Ffmpeg filter: Apply Midway Equalization. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.minterpolate

Ffmpeg filter: Frame rate conversion using Motion Interpolation.

Type:

(?fps : string?, ?mi_mode : int?, ?mc_mode : int?, ?me_mode : int?,
 ?me : int?, ?mb_size : int?, ?search_param : int?, ?vsbmc : int?,
 ?scd : int?, ?scd_threshold : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• fps (of type string?, which defaults to null): output's frame rate. (default: 60)
• mi_mode (of type int?, which defaults to null): motion interpolation mode. (default: 2, possible values: 0 (dup), 1 (blend), 2 (mci))
• mc_mode (of type int?, which defaults to null): motion compensation mode. (default: 0, possible values: 0 (obmc), 1 (aobmc))
• me_mode (of type int?, which defaults to null): motion estimation mode. (default: 1, possible values: 0 (bidir), 1 (bilat))
• me (of type int?, which defaults to null): motion estimation method. (default: 8, possible values: 1 (esa), 2 (tss), 3 (tdls), 4 (ntss), 5 (fss), 6 (ds), 7 (hexbs), 8 (epzs), 9 (umh))
• mb_size (of type int?, which defaults to null): macroblock size. (default: 16)
• search_param (of type int?, which defaults to null): search parameter. (default: 32)
• vsbmc (of type int?, which defaults to null): variable-size block motion compensation. (default: 0)
• scd (of type int?, which defaults to null): scene change detection method. (default: 1, possible values: 0 (none), 1 (fdiff))
• scd_threshold (of type float?, which defaults to null): scene change threshold. (default: 10)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.minterpolate.create

Ffmpeg filter: Frame rate conversion using Motion Interpolation. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?fps : string?, ?mi_mode : int?, ?mc_mode : int?, ?me_mode : int?,
 ?me : int?, ?mb_size : int?, ?search_param : int?, ?vsbmc : int?,
 ?scd : int?, ?scd_threshold : float?, ffmpeg.filter.graph) -> unit

Arguments:

• fps (of type string?, which defaults to null): output's frame rate. (default: 60)
• mi_mode (of type int?, which defaults to null): motion interpolation mode. (default: 2, possible values: 0 (dup), 1 (blend), 2 (mci))
• mc_mode (of type int?, which defaults to null): motion compensation mode. (default: 0, possible values: 0 (obmc), 1 (aobmc))
• me_mode (of type int?, which defaults to null): motion estimation mode. (default: 1, possible values: 0 (bidir), 1 (bilat))
• me (of type int?, which defaults to null): motion estimation method. (default: 8, possible values: 1 (esa), 2 (tss), 3 (tdls), 4 (ntss), 5 (fss), 6 (ds), 7 (hexbs), 8 (epzs), 9 (umh))
• mb_size (of type int?, which defaults to null): macroblock size. (default: 16)
• search_param (of type int?, which defaults to null): search parameter. (default: 32)
• vsbmc (of type int?, which defaults to null): variable-size block motion compensation. (default: 0)
• scd (of type int?, which defaults to null): scene change detection method. (default: 1, possible values: 0 (none), 1 (fdiff))
• scd_threshold (of type float?, which defaults to null): scene change threshold. (default: 10)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.mix

Ffmpeg filter: Mix video inputs. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?weights : string?, ?scale : float?, ?planes : int?,
 ?duration : int?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• weights (of type string?, which defaults to null): set weight for each input. (default: 1 1)
• scale (of type float?, which defaults to null): set scale. (default: 0)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 15)
• duration (of type int?, which defaults to null): how to determine end of stream. (default: 0, possible values: 0 (longest), 1 (shortest), 2 (first))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.mix.create

Ffmpeg filter: Mix video inputs. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?weights : string?, ?scale : float?, ?planes : int?,
 ?duration : int?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• weights (of type string?, which defaults to null): set weight for each input. (default: 1 1)
• scale (of type float?, which defaults to null): set scale. (default: 0)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 15)
• duration (of type int?, which defaults to null): how to determine end of stream. (default: 0, possible values: 0 (longest), 1 (shortest), 2 (first))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.monochrome

Ffmpeg filter: Convert video to gray using custom color filter.

Type:

(?cb : float?, ?cr : float?, ?size : float?, ?high : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• cb (of type float?, which defaults to null): set the chroma blue spot. (default: 0)
• cr (of type float?, which defaults to null): set the chroma red spot. (default: 0)
• size (of type float?, which defaults to null): set the color filter size. (default: 1)
• high (of type float?, which defaults to null): set the highlights strength. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.monochrome.create

Ffmpeg filter: Convert video to gray using custom color filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cb : float?, ?cr : float?, ?size : float?, ?high : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• cb (of type float?, which defaults to null): set the chroma blue spot. (default: 0)
• cr (of type float?, which defaults to null): set the chroma red spot. (default: 0)
• size (of type float?, which defaults to null): set the color filter size. (default: 1)
• high (of type float?, which defaults to null): set the highlights strength. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.morpho

Ffmpeg filter: Apply Morphological filter.

Type:

(?mode : int?, ?planes : int?, ?structure : int?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set morphological transform. (default: 0, possible values: 0 (erode), 1 (dilate), 2 (open), 3 (close), 4 (gradient), 5 (tophat), 6 (blackhat))
• planes (of type int?, which defaults to null): set planes to filter. (default: 7)
• structure (of type int?, which defaults to null): when to process structures. (default: 1, possible values: 0 (first), 1 (all))
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.morpho.create

Ffmpeg filter: Apply Morphological filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?planes : int?, ?structure : int?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set morphological transform. (default: 0, possible values: 0 (erode), 1 (dilate), 2 (open), 3 (close), 4 (gradient), 5 (tophat), 6 (blackhat))
• planes (of type int?, which defaults to null): set planes to filter. (default: 7)
• structure (of type int?, which defaults to null): when to process structures. (default: 1, possible values: 0 (first), 1 (all))
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.movie

Ffmpeg filter: Read from a movie source. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?filename : string?, ?format_name : string?, ?f : string?,
 ?stream_index : int?, ?si : int?, ?seek_point : float?, ?sp : float?,
 ?streams : string?, ?s : string?, ?loop : int?, ?discontinuity : int?,
 ?dec_threads : int?, ?format_opts : string?, ffmpeg.filter.graph) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• filename (of type string?, which defaults to null)
• format_name (of type string?, which defaults to null): set format name
• f (of type string?, which defaults to null): set format name
• stream_index (of type int?, which defaults to null): set stream index. (default: -1)
• si (of type int?, which defaults to null): set stream index. (default: -1)
• seek_point (of type float?, which defaults to null): set seekpoint (seconds). (default: 0)
• sp (of type float?, which defaults to null): set seekpoint (seconds). (default: 0)
• streams (of type string?, which defaults to null): set streams
• s (of type string?, which defaults to null): set streams
• loop (of type int?, which defaults to null): set loop count. (default: 1)
• discontinuity (of type int?, which defaults to null): set discontinuity threshold. (default: 0)
• dec_threads (of type int?, which defaults to null): set the number of threads for decoding. (default: 0)
• format_opts (of type string?, which defaults to null): set format options for the opened file
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.movie.create

Ffmpeg filter: Read from a movie source. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filename : string?, ?format_name : string?, ?f : string?,
 ?stream_index : int?, ?si : int?, ?seek_point : float?, ?sp : float?,
 ?streams : string?, ?s : string?, ?loop : int?, ?discontinuity : int?,
 ?dec_threads : int?, ?format_opts : string?, ffmpeg.filter.graph) -> unit

Arguments:

• filename (of type string?, which defaults to null)
• format_name (of type string?, which defaults to null): set format name
• f (of type string?, which defaults to null): set format name
• stream_index (of type int?, which defaults to null): set stream index. (default: -1)
• si (of type int?, which defaults to null): set stream index. (default: -1)
• seek_point (of type float?, which defaults to null): set seekpoint (seconds). (default: 0)
• sp (of type float?, which defaults to null): set seekpoint (seconds). (default: 0)
• streams (of type string?, which defaults to null): set streams
• s (of type string?, which defaults to null): set streams
• loop (of type int?, which defaults to null): set loop count. (default: 1)
• discontinuity (of type int?, which defaults to null): set discontinuity threshold. (default: 0)
• dec_threads (of type int?, which defaults to null): set the number of threads for decoding. (default: 0)
• format_opts (of type string?, which defaults to null): set format options for the opened file
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.mpdecimate

Ffmpeg filter: Remove near-duplicate frames.

Type:

(?max : int?, ?keep : int?, ?hi : int?, ?lo : int?, ?frac : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• max (of type int?, which defaults to null): set the maximum number of consecutive dropped frames (positive), or the minimum interval between dropped frames (negative). (default: 0)
• keep (of type int?, which defaults to null): set the number of similar consecutive frames to be kept before starting to drop similar frames. (default: 0)
• hi (of type int?, which defaults to null): set high dropping threshold. (default: 768)
• lo (of type int?, which defaults to null): set low dropping threshold. (default: 320)
• frac (of type float?, which defaults to null): set fraction dropping threshold. (default: 0.33)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.mpdecimate.create

Ffmpeg filter: Remove near-duplicate frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?max : int?, ?keep : int?, ?hi : int?, ?lo : int?, ?frac : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• max (of type int?, which defaults to null): set the maximum number of consecutive dropped frames (positive), or the minimum interval between dropped frames (negative). (default: 0)
• keep (of type int?, which defaults to null): set the number of similar consecutive frames to be kept before starting to drop similar frames. (default: 0)
• hi (of type int?, which defaults to null): set high dropping threshold. (default: 768)
• lo (of type int?, which defaults to null): set low dropping threshold. (default: 320)
• frac (of type float?, which defaults to null): set fraction dropping threshold. (default: 0.33)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.mptestsrc

Ffmpeg filter: Generate various test pattern.

Type:

(?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?test : int?,
 ?t : int?, ?max_frames : int?, ?m : int?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• test (of type int?, which defaults to null): set test to perform. (default: 10, possible values: 0 (dc_luma), 1 (dc_chroma), 2 (freq_luma), 3 (freq_chroma), 4 (amp_luma), 5 (amp_chroma), 6 (cbp), 7 (mv), 8 (ring1), 9 (ring2), 10 (all))
• t (of type int?, which defaults to null): set test to perform. (default: 10, possible values: 0 (dc_luma), 1 (dc_chroma), 2 (freq_luma), 3 (freq_chroma), 4 (amp_luma), 5 (amp_chroma), 6 (cbp), 7 (mv), 8 (ring1), 9 (ring2), 10 (all))
• max_frames (of type int?, which defaults to null): Set the maximum number of frames generated for each test. (default: 30)
• m (of type int?, which defaults to null): Set the maximum number of frames generated for each test. (default: 30)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.mptestsrc.create

Ffmpeg filter: Generate various test pattern. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rate : string?, ?r : string?, ?duration : int?, ?d : int?, ?test : int?,
 ?t : int?, ?max_frames : int?, ?m : int?, ffmpeg.filter.graph) -> unit

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• test (of type int?, which defaults to null): set test to perform. (default: 10, possible values: 0 (dc_luma), 1 (dc_chroma), 2 (freq_luma), 3 (freq_chroma), 4 (amp_luma), 5 (amp_chroma), 6 (cbp), 7 (mv), 8 (ring1), 9 (ring2), 10 (all))
• t (of type int?, which defaults to null): set test to perform. (default: 10, possible values: 0 (dc_luma), 1 (dc_chroma), 2 (freq_luma), 3 (freq_chroma), 4 (amp_luma), 5 (amp_chroma), 6 (cbp), 7 (mv), 8 (ring1), 9 (ring2), 10 (all))
• max_frames (of type int?, which defaults to null): Set the maximum number of frames generated for each test. (default: 30)
• m (of type int?, which defaults to null): Set the maximum number of frames generated for each test. (default: 30)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.msad

Ffmpeg filter: Calculate the MSAD between two video streams.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.msad.create

Ffmpeg filter: Calculate the MSAD between two video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.multiply

Ffmpeg filter: Multiply first video stream with second video stream.

Type:

(?scale : float?, ?offset : float?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• scale (of type float?, which defaults to null): set scale. (default: 1)
• offset (of type float?, which defaults to null): set offset. (default: 0.5)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.multiply.create

Ffmpeg filter: Multiply first video stream with second video stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?scale : float?, ?offset : float?, ?planes : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• scale (of type float?, which defaults to null): set scale. (default: 1)
• offset (of type float?, which defaults to null): set offset. (default: 0.5)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.negate

Ffmpeg filter: Negate input video.

Type:

(?components : int?, ?negate_alpha : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• components (of type int?, which defaults to null): set components to negate. (default: 119, possible values: 16 (y), 32 (u), 64 (v), 1 (r), 2 (g), 4 (b), 8 (a), combined by addition)
• negate_alpha (of type bool?, which defaults to null): Default: false
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.negate.create

Ffmpeg filter: Negate input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?components : int?, ?negate_alpha : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• components (of type int?, which defaults to null): set components to negate. (default: 119, possible values: 16 (y), 32 (u), 64 (v), 1 (r), 2 (g), 4 (b), 8 (a), combined by addition)
• negate_alpha (of type bool?, which defaults to null): Default: false
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.nlmeans

Ffmpeg filter: Non-local means denoiser.

Type:

(?s : float?, ?p : int?, ?pc : int?, ?r : int?, ?rc : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• s (of type float?, which defaults to null): denoising strength. (default: 1)
• p (of type int?, which defaults to null): patch size. (default: 7)
• pc (of type int?, which defaults to null): patch size for chroma planes. (default: 0)
• r (of type int?, which defaults to null): research window. (default: 15)
• rc (of type int?, which defaults to null): research window for chroma planes. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.nlmeans.create

Ffmpeg filter: Non-local means denoiser. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?s : float?, ?p : int?, ?pc : int?, ?r : int?, ?rc : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• s (of type float?, which defaults to null): denoising strength. (default: 1)
• p (of type int?, which defaults to null): patch size. (default: 7)
• pc (of type int?, which defaults to null): patch size for chroma planes. (default: 0)
• r (of type int?, which defaults to null): research window. (default: 15)
• rc (of type int?, which defaults to null): research window for chroma planes. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.nnedi

Ffmpeg filter: Apply neural network edge directed interpolation intra-only deinterlacer.

Type:

(?weights : string?, ?deint : int?, ?field : int?, ?planes : int?,
 ?nsize : int?, ?nns : int?, ?qual : int?, ?etype : int?, ?pscrn : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• weights (of type string?, which defaults to null): set weights file. (default: nnedi3_weights.bin)
• deint (of type int?, which defaults to null): set which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• field (of type int?, which defaults to null): set mode of operation. (default: -1, possible values: -2 (af), -1 (a), 0 (t), 1 (b), 2 (tf), 3 (bf))
• planes (of type int?, which defaults to null): set which planes to process. (default: 7)
• nsize (of type int?, which defaults to null): set size of local neighborhood around each pixel, used by the predictor neural network. (default: 6, possible values: 0 (s8x6), 1 (s16x6), 2 (s32x6), 3 (s48x6), 4 (s8x4), 5 (s16x4), 6 (s32x4))
• nns (of type int?, which defaults to null): set number of neurons in predictor neural network. (default: 1, possible values: 0 (n16), 1 (n32), 2 (n64), 3 (n128), 4 (n256))
• qual (of type int?, which defaults to null): set quality. (default: 1, possible values: 1 (fast), 2 (slow))
• etype (of type int?, which defaults to null): set which set of weights to use in the predictor. (default: 0, possible values: 0 (a), 0 (abs), 1 (s), 1 (mse))
• pscrn (of type int?, which defaults to null): set prescreening. (default: 2, possible values: 0 (none), 1 (original), 2 (new), 3 (new2), 4 (new3))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.nnedi.create

Ffmpeg filter: Apply neural network edge directed interpolation intra-only deinterlacer. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?weights : string?, ?deint : int?, ?field : int?, ?planes : int?,
 ?nsize : int?, ?nns : int?, ?qual : int?, ?etype : int?, ?pscrn : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• weights (of type string?, which defaults to null): set weights file. (default: nnedi3_weights.bin)
• deint (of type int?, which defaults to null): set which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• field (of type int?, which defaults to null): set mode of operation. (default: -1, possible values: -2 (af), -1 (a), 0 (t), 1 (b), 2 (tf), 3 (bf))
• planes (of type int?, which defaults to null): set which planes to process. (default: 7)
• nsize (of type int?, which defaults to null): set size of local neighborhood around each pixel, used by the predictor neural network. (default: 6, possible values: 0 (s8x6), 1 (s16x6), 2 (s32x6), 3 (s48x6), 4 (s8x4), 5 (s16x4), 6 (s32x4))
• nns (of type int?, which defaults to null): set number of neurons in predictor neural network. (default: 1, possible values: 0 (n16), 1 (n32), 2 (n64), 3 (n128), 4 (n256))
• qual (of type int?, which defaults to null): set quality. (default: 1, possible values: 1 (fast), 2 (slow))
• etype (of type int?, which defaults to null): set which set of weights to use in the predictor. (default: 0, possible values: 0 (a), 0 (abs), 1 (s), 1 (mse))
• pscrn (of type int?, which defaults to null): set prescreening. (default: 2, possible values: 0 (none), 1 (original), 2 (new), 3 (new2), 4 (new3))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.noformat

Ffmpeg filter: Force libavfilter not to use any of the specified pixel formats for the input to the next filter.

Type:

(?pix_fmts : string?, ?color_spaces : string?, ?color_ranges : string?,
 ?alpha_modes : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• pix_fmts (of type string?, which defaults to null): A '|'-separated list of pixel formats
• color_spaces (of type string?, which defaults to null): A '|'-separated list of color spaces
• color_ranges (of type string?, which defaults to null): A '|'-separated list of color ranges
• alpha_modes (of type string?, which defaults to null): A '|'-separated list of alpha modes
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.noformat.create

Ffmpeg filter: Force libavfilter not to use any of the specified pixel formats for the input to the next filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?pix_fmts : string?, ?color_spaces : string?, ?color_ranges : string?,
 ?alpha_modes : string?, ffmpeg.filter.graph) -> unit

Arguments:

• pix_fmts (of type string?, which defaults to null): A '|'-separated list of pixel formats
• color_spaces (of type string?, which defaults to null): A '|'-separated list of color spaces
• color_ranges (of type string?, which defaults to null): A '|'-separated list of color ranges
• alpha_modes (of type string?, which defaults to null): A '|'-separated list of alpha modes
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.noise

Ffmpeg filter: Add noise.

Type:

(?all_seed : int?, ?all_strength : int?, ?alls : int?, ?all_flags : int?,
 ?allf : int?, ?c0_seed : int?, ?c0_strength : int?, ?c0s : int?,
 ?c0_flags : int?, ?c0f : int?, ?c1_seed : int?, ?c1_strength : int?,
 ?c1s : int?, ?c1_flags : int?, ?c1f : int?, ?c2_seed : int?,
 ?c2_strength : int?, ?c2s : int?, ?c2_flags : int?, ?c2f : int?,
 ?c3_seed : int?, ?c3_strength : int?, ?c3s : int?, ?c3_flags : int?,
 ?c3f : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• all_seed (of type int?, which defaults to null): set component #0 noise seed. (default: -1)
• all_strength (of type int?, which defaults to null): set component #0 strength. (default: 0)
• alls (of type int?, which defaults to null): set component #0 strength. (default: 0)
• all_flags (of type int?, which defaults to null): set component #0 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• allf (of type int?, which defaults to null): set component #0 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c0_seed (of type int?, which defaults to null): set component #0 noise seed. (default: -1)
• c0_strength (of type int?, which defaults to null): set component #0 strength. (default: 0)
• c0s (of type int?, which defaults to null): set component #0 strength. (default: 0)
• c0_flags (of type int?, which defaults to null): set component #0 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c0f (of type int?, which defaults to null): set component #0 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c1_seed (of type int?, which defaults to null): set component #1 noise seed. (default: -1)
• c1_strength (of type int?, which defaults to null): set component #1 strength. (default: 0)
• c1s (of type int?, which defaults to null): set component #1 strength. (default: 0)
• c1_flags (of type int?, which defaults to null): set component #1 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c1f (of type int?, which defaults to null): set component #1 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c2_seed (of type int?, which defaults to null): set component #2 noise seed. (default: -1)
• c2_strength (of type int?, which defaults to null): set component #2 strength. (default: 0)
• c2s (of type int?, which defaults to null): set component #2 strength. (default: 0)
• c2_flags (of type int?, which defaults to null): set component #2 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c2f (of type int?, which defaults to null): set component #2 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c3_seed (of type int?, which defaults to null): set component #3 noise seed. (default: -1)
• c3_strength (of type int?, which defaults to null): set component #3 strength. (default: 0)
• c3s (of type int?, which defaults to null): set component #3 strength. (default: 0)
• c3_flags (of type int?, which defaults to null): set component #3 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c3f (of type int?, which defaults to null): set component #3 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.noise.create

Ffmpeg filter: Add noise. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?all_seed : int?, ?all_strength : int?, ?alls : int?, ?all_flags : int?,
 ?allf : int?, ?c0_seed : int?, ?c0_strength : int?, ?c0s : int?,
 ?c0_flags : int?, ?c0f : int?, ?c1_seed : int?, ?c1_strength : int?,
 ?c1s : int?, ?c1_flags : int?, ?c1f : int?, ?c2_seed : int?,
 ?c2_strength : int?, ?c2s : int?, ?c2_flags : int?, ?c2f : int?,
 ?c3_seed : int?, ?c3_strength : int?, ?c3s : int?, ?c3_flags : int?,
 ?c3f : int?, ffmpeg.filter.graph) -> unit

Arguments:

• all_seed (of type int?, which defaults to null): set component #0 noise seed. (default: -1)
• all_strength (of type int?, which defaults to null): set component #0 strength. (default: 0)
• alls (of type int?, which defaults to null): set component #0 strength. (default: 0)
• all_flags (of type int?, which defaults to null): set component #0 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• allf (of type int?, which defaults to null): set component #0 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c0_seed (of type int?, which defaults to null): set component #0 noise seed. (default: -1)
• c0_strength (of type int?, which defaults to null): set component #0 strength. (default: 0)
• c0s (of type int?, which defaults to null): set component #0 strength. (default: 0)
• c0_flags (of type int?, which defaults to null): set component #0 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c0f (of type int?, which defaults to null): set component #0 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c1_seed (of type int?, which defaults to null): set component #1 noise seed. (default: -1)
• c1_strength (of type int?, which defaults to null): set component #1 strength. (default: 0)
• c1s (of type int?, which defaults to null): set component #1 strength. (default: 0)
• c1_flags (of type int?, which defaults to null): set component #1 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c1f (of type int?, which defaults to null): set component #1 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c2_seed (of type int?, which defaults to null): set component #2 noise seed. (default: -1)
• c2_strength (of type int?, which defaults to null): set component #2 strength. (default: 0)
• c2s (of type int?, which defaults to null): set component #2 strength. (default: 0)
• c2_flags (of type int?, which defaults to null): set component #2 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c2f (of type int?, which defaults to null): set component #2 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c3_seed (of type int?, which defaults to null): set component #3 noise seed. (default: -1)
• c3_strength (of type int?, which defaults to null): set component #3 strength. (default: 0)
• c3s (of type int?, which defaults to null): set component #3 strength. (default: 0)
• c3_flags (of type int?, which defaults to null): set component #3 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• c3f (of type int?, which defaults to null): set component #3 flags. (default: 0, possible values: 8 (a), 16 (p), 2 (t), 1 (u), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.normalize

Ffmpeg filter: Normalize RGB video.

Type:

(?blackpt : string?, ?whitept : string?, ?smoothing : int?,
 ?independence : float?, ?strength : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• blackpt (of type string?, which defaults to null): output color to which darkest input color is mapped. (default: black)
• whitept (of type string?, which defaults to null): output color to which brightest input color is mapped. (default: white)
• smoothing (of type int?, which defaults to null): amount of temporal smoothing of the input range, to reduce flicker. (default: 0)
• independence (of type float?, which defaults to null): proportion of independent to linked channel normalization. (default: 1)
• strength (of type float?, which defaults to null): strength of filter, from no effect to full normalization. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.normalize.create

Ffmpeg filter: Normalize RGB video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?blackpt : string?, ?whitept : string?, ?smoothing : int?,
 ?independence : float?, ?strength : float?, ffmpeg.filter.graph) -> unit

Arguments:

• blackpt (of type string?, which defaults to null): output color to which darkest input color is mapped. (default: black)
• whitept (of type string?, which defaults to null): output color to which brightest input color is mapped. (default: white)
• smoothing (of type int?, which defaults to null): amount of temporal smoothing of the input range, to reduce flicker. (default: 0)
• independence (of type float?, which defaults to null): proportion of independent to linked channel normalization. (default: 1)
• strength (of type float?, which defaults to null): strength of filter, from no effect to full normalization. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.null

Ffmpeg filter: Pass the source unchanged to the output.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.null.create

Ffmpeg filter: Pass the source unchanged to the output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.nullsink

Ffmpeg filter: Do absolutely nothing with the input video.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.nullsink.create

Ffmpeg filter: Do absolutely nothing with the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type unit): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.nullsrc

Ffmpeg filter: Null video source, return unprocessed video frames.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.nullsrc.create

Ffmpeg filter: Null video source, return unprocessed video frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.oscilloscope

Ffmpeg filter: 2D Video Oscilloscope.

Type:

(?x : float?, ?y : float?, ?s : float?, ?t : float?, ?o : float?,
 ?tx : float?, ?ty : float?, ?tw : float?, ?th : float?, ?c : int?,
 ?g : bool?, ?st : bool?, ?sc : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• x (of type float?, which defaults to null): set scope x position. (default: 0.5)
• y (of type float?, which defaults to null): set scope y position. (default: 0.5)
• s (of type float?, which defaults to null): set scope size. (default: 0.8)
• t (of type float?, which defaults to null): set scope tilt. (default: 0.5)
• o (of type float?, which defaults to null): set trace opacity. (default: 0.8)
• tx (of type float?, which defaults to null): set trace x position. (default: 0.5)
• ty (of type float?, which defaults to null): set trace y position. (default: 0.9)
• tw (of type float?, which defaults to null): set trace width. (default: 0.8)
• th (of type float?, which defaults to null): set trace height. (default: 0.3)
• c (of type int?, which defaults to null): set components to trace. (default: 7)
• g (of type bool?, which defaults to null): draw trace grid. (default: true)
• st (of type bool?, which defaults to null): draw statistics. (default: true)
• sc (of type bool?, which defaults to null): draw scope. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.oscilloscope.create

Ffmpeg filter: 2D Video Oscilloscope. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : float?, ?y : float?, ?s : float?, ?t : float?, ?o : float?,
 ?tx : float?, ?ty : float?, ?tw : float?, ?th : float?, ?c : int?,
 ?g : bool?, ?st : bool?, ?sc : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• x (of type float?, which defaults to null): set scope x position. (default: 0.5)
• y (of type float?, which defaults to null): set scope y position. (default: 0.5)
• s (of type float?, which defaults to null): set scope size. (default: 0.8)
• t (of type float?, which defaults to null): set scope tilt. (default: 0.5)
• o (of type float?, which defaults to null): set trace opacity. (default: 0.8)
• tx (of type float?, which defaults to null): set trace x position. (default: 0.5)
• ty (of type float?, which defaults to null): set trace y position. (default: 0.9)
• tw (of type float?, which defaults to null): set trace width. (default: 0.8)
• th (of type float?, which defaults to null): set trace height. (default: 0.3)
• c (of type int?, which defaults to null): set components to trace. (default: 7)
• g (of type bool?, which defaults to null): draw trace grid. (default: true)
• st (of type bool?, which defaults to null): draw statistics. (default: true)
• sc (of type bool?, which defaults to null): draw scope. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.overlay

Ffmpeg filter: Overlay a video source on top of the input.

Type:

(?x : string?, ?y : string?, ?eof_action : int?, ?eval : int?,
 ?shortest : bool?, ?format : int?, ?repeatlast : bool?, ?alpha : int?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• x (of type string?, which defaults to null): set the x expression. (default: 0)
• y (of type string?, which defaults to null): set the y expression. (default: 0)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 1, possible values: 0 (init), 1 (frame))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• format (of type int?, which defaults to null): set output format. (default: 0, possible values: 0 (yuv420), 1 (yuv420p10), 2 (yuv422), 3 (yuv422p10), 4 (yuv444), 5 (yuv444p10), 6 (rgb), 7 (gbrp), 8 (auto))
• repeatlast (of type bool?, which defaults to null): repeat overlay of the last overlay frame. (default: true)
• alpha (of type int?, which defaults to null): alpha format. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (straight), 1 (premultiplied))
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.overlay.create

Ffmpeg filter: Overlay a video source on top of the input. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : string?, ?y : string?, ?eof_action : int?, ?eval : int?,
 ?shortest : bool?, ?format : int?, ?repeatlast : bool?, ?alpha : int?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• x (of type string?, which defaults to null): set the x expression. (default: 0)
• y (of type string?, which defaults to null): set the y expression. (default: 0)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 1, possible values: 0 (init), 1 (frame))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• format (of type int?, which defaults to null): set output format. (default: 0, possible values: 0 (yuv420), 1 (yuv420p10), 2 (yuv422), 3 (yuv422p10), 4 (yuv444), 5 (yuv444p10), 6 (rgb), 7 (gbrp), 8 (auto))
• repeatlast (of type bool?, which defaults to null): repeat overlay of the last overlay frame. (default: true)
• alpha (of type int?, which defaults to null): alpha format. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (straight), 1 (premultiplied))
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.owdenoise

Ffmpeg filter: Denoise using wavelets.

Type:

(?depth : int?, ?luma_strength : float?, ?ls : float?,
 ?chroma_strength : float?, ?cs : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• depth (of type int?, which defaults to null): set depth. (default: 8)
• luma_strength (of type float?, which defaults to null): set luma strength. (default: 1)
• ls (of type float?, which defaults to null): set luma strength. (default: 1)
• chroma_strength (of type float?, which defaults to null): set chroma strength. (default: 1)
• cs (of type float?, which defaults to null): set chroma strength. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.owdenoise.create

Ffmpeg filter: Denoise using wavelets. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?depth : int?, ?luma_strength : float?, ?ls : float?,
 ?chroma_strength : float?, ?cs : float?, ffmpeg.filter.graph) -> unit

Arguments:

• depth (of type int?, which defaults to null): set depth. (default: 8)
• luma_strength (of type float?, which defaults to null): set luma strength. (default: 1)
• ls (of type float?, which defaults to null): set luma strength. (default: 1)
• chroma_strength (of type float?, which defaults to null): set chroma strength. (default: 1)
• cs (of type float?, which defaults to null): set chroma strength. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pad

Ffmpeg filter: Pad the input video.

Type:

(?width : string?, ?w : string?, ?height : string?, ?h : string?,
 ?x : string?, ?y : string?, ?color : string?, ?eval : int?,
 ?aspect : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• width (of type string?, which defaults to null): set the pad area width expression. (default: iw)
• w (of type string?, which defaults to null): set the pad area width expression. (default: iw)
• height (of type string?, which defaults to null): set the pad area height expression. (default: ih)
• h (of type string?, which defaults to null): set the pad area height expression. (default: ih)
• x (of type string?, which defaults to null): set the x offset expression for the input image position. (default: 0)
• y (of type string?, which defaults to null): set the y offset expression for the input image position. (default: 0)
• color (of type string?, which defaults to null): set the color of the padded area border. (default: black)
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• aspect (of type string?, which defaults to null): pad to fit an aspect instead of a resolution. (default: 0/1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.pad.create

Ffmpeg filter: Pad the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?width : string?, ?w : string?, ?height : string?, ?h : string?,
 ?x : string?, ?y : string?, ?color : string?, ?eval : int?,
 ?aspect : string?, ffmpeg.filter.graph) -> unit

Arguments:

• width (of type string?, which defaults to null): set the pad area width expression. (default: iw)
• w (of type string?, which defaults to null): set the pad area width expression. (default: iw)
• height (of type string?, which defaults to null): set the pad area height expression. (default: ih)
• h (of type string?, which defaults to null): set the pad area height expression. (default: ih)
• x (of type string?, which defaults to null): set the x offset expression for the input image position. (default: 0)
• y (of type string?, which defaults to null): set the y offset expression for the input image position. (default: 0)
• color (of type string?, which defaults to null): set the color of the padded area border. (default: black)
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• aspect (of type string?, which defaults to null): pad to fit an aspect instead of a resolution. (default: 0/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pal100bars

Ffmpeg filter: Generate PAL 100% color bars.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.pal100bars.create

Ffmpeg filter: Generate PAL 100% color bars. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pal75bars

Ffmpeg filter: Generate PAL 75% color bars.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.pal75bars.create

Ffmpeg filter: Generate PAL 75% color bars. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.palettegen

Ffmpeg filter: Find the optimal palette for a given stream.

Type:

(?max_colors : int?, ?reserve_transparent : bool?,
 ?transparency_color : string?, ?stats_mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• max_colors (of type int?, which defaults to null): set the maximum number of colors to use in the palette. (default: 256)
• reserve_transparent (of type bool?, which defaults to null): reserve a palette entry for transparency. (default: true)
• transparency_color (of type string?, which defaults to null): set a background color for transparency. (default: lime)
• stats_mode (of type int?, which defaults to null): set statistics mode. (default: 0, possible values: 0 (full), 1 (diff), 2 (single))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.palettegen.create

Ffmpeg filter: Find the optimal palette for a given stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?max_colors : int?, ?reserve_transparent : bool?,
 ?transparency_color : string?, ?stats_mode : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• max_colors (of type int?, which defaults to null): set the maximum number of colors to use in the palette. (default: 256)
• reserve_transparent (of type bool?, which defaults to null): reserve a palette entry for transparency. (default: true)
• transparency_color (of type string?, which defaults to null): set a background color for transparency. (default: lime)
• stats_mode (of type int?, which defaults to null): set statistics mode. (default: 0, possible values: 0 (full), 1 (diff), 2 (single))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.paletteuse

Ffmpeg filter: Use a palette to downsample an input video stream.

Type:

(?dither : int?, ?bayer_scale : int?, ?diff_mode : int?, ?new : bool?,
 ?alpha_threshold : int?, ?debug_kdtree : string?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• dither (of type int?, which defaults to null): select dithering mode. (default: 5, possible values: 1 (bayer), 2 (heckbert), 3 (floyd_steinberg), 4 (sierra2), 5 (sierra2_4a), 6 (sierra3), 7 (burkes), 8 (atkinson))
• bayer_scale (of type int?, which defaults to null): set scale for bayer dithering. (default: 2)
• diff_mode (of type int?, which defaults to null): set frame difference mode. (default: 0, possible values: 1 (rectangle))
• new (of type bool?, which defaults to null): take new palette for each output frame. (default: false)
• alpha_threshold (of type int?, which defaults to null): set the alpha threshold for transparency. (default: 128)
• debug_kdtree (of type string?, which defaults to null): save Graphviz graph of the kdtree in specified file
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.paletteuse.create

Ffmpeg filter: Use a palette to downsample an input video stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?dither : int?, ?bayer_scale : int?, ?diff_mode : int?, ?new : bool?,
 ?alpha_threshold : int?, ?debug_kdtree : string?, ffmpeg.filter.graph) ->
unit

Arguments:

• dither (of type int?, which defaults to null): select dithering mode. (default: 5, possible values: 1 (bayer), 2 (heckbert), 3 (floyd_steinberg), 4 (sierra2), 5 (sierra2_4a), 6 (sierra3), 7 (burkes), 8 (atkinson))
• bayer_scale (of type int?, which defaults to null): set scale for bayer dithering. (default: 2)
• diff_mode (of type int?, which defaults to null): set frame difference mode. (default: 0, possible values: 1 (rectangle))
• new (of type bool?, which defaults to null): take new palette for each output frame. (default: false)
• alpha_threshold (of type int?, which defaults to null): set the alpha threshold for transparency. (default: 128)
• debug_kdtree (of type string?, which defaults to null): save Graphviz graph of the kdtree in specified file
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pan

Ffmpeg filter: Remix channels with coefficients (panning).

Type:

(?args : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• args (of type string?, which defaults to null)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.pan.create

Ffmpeg filter: Remix channels with coefficients (panning). Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?args : string?, ffmpeg.filter.graph) -> unit

Arguments:

• args (of type string?, which defaults to null)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.parse

Add the filters of a textual description, in FFmpeg's filtergraph syntax, to the graph.

Type:

(ffmpeg.filter.graph, description : string, ?inputs : 
 {
   audio : [string * ffmpeg.filter.audio],
   video : [string * ffmpeg.filter.video]
 }, ?outputs : {audio : [string], video : [string]}) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• description (of type string): The filtergraph description.
• inputs (of type { audio : [string * ffmpeg.filter.audio], video : [string * ffmpeg.filter.video] }, which defaults to {video=[], audio=[]}): Pads feeding the open inputs of the description, by label.
• outputs (of type {audio : [string], video : [string]}, which defaults to {video=[], audio=[]}): Labels of the open outputs of the description to return.

Methods:

• audio (of type [string * ffmpeg.filter.audio])
• video (of type [string * ffmpeg.filter.video])

ffmpeg.filter.perlin

Ffmpeg filter: Generate Perlin noise.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?octaves : int?, ?persistence : float?, ?xscale : float?, ?yscale : float?,
 ?tscale : float?, ?random_mode : int?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• octaves (of type int?, which defaults to null): set the number of components to use to generate the noise. (default: 1)
• persistence (of type float?, which defaults to null): set the octaves persistence. (default: 1)
• xscale (of type float?, which defaults to null): set x-scale factor. (default: 1)
• yscale (of type float?, which defaults to null): set y-scale factor. (default: 1)
• tscale (of type float?, which defaults to null): set t-scale factor. (default: 1)
• random_mode (of type int?, which defaults to null): set random mode used to compute initial pattern. (default: 0, possible values: 0 (random), 1 (ken), 2 (seed))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.perlin.create

Ffmpeg filter: Generate Perlin noise. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?octaves : int?, ?persistence : float?, ?xscale : float?, ?yscale : float?,
 ?tscale : float?, ?random_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• octaves (of type int?, which defaults to null): set the number of components to use to generate the noise. (default: 1)
• persistence (of type float?, which defaults to null): set the octaves persistence. (default: 1)
• xscale (of type float?, which defaults to null): set x-scale factor. (default: 1)
• yscale (of type float?, which defaults to null): set y-scale factor. (default: 1)
• tscale (of type float?, which defaults to null): set t-scale factor. (default: 1)
• random_mode (of type int?, which defaults to null): set random mode used to compute initial pattern. (default: 0, possible values: 0 (random), 1 (ken), 2 (seed))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.perms

Ffmpeg filter: Set permissions for the output video frame.

Type:

(?mode : int?, ?seed : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): select permissions mode. (default: 0, possible values: 0 (none), 1 (ro), 2 (rw), 3 (toggle), 4 (random))
• seed (of type int?, which defaults to null): set the seed for the random mode. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.perms.create

Ffmpeg filter: Set permissions for the output video frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?seed : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): select permissions mode. (default: 0, possible values: 0 (none), 1 (ro), 2 (rw), 3 (toggle), 4 (random))
• seed (of type int?, which defaults to null): set the seed for the random mode. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.perspective

Ffmpeg filter: Correct the perspective of video.

Type:

(?x0 : string?, ?y0 : string?, ?x1 : string?, ?y1 : string?, ?x2 : string?,
 ?y2 : string?, ?x3 : string?, ?y3 : string?, ?interpolation : int?,
 ?sense : int?, ?eval : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• x0 (of type string?, which defaults to null): set top left x coordinate. (default: 0)
• y0 (of type string?, which defaults to null): set top left y coordinate. (default: 0)
• x1 (of type string?, which defaults to null): set top right x coordinate. (default: W)
• y1 (of type string?, which defaults to null): set top right y coordinate. (default: 0)
• x2 (of type string?, which defaults to null): set bottom left x coordinate. (default: 0)
• y2 (of type string?, which defaults to null): set bottom left y coordinate. (default: H)
• x3 (of type string?, which defaults to null): set bottom right x coordinate. (default: W)
• y3 (of type string?, which defaults to null): set bottom right y coordinate. (default: H)
• interpolation (of type int?, which defaults to null): set interpolation. (default: 0, possible values: 0 (linear), 1 (cubic))
• sense (of type int?, which defaults to null): specify the sense of the coordinates. (default: 0, possible values: 0 (source), 1 (destination))
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.perspective.create

Ffmpeg filter: Correct the perspective of video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x0 : string?, ?y0 : string?, ?x1 : string?, ?y1 : string?, ?x2 : string?,
 ?y2 : string?, ?x3 : string?, ?y3 : string?, ?interpolation : int?,
 ?sense : int?, ?eval : int?, ffmpeg.filter.graph) -> unit

Arguments:

• x0 (of type string?, which defaults to null): set top left x coordinate. (default: 0)
• y0 (of type string?, which defaults to null): set top left y coordinate. (default: 0)
• x1 (of type string?, which defaults to null): set top right x coordinate. (default: W)
• y1 (of type string?, which defaults to null): set top right y coordinate. (default: 0)
• x2 (of type string?, which defaults to null): set bottom left x coordinate. (default: 0)
• y2 (of type string?, which defaults to null): set bottom left y coordinate. (default: H)
• x3 (of type string?, which defaults to null): set bottom right x coordinate. (default: W)
• y3 (of type string?, which defaults to null): set bottom right y coordinate. (default: H)
• interpolation (of type int?, which defaults to null): set interpolation. (default: 0, possible values: 0 (linear), 1 (cubic))
• sense (of type int?, which defaults to null): specify the sense of the coordinates. (default: 0, possible values: 0 (source), 1 (destination))
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.phase

Ffmpeg filter: Phase shift fields.

Type:

(?mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set phase mode. (default: 8, possible values: 0 (p), 1 (t), 2 (b), 3 (T), 4 (B), 5 (u), 6 (U), 7 (a), 8 (A))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.phase.create

Ffmpeg filter: Phase shift fields. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set phase mode. (default: 8, possible values: 0 (p), 1 (t), 2 (b), 3 (T), 4 (B), 5 (u), 6 (U), 7 (a), 8 (A))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.photosensitivity

Ffmpeg filter: Filter out photosensitive epilepsy seizure-inducing flashes.

Type:

(?frames : int?, ?f : int?, ?threshold : float?, ?t : float?, ?skip : int?,
 ?bypass : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• frames (of type int?, which defaults to null): set how many frames to use. (default: 30)
• f (of type int?, which defaults to null): set how many frames to use. (default: 30)
• threshold (of type float?, which defaults to null): set detection threshold factor (lower is stricter). (default: 1)
• t (of type float?, which defaults to null): set detection threshold factor (lower is stricter). (default: 1)
• skip (of type int?, which defaults to null): set pixels to skip when sampling frames. (default: 1)
• bypass (of type bool?, which defaults to null): leave frames unchanged. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.photosensitivity.create

Ffmpeg filter: Filter out photosensitive epilepsy seizure-inducing flashes. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frames : int?, ?f : int?, ?threshold : float?, ?t : float?, ?skip : int?,
 ?bypass : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• frames (of type int?, which defaults to null): set how many frames to use. (default: 30)
• f (of type int?, which defaults to null): set how many frames to use. (default: 30)
• threshold (of type float?, which defaults to null): set detection threshold factor (lower is stricter). (default: 1)
• t (of type float?, which defaults to null): set detection threshold factor (lower is stricter). (default: 1)
• skip (of type int?, which defaults to null): set pixels to skip when sampling frames. (default: 1)
• bypass (of type bool?, which defaults to null): leave frames unchanged. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pixdesctest

Ffmpeg filter: Test pixel format definitions.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.pixdesctest.create

Ffmpeg filter: Test pixel format definitions. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pixelize

Ffmpeg filter: Pixelize video.

Type:

(?width : int?, ?w : int?, ?height : int?, ?h : int?, ?mode : int?,
 ?m : int?, ?planes : int?, ?p : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• width (of type int?, which defaults to null): set block width. (default: 16)
• w (of type int?, which defaults to null): set block width. (default: 16)
• height (of type int?, which defaults to null): set block height. (default: 16)
• h (of type int?, which defaults to null): set block height. (default: 16)
• mode (of type int?, which defaults to null): set the pixelize mode. (default: 0, possible values: 0 (avg), 1 (min), 2 (max))
• m (of type int?, which defaults to null): set the pixelize mode. (default: 0, possible values: 0 (avg), 1 (min), 2 (max))
• planes (of type int?, which defaults to null): set what planes to filter. (default: 15)
• p (of type int?, which defaults to null): set what planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.pixelize.create

Ffmpeg filter: Pixelize video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?width : int?, ?w : int?, ?height : int?, ?h : int?, ?mode : int?,
 ?m : int?, ?planes : int?, ?p : int?, ffmpeg.filter.graph) -> unit

Arguments:

• width (of type int?, which defaults to null): set block width. (default: 16)
• w (of type int?, which defaults to null): set block width. (default: 16)
• height (of type int?, which defaults to null): set block height. (default: 16)
• h (of type int?, which defaults to null): set block height. (default: 16)
• mode (of type int?, which defaults to null): set the pixelize mode. (default: 0, possible values: 0 (avg), 1 (min), 2 (max))
• m (of type int?, which defaults to null): set the pixelize mode. (default: 0, possible values: 0 (avg), 1 (min), 2 (max))
• planes (of type int?, which defaults to null): set what planes to filter. (default: 15)
• p (of type int?, which defaults to null): set what planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pixscope

Ffmpeg filter: Pixel data analysis.

Type:

(?x : float?, ?y : float?, ?w : int?, ?h : int?, ?o : float?, ?wx : float?,
 ?wy : float?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• x (of type float?, which defaults to null): set scope x offset. (default: 0.5)
• y (of type float?, which defaults to null): set scope y offset. (default: 0.5)
• w (of type int?, which defaults to null): set scope width. (default: 7)
• h (of type int?, which defaults to null): set scope height. (default: 7)
• o (of type float?, which defaults to null): set window opacity. (default: 0.5)
• wx (of type float?, which defaults to null): set window x offset. (default: -1)
• wy (of type float?, which defaults to null): set window y offset. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.pixscope.create

Ffmpeg filter: Pixel data analysis. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?x : float?, ?y : float?, ?w : int?, ?h : int?, ?o : float?, ?wx : float?,
 ?wy : float?, ffmpeg.filter.graph) -> unit

Arguments:

• x (of type float?, which defaults to null): set scope x offset. (default: 0.5)
• y (of type float?, which defaults to null): set scope y offset. (default: 0.5)
• w (of type int?, which defaults to null): set scope width. (default: 7)
• h (of type int?, which defaults to null): set scope height. (default: 7)
• o (of type float?, which defaults to null): set window opacity. (default: 0.5)
• wx (of type float?, which defaults to null): set window x offset. (default: -1)
• wy (of type float?, which defaults to null): set window y offset. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pp7

Ffmpeg filter: Apply Postprocessing 7 filter.

Type:

(?qp : int?, ?mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• qp (of type int?, which defaults to null): force a constant quantizer parameter. (default: 0)
• mode (of type int?, which defaults to null): set thresholding mode. (default: 2, possible values: 0 (hard), 1 (soft), 2 (medium))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.pp7.create

Ffmpeg filter: Apply Postprocessing 7 filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?qp : int?, ?mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• qp (of type int?, which defaults to null): force a constant quantizer parameter. (default: 0)
• mode (of type int?, which defaults to null): set thresholding mode. (default: 2, possible values: 0 (hard), 1 (soft), 2 (medium))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.premultiply

Ffmpeg filter: PreMultiply first stream with first plane of second stream. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?planes : int?, ?inplace : bool?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• inplace (of type bool?, which defaults to null): enable inplace mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.premultiply.create

Ffmpeg filter: PreMultiply first stream with first plane of second stream. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?inplace : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• inplace (of type bool?, which defaults to null): enable inplace mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.premultiply_dynamic

Ffmpeg filter: Premultiply or unpremultiply an image in-place, as needed.

Type:

(?planes : int?, ?inplace : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• inplace (of type bool?, which defaults to null): enable inplace mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.premultiply_dynamic.create

Ffmpeg filter: Premultiply or unpremultiply an image in-place, as needed. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?inplace : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• inplace (of type bool?, which defaults to null): enable inplace mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.prewitt

Ffmpeg filter: Apply prewitt operator.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.prewitt.create

Ffmpeg filter: Apply prewitt operator. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pseudocolor

Ffmpeg filter: Make pseudocolored video frames.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?index : int?,
 ?i : int?, ?preset : int?, ?p : int?, ?opacity : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: val)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: val)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: val)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: val)
• index (of type int?, which defaults to null): set component as base. (default: 0)
• i (of type int?, which defaults to null): set component as base. (default: 0)
• preset (of type int?, which defaults to null): set preset. (default: -1, possible values: -1 (none), 0 (magma), 1 (inferno), 2 (plasma), 3 (viridis), 4 (turbo), 5 (cividis), 6 (range1), 7 (range2), 8 (shadows), 9 (highlights), 10 (solar), 11 (nominal), 12 (preferred), 13 (total), 14 (spectral), 15 (cool), 16 (heat), 17 (fiery), 18 (blues), 19 (green), 20 (helix))
• p (of type int?, which defaults to null): set preset. (default: -1, possible values: -1 (none), 0 (magma), 1 (inferno), 2 (plasma), 3 (viridis), 4 (turbo), 5 (cividis), 6 (range1), 7 (range2), 8 (shadows), 9 (highlights), 10 (solar), 11 (nominal), 12 (preferred), 13 (total), 14 (spectral), 15 (cool), 16 (heat), 17 (fiery), 18 (blues), 19 (green), 20 (helix))
• opacity (of type float?, which defaults to null): set pseudocolor opacity. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.pseudocolor.create

Ffmpeg filter: Make pseudocolored video frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?, ?index : int?,
 ?i : int?, ?preset : int?, ?p : int?, ?opacity : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: val)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: val)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: val)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: val)
• index (of type int?, which defaults to null): set component as base. (default: 0)
• i (of type int?, which defaults to null): set component as base. (default: 0)
• preset (of type int?, which defaults to null): set preset. (default: -1, possible values: -1 (none), 0 (magma), 1 (inferno), 2 (plasma), 3 (viridis), 4 (turbo), 5 (cividis), 6 (range1), 7 (range2), 8 (shadows), 9 (highlights), 10 (solar), 11 (nominal), 12 (preferred), 13 (total), 14 (spectral), 15 (cool), 16 (heat), 17 (fiery), 18 (blues), 19 (green), 20 (helix))
• p (of type int?, which defaults to null): set preset. (default: -1, possible values: -1 (none), 0 (magma), 1 (inferno), 2 (plasma), 3 (viridis), 4 (turbo), 5 (cividis), 6 (range1), 7 (range2), 8 (shadows), 9 (highlights), 10 (solar), 11 (nominal), 12 (preferred), 13 (total), 14 (spectral), 15 (cool), 16 (heat), 17 (fiery), 18 (blues), 19 (green), 20 (helix))
• opacity (of type float?, which defaults to null): set pseudocolor opacity. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.psnr

Ffmpeg filter: Calculate the PSNR between two video streams.

Type:

(?stats_file : string?, ?f : string?, ?stats_version : int?,
 ?output_max : bool?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame difference information
• f (of type string?, which defaults to null): Set file where to store per-frame difference information
• stats_version (of type int?, which defaults to null): Set the format version for the stats file.. (default: 1)
• output_max (of type bool?, which defaults to null): Add raw stats (max values) to the output log.. (default: false)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.psnr.create

Ffmpeg filter: Calculate the PSNR between two video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?stats_file : string?, ?f : string?, ?stats_version : int?,
 ?output_max : bool?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame difference information
• f (of type string?, which defaults to null): Set file where to store per-frame difference information
• stats_version (of type int?, which defaults to null): Set the format version for the stats file.. (default: 1)
• output_max (of type bool?, which defaults to null): Add raw stats (max values) to the output log.. (default: false)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.pullup

Ffmpeg filter: Pullup from field sequence to frames.

Type:

(?jl : int?, ?jr : int?, ?jt : int?, ?jb : int?, ?sb : bool?, ?mp : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• jl (of type int?, which defaults to null): set left junk size. (default: 1)
• jr (of type int?, which defaults to null): set right junk size. (default: 1)
• jt (of type int?, which defaults to null): set top junk size. (default: 4)
• jb (of type int?, which defaults to null): set bottom junk size. (default: 4)
• sb (of type bool?, which defaults to null): set strict breaks. (default: false)
• mp (of type int?, which defaults to null): set metric plane. (default: 0, possible values: 0 (y), 1 (u), 2 (v))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.pullup.create

Ffmpeg filter: Pullup from field sequence to frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?jl : int?, ?jr : int?, ?jt : int?, ?jb : int?, ?sb : bool?, ?mp : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• jl (of type int?, which defaults to null): set left junk size. (default: 1)
• jr (of type int?, which defaults to null): set right junk size. (default: 1)
• jt (of type int?, which defaults to null): set top junk size. (default: 4)
• jb (of type int?, which defaults to null): set bottom junk size. (default: 4)
• sb (of type bool?, which defaults to null): set strict breaks. (default: false)
• mp (of type int?, which defaults to null): set metric plane. (default: 0, possible values: 0 (y), 1 (u), 2 (v))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.qp

Ffmpeg filter: Change video quantization parameters.

Type:

(?qp : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• qp (of type string?, which defaults to null): set qp expression
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.qp.create

Ffmpeg filter: Change video quantization parameters. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?qp : string?, ffmpeg.filter.graph) -> unit

Arguments:

• qp (of type string?, which defaults to null): set qp expression
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.random

Ffmpeg filter: Return random frames.

Type:

(?frames : int?, ?seed : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• frames (of type int?, which defaults to null): set number of frames in cache. (default: 30)
• seed (of type int?, which defaults to null): set the seed. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.random.create

Ffmpeg filter: Return random frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frames : int?, ?seed : int?, ffmpeg.filter.graph) -> unit

Arguments:

• frames (of type int?, which defaults to null): set number of frames in cache. (default: 30)
• seed (of type int?, which defaults to null): set the seed. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.readeia608

Ffmpeg filter: Read EIA-608 Closed Caption codes from input video and write them to frame metadata.

Type:

(?scan_min : int?, ?scan_max : int?, ?spw : float?, ?chp : bool?,
 ?lp : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• scan_min (of type int?, which defaults to null): set from which line to scan for codes. (default: 0)
• scan_max (of type int?, which defaults to null): set to which line to scan for codes. (default: 29)
• spw (of type float?, which defaults to null): set ratio of width reserved for sync code detection. (default: 0.27)
• chp (of type bool?, which defaults to null): check and apply parity bit. (default: false)
• lp (of type bool?, which defaults to null): lowpass line prior to processing. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.readeia608.create

Ffmpeg filter: Read EIA-608 Closed Caption codes from input video and write them to frame metadata. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?scan_min : int?, ?scan_max : int?, ?spw : float?, ?chp : bool?,
 ?lp : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• scan_min (of type int?, which defaults to null): set from which line to scan for codes. (default: 0)
• scan_max (of type int?, which defaults to null): set to which line to scan for codes. (default: 29)
• spw (of type float?, which defaults to null): set ratio of width reserved for sync code detection. (default: 0.27)
• chp (of type bool?, which defaults to null): check and apply parity bit. (default: false)
• lp (of type bool?, which defaults to null): lowpass line prior to processing. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.readvitc

Ffmpeg filter: Read vertical interval timecode and write it to frame metadata.

Type:

(?scan_max : int?, ?thr_b : float?, ?thr_w : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• scan_max (of type int?, which defaults to null): maximum line numbers to scan for VITC data. (default: 45)
• thr_b (of type float?, which defaults to null): black color threshold. (default: 0.2)
• thr_w (of type float?, which defaults to null): white color threshold. (default: 0.6)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.readvitc.create

Ffmpeg filter: Read vertical interval timecode and write it to frame metadata. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?scan_max : int?, ?thr_b : float?, ?thr_w : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• scan_max (of type int?, which defaults to null): maximum line numbers to scan for VITC data. (default: 45)
• thr_b (of type float?, which defaults to null): black color threshold. (default: 0.2)
• thr_w (of type float?, which defaults to null): white color threshold. (default: 0.6)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.realtime

Ffmpeg filter: Slow down filtering to match realtime.

Type:

(?limit : int?, ?speed : float?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• limit (of type int?, which defaults to null): sleep time limit. (default: 2)
• speed (of type float?, which defaults to null): speed factor. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.realtime.create

Ffmpeg filter: Slow down filtering to match realtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?limit : int?, ?speed : float?, ffmpeg.filter.graph) -> unit

Arguments:

• limit (of type int?, which defaults to null): sleep time limit. (default: 2)
• speed (of type float?, which defaults to null): speed factor. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.remap

Ffmpeg filter: Remap pixels.

Type:

(?format : int?, ?fill : string?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• format (of type int?, which defaults to null): set output format. (default: 0, possible values: 0 (color), 1 (gray))
• fill (of type string?, which defaults to null): set the color of the unmapped pixels. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.remap.create

Ffmpeg filter: Remap pixels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?format : int?, ?fill : string?, ffmpeg.filter.graph) -> unit

Arguments:

• format (of type int?, which defaults to null): set output format. (default: 0, possible values: 0 (color), 1 (gray))
• fill (of type string?, which defaults to null): set the color of the unmapped pixels. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.removegrain

Ffmpeg filter: Remove grain.

Type:

(?m0 : int?, ?m1 : int?, ?m2 : int?, ?m3 : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• m0 (of type int?, which defaults to null): set mode for 1st plane. (default: 0)
• m1 (of type int?, which defaults to null): set mode for 2nd plane. (default: 0)
• m2 (of type int?, which defaults to null): set mode for 3rd plane. (default: 0)
• m3 (of type int?, which defaults to null): set mode for 4th plane. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.removegrain.create

Ffmpeg filter: Remove grain. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?m0 : int?, ?m1 : int?, ?m2 : int?, ?m3 : int?, ffmpeg.filter.graph) -> unit

Arguments:

• m0 (of type int?, which defaults to null): set mode for 1st plane. (default: 0)
• m1 (of type int?, which defaults to null): set mode for 2nd plane. (default: 0)
• m2 (of type int?, which defaults to null): set mode for 3rd plane. (default: 0)
• m3 (of type int?, which defaults to null): set mode for 4th plane. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.removelogo

Ffmpeg filter: Remove a TV logo based on a mask image.

Type:

(?filename : string?, ?f : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• filename (of type string?, which defaults to null): set bitmap filename
• f (of type string?, which defaults to null): set bitmap filename
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.removelogo.create

Ffmpeg filter: Remove a TV logo based on a mask image. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filename : string?, ?f : string?, ffmpeg.filter.graph) -> unit

Arguments:

• filename (of type string?, which defaults to null): set bitmap filename
• f (of type string?, which defaults to null): set bitmap filename
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.repeatfields

Ffmpeg filter: Hard repeat fields based on MPEG repeat field flag.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.repeatfields.create

Ffmpeg filter: Hard repeat fields based on MPEG repeat field flag. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.replaygain

Ffmpeg filter: ReplayGain scanner.

Type:

(?track_gain : float?, ?track_peak : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• track_gain (of type float?, which defaults to null): track gain (dB). (default: 0)
• track_peak (of type float?, which defaults to null): track peak. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.replaygain.create

Ffmpeg filter: ReplayGain scanner. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?track_gain : float?, ?track_peak : float?, ffmpeg.filter.graph) -> unit

Arguments:

• track_gain (of type float?, which defaults to null): track gain (dB). (default: 0)
• track_peak (of type float?, which defaults to null): track peak. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.reverse

Ffmpeg filter: Reverse a clip.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.reverse.create

Ffmpeg filter: Reverse a clip. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.rgbashift

Ffmpeg filter: Shift RGBA.

Type:

(?rh : int?, ?rv : int?, ?gh : int?, ?gv : int?, ?bh : int?, ?bv : int?,
 ?ah : int?, ?av : int?, ?edge : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• rh (of type int?, which defaults to null): shift red horizontally. (default: 0)
• rv (of type int?, which defaults to null): shift red vertically. (default: 0)
• gh (of type int?, which defaults to null): shift green horizontally. (default: 0)
• gv (of type int?, which defaults to null): shift green vertically. (default: 0)
• bh (of type int?, which defaults to null): shift blue horizontally. (default: 0)
• bv (of type int?, which defaults to null): shift blue vertically. (default: 0)
• ah (of type int?, which defaults to null): shift alpha horizontally. (default: 0)
• av (of type int?, which defaults to null): shift alpha vertically. (default: 0)
• edge (of type int?, which defaults to null): set edge operation. (default: 0, possible values: 0 (smear), 1 (wrap))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.rgbashift.create

Ffmpeg filter: Shift RGBA. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rh : int?, ?rv : int?, ?gh : int?, ?gv : int?, ?bh : int?, ?bv : int?,
 ?ah : int?, ?av : int?, ?edge : int?, ffmpeg.filter.graph) -> unit

Arguments:

• rh (of type int?, which defaults to null): shift red horizontally. (default: 0)
• rv (of type int?, which defaults to null): shift red vertically. (default: 0)
• gh (of type int?, which defaults to null): shift green horizontally. (default: 0)
• gv (of type int?, which defaults to null): shift green vertically. (default: 0)
• bh (of type int?, which defaults to null): shift blue horizontally. (default: 0)
• bv (of type int?, which defaults to null): shift blue vertically. (default: 0)
• ah (of type int?, which defaults to null): shift alpha horizontally. (default: 0)
• av (of type int?, which defaults to null): shift alpha vertically. (default: 0)
• edge (of type int?, which defaults to null): set edge operation. (default: 0, possible values: 0 (smear), 1 (wrap))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.rgbtestsrc

Ffmpeg filter: Generate RGB test pattern.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?complement : bool?,
 ?co : bool?, ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• complement (of type bool?, which defaults to null): set complement colors. (default: false)
• co (of type bool?, which defaults to null): set complement colors. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.rgbtestsrc.create

Ffmpeg filter: Generate RGB test pattern. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?complement : bool?,
 ?co : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• complement (of type bool?, which defaults to null): set complement colors. (default: false)
• co (of type bool?, which defaults to null): set complement colors. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.roberts

Ffmpeg filter: Apply roberts cross operator.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.roberts.create

Ffmpeg filter: Apply roberts cross operator. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.rotate

Ffmpeg filter: Rotate the input image.

Type:

(?angle : string?, ?a : string?, ?out_w : string?, ?ow : string?,
 ?out_h : string?, ?oh : string?, ?fillcolor : string?, ?c : string?,
 ?bilinear : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• angle (of type string?, which defaults to null): set angle (in radians). (default: 0)
• a (of type string?, which defaults to null): set angle (in radians). (default: 0)
• out_w (of type string?, which defaults to null): set output width expression. (default: iw)
• ow (of type string?, which defaults to null): set output width expression. (default: iw)
• out_h (of type string?, which defaults to null): set output height expression. (default: ih)
• oh (of type string?, which defaults to null): set output height expression. (default: ih)
• fillcolor (of type string?, which defaults to null): set background fill color. (default: black)
• c (of type string?, which defaults to null): set background fill color. (default: black)
• bilinear (of type bool?, which defaults to null): use bilinear interpolation. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.rotate.create

Ffmpeg filter: Rotate the input image. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?angle : string?, ?a : string?, ?out_w : string?, ?ow : string?,
 ?out_h : string?, ?oh : string?, ?fillcolor : string?, ?c : string?,
 ?bilinear : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• angle (of type string?, which defaults to null): set angle (in radians). (default: 0)
• a (of type string?, which defaults to null): set angle (in radians). (default: 0)
• out_w (of type string?, which defaults to null): set output width expression. (default: iw)
• ow (of type string?, which defaults to null): set output width expression. (default: iw)
• out_h (of type string?, which defaults to null): set output height expression. (default: ih)
• oh (of type string?, which defaults to null): set output height expression. (default: ih)
• fillcolor (of type string?, which defaults to null): set background fill color. (default: black)
• c (of type string?, which defaults to null): set background fill color. (default: black)
• bilinear (of type bool?, which defaults to null): use bilinear interpolation. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sab

Ffmpeg filter: Apply shape adaptive blur.

Type:

(?luma_radius : float?, ?lr : float?, ?luma_pre_filter_radius : float?,
 ?lpfr : float?, ?luma_strength : float?, ?ls : float?,
 ?chroma_radius : float?, ?cr : float?, ?chroma_pre_filter_radius : float?,
 ?cpfr : float?, ?chroma_strength : float?, ?cs : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• luma_radius (of type float?, which defaults to null): set luma radius. (default: 1)
• lr (of type float?, which defaults to null): set luma radius. (default: 1)
• luma_pre_filter_radius (of type float?, which defaults to null): set luma pre-filter radius. (default: 1)
• lpfr (of type float?, which defaults to null): set luma pre-filter radius. (default: 1)
• luma_strength (of type float?, which defaults to null): set luma strength. (default: 1)
• ls (of type float?, which defaults to null): set luma strength. (default: 1)
• chroma_radius (of type float?, which defaults to null): set chroma radius. (default: -0.9)
• cr (of type float?, which defaults to null): set chroma radius. (default: -0.9)
• chroma_pre_filter_radius (of type float?, which defaults to null): set chroma pre-filter radius. (default: -0.9)
• cpfr (of type float?, which defaults to null): set chroma pre-filter radius. (default: -0.9)
• chroma_strength (of type float?, which defaults to null): set chroma strength. (default: -0.9)
• cs (of type float?, which defaults to null): set chroma strength. (default: -0.9)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.sab.create

Ffmpeg filter: Apply shape adaptive blur. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?luma_radius : float?, ?lr : float?, ?luma_pre_filter_radius : float?,
 ?lpfr : float?, ?luma_strength : float?, ?ls : float?,
 ?chroma_radius : float?, ?cr : float?, ?chroma_pre_filter_radius : float?,
 ?cpfr : float?, ?chroma_strength : float?, ?cs : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• luma_radius (of type float?, which defaults to null): set luma radius. (default: 1)
• lr (of type float?, which defaults to null): set luma radius. (default: 1)
• luma_pre_filter_radius (of type float?, which defaults to null): set luma pre-filter radius. (default: 1)
• lpfr (of type float?, which defaults to null): set luma pre-filter radius. (default: 1)
• luma_strength (of type float?, which defaults to null): set luma strength. (default: 1)
• ls (of type float?, which defaults to null): set luma strength. (default: 1)
• chroma_radius (of type float?, which defaults to null): set chroma radius. (default: -0.9)
• cr (of type float?, which defaults to null): set chroma radius. (default: -0.9)
• chroma_pre_filter_radius (of type float?, which defaults to null): set chroma pre-filter radius. (default: -0.9)
• cpfr (of type float?, which defaults to null): set chroma pre-filter radius. (default: -0.9)
• chroma_strength (of type float?, which defaults to null): set chroma strength. (default: -0.9)
• cs (of type float?, which defaults to null): set chroma strength. (default: -0.9)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.scale

Ffmpeg filter: Scale the input video size and/or convert the image format. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?w : string?, ?width : string?, ?h : string?, ?height : string?,
 ?flags : string?, ?interl : bool?, ?size : string?, ?s : string?,
 ?in_color_matrix : int?, ?out_color_matrix : int?, ?in_range : int?,
 ?out_range : int?, ?in_chroma_loc : int?, ?out_chroma_loc : int?,
 ?in_primaries : int?, ?out_primaries : int?, ?in_transfer : int?,
 ?out_transfer : int?, ?in_v_chr_pos : int?, ?in_h_chr_pos : int?,
 ?out_v_chr_pos : int?, ?out_h_chr_pos : int?,
 ?force_original_aspect_ratio : int?, ?force_divisible_by : int?,
 ?reset_sar : bool?, ?param0 : float?, ?param1 : float?, ?eval : int?,
 ?sws_flags : int?, ?scaler : int?, ?scaler_sub : int?, ?srcw : int?,
 ?srch : int?, ?dstw : int?, ?dsth : int?, ?src_format : string?,
 ?dst_format : string?, ?src_range : bool?, ?dst_range : bool?,
 ?gamma : bool?, ?src_v_chr_pos : int?, ?src_h_chr_pos : int?,
 ?dst_v_chr_pos : int?, ?dst_h_chr_pos : int?, ?sws_dither : int?,
 ?alphablend : int?, ?threads : int?, ?intent : int?, ?sws_backends : int?,
 ?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• w (of type string?, which defaults to null): Output video width
• width (of type string?, which defaults to null): Output video width
• h (of type string?, which defaults to null): Output video height
• height (of type string?, which defaults to null): Output video height
• flags (of type string?, which defaults to null): Flags to pass to libswscale. (default: )
• interl (of type bool?, which defaults to null): set interlacing. (default: false)
• size (of type string?, which defaults to null): set video size
• s (of type string?, which defaults to null): set video size
• in_color_matrix (of type int?, which defaults to null): set input YCbCr type. (default: -1, possible values: -1 (auto), 5 (bt601), 5 (bt470), 5 (smpte170m), 5 (bt470bg), 1 (bt709), 4 (fcc), 7 (smpte240m), 9 (bt2020), 9 (bt2020nc))
• out_color_matrix (of type int?, which defaults to null): set output YCbCr type. (default: 2, possible values: -1 (auto), 5 (bt601), 5 (bt470), 5 (smpte170m), 5 (bt470bg), 1 (bt709), 4 (fcc), 7 (smpte240m), 9 (bt2020), 9 (bt2020nc))
• in_range (of type int?, which defaults to null): set input color range. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (full), 1 (limited), 2 (jpeg), 1 (mpeg), 1 (tv), 2 (pc))
• out_range (of type int?, which defaults to null): set output color range. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (full), 1 (limited), 2 (jpeg), 1 (mpeg), 1 (tv), 2 (pc))
• in_chroma_loc (of type int?, which defaults to null): set input chroma sample location. (default: 0, possible values: 0 (auto), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• out_chroma_loc (of type int?, which defaults to null): set output chroma sample location. (default: 0, possible values: 0 (auto), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• in_primaries (of type int?, which defaults to null): set input primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213))
• out_primaries (of type int?, which defaults to null): set output primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213))
• in_transfer (of type int?, which defaults to null): set output color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (iec61966-2-1), 13 (srgb), 11 (iec61966-2-4), 11 (xvycc), 12 (bt1361e), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67))
• out_transfer (of type int?, which defaults to null): set output color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (iec61966-2-1), 13 (srgb), 11 (iec61966-2-4), 11 (xvycc), 12 (bt1361e), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67))
• in_v_chr_pos (of type int?, which defaults to null): input vertical chroma position in luma grid/256. (default: -513)
• in_h_chr_pos (of type int?, which defaults to null): input horizontal chroma position in luma grid/256. (default: -513)
• out_v_chr_pos (of type int?, which defaults to null): output vertical chroma position in luma grid/256. (default: -513)
• out_h_chr_pos (of type int?, which defaults to null): output horizontal chroma position in luma grid/256. (default: -513)
• force_original_aspect_ratio (of type int?, which defaults to null): decrease or increase w/h if necessary to keep the original AR. (default: 0, possible values: 0 (disable), 1 (decrease), 2 (increase))
• force_divisible_by (of type int?, which defaults to null): enforce that the output resolution is divisible by a defined integer when force_original_aspect_ratio is used. (default: 1)
• reset_sar (of type bool?, which defaults to null): reset SAR to 1 and scale to square pixels if scaling proportionally. (default: false)
• param0 (of type float?, which defaults to null): Scaler param 0. (default: 1.7976931348623157e+308)
• param1 (of type float?, which defaults to null): Scaler param 1. (default: 1.7976931348623157e+308)
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• sws_flags (of type int?, which defaults to null): swscale flags. (default: 4, possible values: 1 (fast_bilinear), 2 (bilinear), 4 (bicubic), 8 (experimental), 16 (neighbor), 32 (area), 64 (bicublin), 128 (gauss), 256 (sinc), 512 (lanczos), 1024 (spline), 4096 (print_info), 262144 (accurate_rnd), 8192 (full_chroma_int), 16384 (full_chroma_inp), 524288 (bitexact), 8388608 (error_diffusion), 1048576 (unstable), 2048 (strict), combined by addition)
• scaler (of type int?, which defaults to null): set scaling algorithm. (default: 0, possible values: 0 (auto), 1 (bilinear), 2 (bicubic), 3 (point), 3 (neighbor), 4 (area), 5 (gaussian), 6 (sinc), 7 (lanczos), 8 (spline))
• scaler_sub (of type int?, which defaults to null): set subsampling algorithm. (default: 0, possible values: 0 (auto), 1 (bilinear), 2 (bicubic), 3 (point), 3 (neighbor), 4 (area), 5 (gaussian), 6 (sinc), 7 (lanczos), 8 (spline))
• srcw (of type int?, which defaults to null): source width. (default: 16)
• srch (of type int?, which defaults to null): source height. (default: 16)
• dstw (of type int?, which defaults to null): destination width. (default: 16)
• dsth (of type int?, which defaults to null): destination height. (default: 16)
• src_format (of type string?, which defaults to null): source format. (default: yuv420p)
• dst_format (of type string?, which defaults to null): destination format. (default: yuv420p)
• src_range (of type bool?, which defaults to null): source is full range. (default: false)
• dst_range (of type bool?, which defaults to null): destination is full range. (default: false)
• gamma (of type bool?, which defaults to null): gamma correct scaling. (default: false)
• src_v_chr_pos (of type int?, which defaults to null): source vertical chroma position in luma grid/256. (default: -513)
• src_h_chr_pos (of type int?, which defaults to null): source horizontal chroma position in luma grid/256. (default: -513)
• dst_v_chr_pos (of type int?, which defaults to null): destination vertical chroma position in luma grid/256. (default: -513)
• dst_h_chr_pos (of type int?, which defaults to null): destination horizontal chroma position in luma grid/256. (default: -513)
• sws_dither (of type int?, which defaults to null): set dithering algorithm. (default: 1, possible values: 1 (auto), 0 (none), 2 (bayer), 3 (ed), 4 (a_dither), 5 (x_dither))
• alphablend (of type int?, which defaults to null): mode for alpha -> non alpha. (default: 0, possible values: 0 (none), 1 (uniform_color), 2 (checkerboard))
• threads (of type int?, which defaults to null): number of threads. (default: 1, possible values: 0 (auto))
• intent (of type int?, which defaults to null): color mapping intent. (default: 1, possible values: 0 (perceptual), 1 (relative_colorimetric), 2 (saturation), 3 (absolute_colorimetric))
• sws_backends (of type int?, which defaults to null): set allowed swscale backends. (default: 0, possible values: 0 (auto), 1 (stable), 62 (unstable), 63 (all), 1 (legacy), 2 (c), 4 (memcpy), 8 (x86), 16 (aarch64), 32 (spirv), combined by addition)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.scale.create

Ffmpeg filter: Scale the input video size and/or convert the image format. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?w : string?, ?width : string?, ?h : string?, ?height : string?,
 ?flags : string?, ?interl : bool?, ?size : string?, ?s : string?,
 ?in_color_matrix : int?, ?out_color_matrix : int?, ?in_range : int?,
 ?out_range : int?, ?in_chroma_loc : int?, ?out_chroma_loc : int?,
 ?in_primaries : int?, ?out_primaries : int?, ?in_transfer : int?,
 ?out_transfer : int?, ?in_v_chr_pos : int?, ?in_h_chr_pos : int?,
 ?out_v_chr_pos : int?, ?out_h_chr_pos : int?,
 ?force_original_aspect_ratio : int?, ?force_divisible_by : int?,
 ?reset_sar : bool?, ?param0 : float?, ?param1 : float?, ?eval : int?,
 ?sws_flags : int?, ?scaler : int?, ?scaler_sub : int?, ?srcw : int?,
 ?srch : int?, ?dstw : int?, ?dsth : int?, ?src_format : string?,
 ?dst_format : string?, ?src_range : bool?, ?dst_range : bool?,
 ?gamma : bool?, ?src_v_chr_pos : int?, ?src_h_chr_pos : int?,
 ?dst_v_chr_pos : int?, ?dst_h_chr_pos : int?, ?sws_dither : int?,
 ?alphablend : int?, ?threads : int?, ?intent : int?, ?sws_backends : int?,
 ?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• w (of type string?, which defaults to null): Output video width
• width (of type string?, which defaults to null): Output video width
• h (of type string?, which defaults to null): Output video height
• height (of type string?, which defaults to null): Output video height
• flags (of type string?, which defaults to null): Flags to pass to libswscale. (default: )
• interl (of type bool?, which defaults to null): set interlacing. (default: false)
• size (of type string?, which defaults to null): set video size
• s (of type string?, which defaults to null): set video size
• in_color_matrix (of type int?, which defaults to null): set input YCbCr type. (default: -1, possible values: -1 (auto), 5 (bt601), 5 (bt470), 5 (smpte170m), 5 (bt470bg), 1 (bt709), 4 (fcc), 7 (smpte240m), 9 (bt2020), 9 (bt2020nc))
• out_color_matrix (of type int?, which defaults to null): set output YCbCr type. (default: 2, possible values: -1 (auto), 5 (bt601), 5 (bt470), 5 (smpte170m), 5 (bt470bg), 1 (bt709), 4 (fcc), 7 (smpte240m), 9 (bt2020), 9 (bt2020nc))
• in_range (of type int?, which defaults to null): set input color range. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (full), 1 (limited), 2 (jpeg), 1 (mpeg), 1 (tv), 2 (pc))
• out_range (of type int?, which defaults to null): set output color range. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (full), 1 (limited), 2 (jpeg), 1 (mpeg), 1 (tv), 2 (pc))
• in_chroma_loc (of type int?, which defaults to null): set input chroma sample location. (default: 0, possible values: 0 (auto), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• out_chroma_loc (of type int?, which defaults to null): set output chroma sample location. (default: 0, possible values: 0 (auto), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• in_primaries (of type int?, which defaults to null): set input primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213))
• out_primaries (of type int?, which defaults to null): set output primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213))
• in_transfer (of type int?, which defaults to null): set output color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (iec61966-2-1), 13 (srgb), 11 (iec61966-2-4), 11 (xvycc), 12 (bt1361e), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67))
• out_transfer (of type int?, which defaults to null): set output color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (iec61966-2-1), 13 (srgb), 11 (iec61966-2-4), 11 (xvycc), 12 (bt1361e), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67))
• in_v_chr_pos (of type int?, which defaults to null): input vertical chroma position in luma grid/256. (default: -513)
• in_h_chr_pos (of type int?, which defaults to null): input horizontal chroma position in luma grid/256. (default: -513)
• out_v_chr_pos (of type int?, which defaults to null): output vertical chroma position in luma grid/256. (default: -513)
• out_h_chr_pos (of type int?, which defaults to null): output horizontal chroma position in luma grid/256. (default: -513)
• force_original_aspect_ratio (of type int?, which defaults to null): decrease or increase w/h if necessary to keep the original AR. (default: 0, possible values: 0 (disable), 1 (decrease), 2 (increase))
• force_divisible_by (of type int?, which defaults to null): enforce that the output resolution is divisible by a defined integer when force_original_aspect_ratio is used. (default: 1)
• reset_sar (of type bool?, which defaults to null): reset SAR to 1 and scale to square pixels if scaling proportionally. (default: false)
• param0 (of type float?, which defaults to null): Scaler param 0. (default: 1.7976931348623157e+308)
• param1 (of type float?, which defaults to null): Scaler param 1. (default: 1.7976931348623157e+308)
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• sws_flags (of type int?, which defaults to null): swscale flags. (default: 4, possible values: 1 (fast_bilinear), 2 (bilinear), 4 (bicubic), 8 (experimental), 16 (neighbor), 32 (area), 64 (bicublin), 128 (gauss), 256 (sinc), 512 (lanczos), 1024 (spline), 4096 (print_info), 262144 (accurate_rnd), 8192 (full_chroma_int), 16384 (full_chroma_inp), 524288 (bitexact), 8388608 (error_diffusion), 1048576 (unstable), 2048 (strict), combined by addition)
• scaler (of type int?, which defaults to null): set scaling algorithm. (default: 0, possible values: 0 (auto), 1 (bilinear), 2 (bicubic), 3 (point), 3 (neighbor), 4 (area), 5 (gaussian), 6 (sinc), 7 (lanczos), 8 (spline))
• scaler_sub (of type int?, which defaults to null): set subsampling algorithm. (default: 0, possible values: 0 (auto), 1 (bilinear), 2 (bicubic), 3 (point), 3 (neighbor), 4 (area), 5 (gaussian), 6 (sinc), 7 (lanczos), 8 (spline))
• srcw (of type int?, which defaults to null): source width. (default: 16)
• srch (of type int?, which defaults to null): source height. (default: 16)
• dstw (of type int?, which defaults to null): destination width. (default: 16)
• dsth (of type int?, which defaults to null): destination height. (default: 16)
• src_format (of type string?, which defaults to null): source format. (default: yuv420p)
• dst_format (of type string?, which defaults to null): destination format. (default: yuv420p)
• src_range (of type bool?, which defaults to null): source is full range. (default: false)
• dst_range (of type bool?, which defaults to null): destination is full range. (default: false)
• gamma (of type bool?, which defaults to null): gamma correct scaling. (default: false)
• src_v_chr_pos (of type int?, which defaults to null): source vertical chroma position in luma grid/256. (default: -513)
• src_h_chr_pos (of type int?, which defaults to null): source horizontal chroma position in luma grid/256. (default: -513)
• dst_v_chr_pos (of type int?, which defaults to null): destination vertical chroma position in luma grid/256. (default: -513)
• dst_h_chr_pos (of type int?, which defaults to null): destination horizontal chroma position in luma grid/256. (default: -513)
• sws_dither (of type int?, which defaults to null): set dithering algorithm. (default: 1, possible values: 1 (auto), 0 (none), 2 (bayer), 3 (ed), 4 (a_dither), 5 (x_dither))
• alphablend (of type int?, which defaults to null): mode for alpha -> non alpha. (default: 0, possible values: 0 (none), 1 (uniform_color), 2 (checkerboard))
• threads (of type int?, which defaults to null): number of threads. (default: 1, possible values: 0 (auto))
• intent (of type int?, which defaults to null): color mapping intent. (default: 1, possible values: 0 (perceptual), 1 (relative_colorimetric), 2 (saturation), 3 (absolute_colorimetric))
• sws_backends (of type int?, which defaults to null): set allowed swscale backends. (default: 0, possible values: 0 (auto), 1 (stable), 62 (unstable), 63 (all), 1 (legacy), 2 (c), 4 (memcpy), 8 (x86), 16 (aarch64), 32 (spirv), combined by addition)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.scale2ref

Ffmpeg filter: Scale the input video size and/or convert the image format to the given reference.

Type:

(?w : string?, ?width : string?, ?h : string?, ?height : string?,
 ?flags : string?, ?interl : bool?, ?size : string?, ?s : string?,
 ?in_color_matrix : int?, ?out_color_matrix : int?, ?in_range : int?,
 ?out_range : int?, ?in_chroma_loc : int?, ?out_chroma_loc : int?,
 ?in_primaries : int?, ?out_primaries : int?, ?in_transfer : int?,
 ?out_transfer : int?, ?in_v_chr_pos : int?, ?in_h_chr_pos : int?,
 ?out_v_chr_pos : int?, ?out_h_chr_pos : int?,
 ?force_original_aspect_ratio : int?, ?force_divisible_by : int?,
 ?reset_sar : bool?, ?param0 : float?, ?param1 : float?, ?eval : int?,
 ?sws_flags : int?, ?scaler : int?, ?scaler_sub : int?, ?srcw : int?,
 ?srch : int?, ?dstw : int?, ?dsth : int?, ?src_format : string?,
 ?dst_format : string?, ?src_range : bool?, ?dst_range : bool?,
 ?gamma : bool?, ?src_v_chr_pos : int?, ?src_h_chr_pos : int?,
 ?dst_v_chr_pos : int?, ?dst_h_chr_pos : int?, ?sws_dither : int?,
 ?alphablend : int?, ?threads : int?, ?intent : int?, ?sws_backends : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video * ffmpeg.filter.video

Arguments:

• w (of type string?, which defaults to null): Output video width
• width (of type string?, which defaults to null): Output video width
• h (of type string?, which defaults to null): Output video height
• height (of type string?, which defaults to null): Output video height
• flags (of type string?, which defaults to null): Flags to pass to libswscale. (default: )
• interl (of type bool?, which defaults to null): set interlacing. (default: false)
• size (of type string?, which defaults to null): set video size
• s (of type string?, which defaults to null): set video size
• in_color_matrix (of type int?, which defaults to null): set input YCbCr type. (default: -1, possible values: -1 (auto), 5 (bt601), 5 (bt470), 5 (smpte170m), 5 (bt470bg), 1 (bt709), 4 (fcc), 7 (smpte240m), 9 (bt2020), 9 (bt2020nc))
• out_color_matrix (of type int?, which defaults to null): set output YCbCr type. (default: 2, possible values: -1 (auto), 5 (bt601), 5 (bt470), 5 (smpte170m), 5 (bt470bg), 1 (bt709), 4 (fcc), 7 (smpte240m), 9 (bt2020), 9 (bt2020nc))
• in_range (of type int?, which defaults to null): set input color range. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (full), 1 (limited), 2 (jpeg), 1 (mpeg), 1 (tv), 2 (pc))
• out_range (of type int?, which defaults to null): set output color range. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (full), 1 (limited), 2 (jpeg), 1 (mpeg), 1 (tv), 2 (pc))
• in_chroma_loc (of type int?, which defaults to null): set input chroma sample location. (default: 0, possible values: 0 (auto), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• out_chroma_loc (of type int?, which defaults to null): set output chroma sample location. (default: 0, possible values: 0 (auto), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• in_primaries (of type int?, which defaults to null): set input primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213))
• out_primaries (of type int?, which defaults to null): set output primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213))
• in_transfer (of type int?, which defaults to null): set output color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (iec61966-2-1), 13 (srgb), 11 (iec61966-2-4), 11 (xvycc), 12 (bt1361e), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67))
• out_transfer (of type int?, which defaults to null): set output color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (iec61966-2-1), 13 (srgb), 11 (iec61966-2-4), 11 (xvycc), 12 (bt1361e), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67))
• in_v_chr_pos (of type int?, which defaults to null): input vertical chroma position in luma grid/256. (default: -513)
• in_h_chr_pos (of type int?, which defaults to null): input horizontal chroma position in luma grid/256. (default: -513)
• out_v_chr_pos (of type int?, which defaults to null): output vertical chroma position in luma grid/256. (default: -513)
• out_h_chr_pos (of type int?, which defaults to null): output horizontal chroma position in luma grid/256. (default: -513)
• force_original_aspect_ratio (of type int?, which defaults to null): decrease or increase w/h if necessary to keep the original AR. (default: 0, possible values: 0 (disable), 1 (decrease), 2 (increase))
• force_divisible_by (of type int?, which defaults to null): enforce that the output resolution is divisible by a defined integer when force_original_aspect_ratio is used. (default: 1)
• reset_sar (of type bool?, which defaults to null): reset SAR to 1 and scale to square pixels if scaling proportionally. (default: false)
• param0 (of type float?, which defaults to null): Scaler param 0. (default: 1.7976931348623157e+308)
• param1 (of type float?, which defaults to null): Scaler param 1. (default: 1.7976931348623157e+308)
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• sws_flags (of type int?, which defaults to null): swscale flags. (default: 4, possible values: 1 (fast_bilinear), 2 (bilinear), 4 (bicubic), 8 (experimental), 16 (neighbor), 32 (area), 64 (bicublin), 128 (gauss), 256 (sinc), 512 (lanczos), 1024 (spline), 4096 (print_info), 262144 (accurate_rnd), 8192 (full_chroma_int), 16384 (full_chroma_inp), 524288 (bitexact), 8388608 (error_diffusion), 1048576 (unstable), 2048 (strict), combined by addition)
• scaler (of type int?, which defaults to null): set scaling algorithm. (default: 0, possible values: 0 (auto), 1 (bilinear), 2 (bicubic), 3 (point), 3 (neighbor), 4 (area), 5 (gaussian), 6 (sinc), 7 (lanczos), 8 (spline))
• scaler_sub (of type int?, which defaults to null): set subsampling algorithm. (default: 0, possible values: 0 (auto), 1 (bilinear), 2 (bicubic), 3 (point), 3 (neighbor), 4 (area), 5 (gaussian), 6 (sinc), 7 (lanczos), 8 (spline))
• srcw (of type int?, which defaults to null): source width. (default: 16)
• srch (of type int?, which defaults to null): source height. (default: 16)
• dstw (of type int?, which defaults to null): destination width. (default: 16)
• dsth (of type int?, which defaults to null): destination height. (default: 16)
• src_format (of type string?, which defaults to null): source format. (default: yuv420p)
• dst_format (of type string?, which defaults to null): destination format. (default: yuv420p)
• src_range (of type bool?, which defaults to null): source is full range. (default: false)
• dst_range (of type bool?, which defaults to null): destination is full range. (default: false)
• gamma (of type bool?, which defaults to null): gamma correct scaling. (default: false)
• src_v_chr_pos (of type int?, which defaults to null): source vertical chroma position in luma grid/256. (default: -513)
• src_h_chr_pos (of type int?, which defaults to null): source horizontal chroma position in luma grid/256. (default: -513)
• dst_v_chr_pos (of type int?, which defaults to null): destination vertical chroma position in luma grid/256. (default: -513)
• dst_h_chr_pos (of type int?, which defaults to null): destination horizontal chroma position in luma grid/256. (default: -513)
• sws_dither (of type int?, which defaults to null): set dithering algorithm. (default: 1, possible values: 1 (auto), 0 (none), 2 (bayer), 3 (ed), 4 (a_dither), 5 (x_dither))
• alphablend (of type int?, which defaults to null): mode for alpha -> non alpha. (default: 0, possible values: 0 (none), 1 (uniform_color), 2 (checkerboard))
• threads (of type int?, which defaults to null): number of threads. (default: 1, possible values: 0 (auto))
• intent (of type int?, which defaults to null): color mapping intent. (default: 1, possible values: 0 (perceptual), 1 (relative_colorimetric), 2 (saturation), 3 (absolute_colorimetric))
• sws_backends (of type int?, which defaults to null): set allowed swscale backends. (default: 0, possible values: 0 (auto), 1 (stable), 62 (unstable), 63 (all), 1 (legacy), 2 (c), 4 (memcpy), 8 (x86), 16 (aarch64), 32 (spirv), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.scale2ref.create

Ffmpeg filter: Scale the input video size and/or convert the image format to the given reference. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?w : string?, ?width : string?, ?h : string?, ?height : string?,
 ?flags : string?, ?interl : bool?, ?size : string?, ?s : string?,
 ?in_color_matrix : int?, ?out_color_matrix : int?, ?in_range : int?,
 ?out_range : int?, ?in_chroma_loc : int?, ?out_chroma_loc : int?,
 ?in_primaries : int?, ?out_primaries : int?, ?in_transfer : int?,
 ?out_transfer : int?, ?in_v_chr_pos : int?, ?in_h_chr_pos : int?,
 ?out_v_chr_pos : int?, ?out_h_chr_pos : int?,
 ?force_original_aspect_ratio : int?, ?force_divisible_by : int?,
 ?reset_sar : bool?, ?param0 : float?, ?param1 : float?, ?eval : int?,
 ?sws_flags : int?, ?scaler : int?, ?scaler_sub : int?, ?srcw : int?,
 ?srch : int?, ?dstw : int?, ?dsth : int?, ?src_format : string?,
 ?dst_format : string?, ?src_range : bool?, ?dst_range : bool?,
 ?gamma : bool?, ?src_v_chr_pos : int?, ?src_h_chr_pos : int?,
 ?dst_v_chr_pos : int?, ?dst_h_chr_pos : int?, ?sws_dither : int?,
 ?alphablend : int?, ?threads : int?, ?intent : int?, ?sws_backends : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• w (of type string?, which defaults to null): Output video width
• width (of type string?, which defaults to null): Output video width
• h (of type string?, which defaults to null): Output video height
• height (of type string?, which defaults to null): Output video height
• flags (of type string?, which defaults to null): Flags to pass to libswscale. (default: )
• interl (of type bool?, which defaults to null): set interlacing. (default: false)
• size (of type string?, which defaults to null): set video size
• s (of type string?, which defaults to null): set video size
• in_color_matrix (of type int?, which defaults to null): set input YCbCr type. (default: -1, possible values: -1 (auto), 5 (bt601), 5 (bt470), 5 (smpte170m), 5 (bt470bg), 1 (bt709), 4 (fcc), 7 (smpte240m), 9 (bt2020), 9 (bt2020nc))
• out_color_matrix (of type int?, which defaults to null): set output YCbCr type. (default: 2, possible values: -1 (auto), 5 (bt601), 5 (bt470), 5 (smpte170m), 5 (bt470bg), 1 (bt709), 4 (fcc), 7 (smpte240m), 9 (bt2020), 9 (bt2020nc))
• in_range (of type int?, which defaults to null): set input color range. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (full), 1 (limited), 2 (jpeg), 1 (mpeg), 1 (tv), 2 (pc))
• out_range (of type int?, which defaults to null): set output color range. (default: 0, possible values: 0 (auto), 0 (unknown), 2 (full), 1 (limited), 2 (jpeg), 1 (mpeg), 1 (tv), 2 (pc))
• in_chroma_loc (of type int?, which defaults to null): set input chroma sample location. (default: 0, possible values: 0 (auto), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• out_chroma_loc (of type int?, which defaults to null): set output chroma sample location. (default: 0, possible values: 0 (auto), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• in_primaries (of type int?, which defaults to null): set input primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213))
• out_primaries (of type int?, which defaults to null): set output primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213))
• in_transfer (of type int?, which defaults to null): set output color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (iec61966-2-1), 13 (srgb), 11 (iec61966-2-4), 11 (xvycc), 12 (bt1361e), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67))
• out_transfer (of type int?, which defaults to null): set output color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 4 (bt470m), 4 (gamma22), 5 (bt470bg), 5 (gamma28), 6 (smpte170m), 7 (smpte240m), 8 (linear), 13 (iec61966-2-1), 13 (srgb), 11 (iec61966-2-4), 11 (xvycc), 12 (bt1361e), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67))
• in_v_chr_pos (of type int?, which defaults to null): input vertical chroma position in luma grid/256. (default: -513)
• in_h_chr_pos (of type int?, which defaults to null): input horizontal chroma position in luma grid/256. (default: -513)
• out_v_chr_pos (of type int?, which defaults to null): output vertical chroma position in luma grid/256. (default: -513)
• out_h_chr_pos (of type int?, which defaults to null): output horizontal chroma position in luma grid/256. (default: -513)
• force_original_aspect_ratio (of type int?, which defaults to null): decrease or increase w/h if necessary to keep the original AR. (default: 0, possible values: 0 (disable), 1 (decrease), 2 (increase))
• force_divisible_by (of type int?, which defaults to null): enforce that the output resolution is divisible by a defined integer when force_original_aspect_ratio is used. (default: 1)
• reset_sar (of type bool?, which defaults to null): reset SAR to 1 and scale to square pixels if scaling proportionally. (default: false)
• param0 (of type float?, which defaults to null): Scaler param 0. (default: 1.7976931348623157e+308)
• param1 (of type float?, which defaults to null): Scaler param 1. (default: 1.7976931348623157e+308)
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• sws_flags (of type int?, which defaults to null): swscale flags. (default: 4, possible values: 1 (fast_bilinear), 2 (bilinear), 4 (bicubic), 8 (experimental), 16 (neighbor), 32 (area), 64 (bicublin), 128 (gauss), 256 (sinc), 512 (lanczos), 1024 (spline), 4096 (print_info), 262144 (accurate_rnd), 8192 (full_chroma_int), 16384 (full_chroma_inp), 524288 (bitexact), 8388608 (error_diffusion), 1048576 (unstable), 2048 (strict), combined by addition)
• scaler (of type int?, which defaults to null): set scaling algorithm. (default: 0, possible values: 0 (auto), 1 (bilinear), 2 (bicubic), 3 (point), 3 (neighbor), 4 (area), 5 (gaussian), 6 (sinc), 7 (lanczos), 8 (spline))
• scaler_sub (of type int?, which defaults to null): set subsampling algorithm. (default: 0, possible values: 0 (auto), 1 (bilinear), 2 (bicubic), 3 (point), 3 (neighbor), 4 (area), 5 (gaussian), 6 (sinc), 7 (lanczos), 8 (spline))
• srcw (of type int?, which defaults to null): source width. (default: 16)
• srch (of type int?, which defaults to null): source height. (default: 16)
• dstw (of type int?, which defaults to null): destination width. (default: 16)
• dsth (of type int?, which defaults to null): destination height. (default: 16)
• src_format (of type string?, which defaults to null): source format. (default: yuv420p)
• dst_format (of type string?, which defaults to null): destination format. (default: yuv420p)
• src_range (of type bool?, which defaults to null): source is full range. (default: false)
• dst_range (of type bool?, which defaults to null): destination is full range. (default: false)
• gamma (of type bool?, which defaults to null): gamma correct scaling. (default: false)
• src_v_chr_pos (of type int?, which defaults to null): source vertical chroma position in luma grid/256. (default: -513)
• src_h_chr_pos (of type int?, which defaults to null): source horizontal chroma position in luma grid/256. (default: -513)
• dst_v_chr_pos (of type int?, which defaults to null): destination vertical chroma position in luma grid/256. (default: -513)
• dst_h_chr_pos (of type int?, which defaults to null): destination horizontal chroma position in luma grid/256. (default: -513)
• sws_dither (of type int?, which defaults to null): set dithering algorithm. (default: 1, possible values: 1 (auto), 0 (none), 2 (bayer), 3 (ed), 4 (a_dither), 5 (x_dither))
• alphablend (of type int?, which defaults to null): mode for alpha -> non alpha. (default: 0, possible values: 0 (none), 1 (uniform_color), 2 (checkerboard))
• threads (of type int?, which defaults to null): number of threads. (default: 1, possible values: 0 (auto))
• intent (of type int?, which defaults to null): color mapping intent. (default: 1, possible values: 0 (perceptual), 1 (relative_colorimetric), 2 (saturation), 3 (absolute_colorimetric))
• sws_backends (of type int?, which defaults to null): set allowed swscale backends. (default: 0, possible values: 0 (auto), 1 (stable), 62 (unstable), 63 (all), 1 (legacy), 2 (c), 4 (memcpy), 8 (x86), 16 (aarch64), 32 (spirv), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video * ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.scdet

Ffmpeg filter: Detect video scene change.

Type:

(?threshold : float?, ?t : float?, ?sc_pass : bool?, ?s : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• threshold (of type float?, which defaults to null): set scene change detect threshold. (default: 10)
• t (of type float?, which defaults to null): set scene change detect threshold. (default: 10)
• sc_pass (of type bool?, which defaults to null): Set the flag to pass scene change frames. (default: false)
• s (of type bool?, which defaults to null): Set the flag to pass scene change frames. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.scdet.create

Ffmpeg filter: Detect video scene change. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold : float?, ?t : float?, ?sc_pass : bool?, ?s : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• threshold (of type float?, which defaults to null): set scene change detect threshold. (default: 10)
• t (of type float?, which defaults to null): set scene change detect threshold. (default: 10)
• sc_pass (of type bool?, which defaults to null): Set the flag to pass scene change frames. (default: false)
• s (of type bool?, which defaults to null): Set the flag to pass scene change frames. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.scharr

Ffmpeg filter: Apply scharr operator.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.scharr.create

Ffmpeg filter: Apply scharr operator. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.scroll

Ffmpeg filter: Scroll input video.

Type:

(?horizontal : float?, ?h : float?, ?vertical : float?, ?v : float?,
 ?hpos : float?, ?vpos : float?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• horizontal (of type float?, which defaults to null): set the horizontal scrolling speed. (default: 0)
• h (of type float?, which defaults to null): set the horizontal scrolling speed. (default: 0)
• vertical (of type float?, which defaults to null): set the vertical scrolling speed. (default: 0)
• v (of type float?, which defaults to null): set the vertical scrolling speed. (default: 0)
• hpos (of type float?, which defaults to null): set initial horizontal position. (default: 0)
• vpos (of type float?, which defaults to null): set initial vertical position. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.scroll.create

Ffmpeg filter: Scroll input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?horizontal : float?, ?h : float?, ?vertical : float?, ?v : float?,
 ?hpos : float?, ?vpos : float?, ffmpeg.filter.graph) -> unit

Arguments:

• horizontal (of type float?, which defaults to null): set the horizontal scrolling speed. (default: 0)
• h (of type float?, which defaults to null): set the horizontal scrolling speed. (default: 0)
• vertical (of type float?, which defaults to null): set the vertical scrolling speed. (default: 0)
• v (of type float?, which defaults to null): set the vertical scrolling speed. (default: 0)
• hpos (of type float?, which defaults to null): set initial horizontal position. (default: 0)
• vpos (of type float?, which defaults to null): set initial vertical position. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.segment

Ffmpeg filter: Segment video stream. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?timestamps : string?, ?frames : string?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> [ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• timestamps (of type string?, which defaults to null): timestamps of input at which to split input
• frames (of type string?, which defaults to null): frames at which to split input
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.segment.create

Ffmpeg filter: Segment video stream. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?timestamps : string?, ?frames : string?, ffmpeg.filter.graph) -> unit

Arguments:

• timestamps (of type string?, which defaults to null): timestamps of input at which to split input
• frames (of type string?, which defaults to null): frames at which to split input
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.select

Ffmpeg filter: Select video frames to pass in output. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?expr : string?, ?e : string?, ?outputs : int?, ?n : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• expr (of type string?, which defaults to null): set an expression to use for selecting frames. (default: 1)
• e (of type string?, which defaults to null): set an expression to use for selecting frames. (default: 1)
• outputs (of type int?, which defaults to null): set the number of outputs. (default: 1)
• n (of type int?, which defaults to null): set the number of outputs. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.select.create

Ffmpeg filter: Select video frames to pass in output. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?expr : string?, ?e : string?, ?outputs : int?, ?n : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• expr (of type string?, which defaults to null): set an expression to use for selecting frames. (default: 1)
• e (of type string?, which defaults to null): set an expression to use for selecting frames. (default: 1)
• outputs (of type int?, which defaults to null): set the number of outputs. (default: 1)
• n (of type int?, which defaults to null): set the number of outputs. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.selectivecolor

Ffmpeg filter: Apply CMYK adjustments to specific color ranges.

Type:

(?correction_method : int?, ?reds : string?, ?yellows : string?,
 ?greens : string?, ?cyans : string?, ?blues : string?, ?magentas : string?,
 ?whites : string?, ?neutrals : string?, ?blacks : string?,
 ?psfile : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• correction_method (of type int?, which defaults to null): select correction method. (default: 0, possible values: 0 (absolute), 1 (relative))
• reds (of type string?, which defaults to null): adjust red regions
• yellows (of type string?, which defaults to null): adjust yellow regions
• greens (of type string?, which defaults to null): adjust green regions
• cyans (of type string?, which defaults to null): adjust cyan regions
• blues (of type string?, which defaults to null): adjust blue regions
• magentas (of type string?, which defaults to null): adjust magenta regions
• whites (of type string?, which defaults to null): adjust white regions
• neutrals (of type string?, which defaults to null): adjust neutral regions
• blacks (of type string?, which defaults to null): adjust black regions
• psfile (of type string?, which defaults to null): set Photoshop selectivecolor file name
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.selectivecolor.create

Ffmpeg filter: Apply CMYK adjustments to specific color ranges. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?correction_method : int?, ?reds : string?, ?yellows : string?,
 ?greens : string?, ?cyans : string?, ?blues : string?, ?magentas : string?,
 ?whites : string?, ?neutrals : string?, ?blacks : string?,
 ?psfile : string?, ffmpeg.filter.graph) -> unit

Arguments:

• correction_method (of type int?, which defaults to null): select correction method. (default: 0, possible values: 0 (absolute), 1 (relative))
• reds (of type string?, which defaults to null): adjust red regions
• yellows (of type string?, which defaults to null): adjust yellow regions
• greens (of type string?, which defaults to null): adjust green regions
• cyans (of type string?, which defaults to null): adjust cyan regions
• blues (of type string?, which defaults to null): adjust blue regions
• magentas (of type string?, which defaults to null): adjust magenta regions
• whites (of type string?, which defaults to null): adjust white regions
• neutrals (of type string?, which defaults to null): adjust neutral regions
• blacks (of type string?, which defaults to null): adjust black regions
• psfile (of type string?, which defaults to null): set Photoshop selectivecolor file name
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sendcmd

Ffmpeg filter: Send commands to filters.

Type:

(?commands : string?, ?c : string?, ?filename : string?, ?f : string?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• commands (of type string?, which defaults to null): set commands
• c (of type string?, which defaults to null): set commands
• filename (of type string?, which defaults to null): set commands file
• f (of type string?, which defaults to null): set commands file
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.sendcmd.create

Ffmpeg filter: Send commands to filters. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?commands : string?, ?c : string?, ?filename : string?, ?f : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• commands (of type string?, which defaults to null): set commands
• c (of type string?, which defaults to null): set commands
• filename (of type string?, which defaults to null): set commands file
• f (of type string?, which defaults to null): set commands file
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.separatefields

Ffmpeg filter: Split input video frames into fields.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.separatefields.create

Ffmpeg filter: Split input video frames into fields. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.setdar

Ffmpeg filter: Set the frame display aspect ratio.

Type:

(?dar : string?, ?ratio : string?, ?r : string?, ?max : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• dar (of type string?, which defaults to null): set display aspect ratio. (default: 0)
• ratio (of type string?, which defaults to null): set display aspect ratio. (default: 0)
• r (of type string?, which defaults to null): set display aspect ratio. (default: 0)
• max (of type int?, which defaults to null): set max value for nominator or denominator in the ratio. (default: 100)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.setdar.create

Ffmpeg filter: Set the frame display aspect ratio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?dar : string?, ?ratio : string?, ?r : string?, ?max : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• dar (of type string?, which defaults to null): set display aspect ratio. (default: 0)
• ratio (of type string?, which defaults to null): set display aspect ratio. (default: 0)
• r (of type string?, which defaults to null): set display aspect ratio. (default: 0)
• max (of type int?, which defaults to null): set max value for nominator or denominator in the ratio. (default: 100)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.setfield

Ffmpeg filter: Force field for the output video frame.

Type:

(?mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): select interlace mode. (default: -1, possible values: -1 (auto), 0 (bff), 1 (tff), 2 (prog))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.setfield.create

Ffmpeg filter: Force field for the output video frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): select interlace mode. (default: -1, possible values: -1 (auto), 0 (bff), 1 (tff), 2 (prog))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.setparams

Ffmpeg filter: Force field, or color property for the output video frame.

Type:

(?field_mode : int?, ?range : int?, ?color_primaries : int?,
 ?color_trc : int?, ?colorspace : int?, ?chroma_location : int?,
 ?alpha_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• field_mode (of type int?, which defaults to null): select interlace mode. (default: -1, possible values: -1 (auto), 0 (bff), 1 (tff), 2 (prog))
• range (of type int?, which defaults to null): select color range. (default: -1, possible values: -1 (auto), 0 (unspecified), 0 (unknown), 1 (limited), 1 (tv), 1 (mpeg), 2 (full), 2 (pc), 2 (jpeg))
• color_primaries (of type int?, which defaults to null): select color primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 2 (unknown), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213), 256 (vgamut))
• color_trc (of type int?, which defaults to null): select color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 2 (unknown), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (linear), 9 (log100), 10 (log316), 11 (iec61966-2-4), 12 (bt1361e), 13 (iec61966-2-1), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67), 256 (vlog))
• colorspace (of type int?, which defaults to null): select colorspace. (default: -1, possible values: -1 (auto), 0 (gbr), 1 (bt709), 2 (unknown), 4 (fcc), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (ycgco), 16 (ycgco-re), 17 (ycgco-ro), 9 (bt2020nc), 10 (bt2020c), 11 (smpte2085), 12 (chroma-derived-nc), 13 (chroma-derived-c), 14 (ictcp), 15 (ipt-c2))
• chroma_location (of type int?, which defaults to null): select chroma sample location. (default: -1, possible values: -1 (auto), 0 (unspecified), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• alpha_mode (of type int?, which defaults to null): select alpha moda. (default: -1, possible values: -1 (auto), 0 (unspecified), 0 (unknown), 1 (premultiplied), 2 (straight))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.setparams.create

Ffmpeg filter: Force field, or color property for the output video frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?field_mode : int?, ?range : int?, ?color_primaries : int?,
 ?color_trc : int?, ?colorspace : int?, ?chroma_location : int?,
 ?alpha_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• field_mode (of type int?, which defaults to null): select interlace mode. (default: -1, possible values: -1 (auto), 0 (bff), 1 (tff), 2 (prog))
• range (of type int?, which defaults to null): select color range. (default: -1, possible values: -1 (auto), 0 (unspecified), 0 (unknown), 1 (limited), 1 (tv), 1 (mpeg), 2 (full), 2 (pc), 2 (jpeg))
• color_primaries (of type int?, which defaults to null): select color primaries. (default: -1, possible values: -1 (auto), 1 (bt709), 2 (unknown), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (film), 9 (bt2020), 10 (smpte428), 11 (smpte431), 12 (smpte432), 22 (jedec-p22), 22 (ebu3213), 256 (vgamut))
• color_trc (of type int?, which defaults to null): select color transfer. (default: -1, possible values: -1 (auto), 1 (bt709), 2 (unknown), 4 (bt470m), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (linear), 9 (log100), 10 (log316), 11 (iec61966-2-4), 12 (bt1361e), 13 (iec61966-2-1), 14 (bt2020-10), 15 (bt2020-12), 16 (smpte2084), 17 (smpte428), 18 (arib-std-b67), 256 (vlog))
• colorspace (of type int?, which defaults to null): select colorspace. (default: -1, possible values: -1 (auto), 0 (gbr), 1 (bt709), 2 (unknown), 4 (fcc), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 8 (ycgco), 16 (ycgco-re), 17 (ycgco-ro), 9 (bt2020nc), 10 (bt2020c), 11 (smpte2085), 12 (chroma-derived-nc), 13 (chroma-derived-c), 14 (ictcp), 15 (ipt-c2))
• chroma_location (of type int?, which defaults to null): select chroma sample location. (default: -1, possible values: -1 (auto), 0 (unspecified), 0 (unknown), 1 (left), 2 (center), 3 (topleft), 4 (top), 5 (bottomleft), 6 (bottom))
• alpha_mode (of type int?, which defaults to null): select alpha moda. (default: -1, possible values: -1 (auto), 0 (unspecified), 0 (unknown), 1 (premultiplied), 2 (straight))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.setpts

Ffmpeg filter: Set PTS for the output video frame.

Type:

(?expr : string?, ?strip_fps : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• expr (of type string?, which defaults to null): Expression determining the frame timestamp. (default: PTS)
• strip_fps (of type bool?, which defaults to null): Unset framerate metadata. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.setpts.create

Ffmpeg filter: Set PTS for the output video frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?expr : string?, ?strip_fps : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• expr (of type string?, which defaults to null): Expression determining the frame timestamp. (default: PTS)
• strip_fps (of type bool?, which defaults to null): Unset framerate metadata. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.setrange

Ffmpeg filter: Force color range for the output video frame.

Type:

(?range : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• range (of type int?, which defaults to null): select color range. (default: -1, possible values: -1 (auto), 0 (unspecified), 0 (unknown), 1 (limited), 1 (tv), 1 (mpeg), 2 (full), 2 (pc), 2 (jpeg))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.setrange.create

Ffmpeg filter: Force color range for the output video frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?range : int?, ffmpeg.filter.graph) -> unit

Arguments:

• range (of type int?, which defaults to null): select color range. (default: -1, possible values: -1 (auto), 0 (unspecified), 0 (unknown), 1 (limited), 1 (tv), 1 (mpeg), 2 (full), 2 (pc), 2 (jpeg))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.setsar

Ffmpeg filter: Set the pixel sample aspect ratio.

Type:

(?sar : string?, ?ratio : string?, ?r : string?, ?max : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• sar (of type string?, which defaults to null): set sample (pixel) aspect ratio. (default: 0)
• ratio (of type string?, which defaults to null): set sample (pixel) aspect ratio. (default: 0)
• r (of type string?, which defaults to null): set sample (pixel) aspect ratio. (default: 0)
• max (of type int?, which defaults to null): set max value for nominator or denominator in the ratio. (default: 100)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.setsar.create

Ffmpeg filter: Set the pixel sample aspect ratio. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sar : string?, ?ratio : string?, ?r : string?, ?max : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• sar (of type string?, which defaults to null): set sample (pixel) aspect ratio. (default: 0)
• ratio (of type string?, which defaults to null): set sample (pixel) aspect ratio. (default: 0)
• r (of type string?, which defaults to null): set sample (pixel) aspect ratio. (default: 0)
• max (of type int?, which defaults to null): set max value for nominator or denominator in the ratio. (default: 100)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.settb

Ffmpeg filter: Set timebase for the video output link.

Type:

(?expr : string?, ?tb : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• expr (of type string?, which defaults to null): set expression determining the output timebase. (default: intb)
• tb (of type string?, which defaults to null): set expression determining the output timebase. (default: intb)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.settb.create

Ffmpeg filter: Set timebase for the video output link. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?expr : string?, ?tb : string?, ffmpeg.filter.graph) -> unit

Arguments:

• expr (of type string?, which defaults to null): set expression determining the output timebase. (default: intb)
• tb (of type string?, which defaults to null): set expression determining the output timebase. (default: intb)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.shear

Ffmpeg filter: Shear transform the input image.

Type:

(?shx : float?, ?shy : float?, ?fillcolor : string?, ?c : string?,
 ?interp : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• shx (of type float?, which defaults to null): set x shear factor. (default: 0)
• shy (of type float?, which defaults to null): set y shear factor. (default: 0)
• fillcolor (of type string?, which defaults to null): set background fill color. (default: black)
• c (of type string?, which defaults to null): set background fill color. (default: black)
• interp (of type int?, which defaults to null): set interpolation. (default: 1, possible values: 0 (nearest), 1 (bilinear))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.shear.create

Ffmpeg filter: Shear transform the input image. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?shx : float?, ?shy : float?, ?fillcolor : string?, ?c : string?,
 ?interp : int?, ffmpeg.filter.graph) -> unit

Arguments:

• shx (of type float?, which defaults to null): set x shear factor. (default: 0)
• shy (of type float?, which defaults to null): set y shear factor. (default: 0)
• fillcolor (of type string?, which defaults to null): set background fill color. (default: black)
• c (of type string?, which defaults to null): set background fill color. (default: black)
• interp (of type int?, which defaults to null): set interpolation. (default: 1, possible values: 0 (nearest), 1 (bilinear))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showcqt

Ffmpeg filter: Convert input audio to a CQT (Constant/Clamped Q Transform) spectrum video output.

Type:

(?size : string?, ?s : string?, ?fps : string?, ?rate : string?,
 ?r : string?, ?bar_h : int?, ?axis_h : int?, ?sono_h : int?,
 ?fullhd : bool?, ?sono_v : string?, ?volume : string?, ?bar_v : string?,
 ?volume2 : string?, ?sono_g : float?, ?gamma : float?, ?bar_g : float?,
 ?gamma2 : float?, ?bar_t : float?, ?timeclamp : float?, ?tc : float?,
 ?attack : float?, ?basefreq : float?, ?endfreq : float?,
 ?coeffclamp : float?, ?tlength : string?, ?count : int?, ?fcount : int?,
 ?fontfile : string?, ?font : string?, ?fontcolor : string?,
 ?axisfile : string?, ?axis : bool?, ?text : bool?, ?csp : int?,
 ?cscheme : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 1920x1080)
• s (of type string?, which defaults to null): set video size. (default: 1920x1080)
• fps (of type string?, which defaults to null): set video rate. (default: 25)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• bar_h (of type int?, which defaults to null): set bargraph height. (default: -1)
• axis_h (of type int?, which defaults to null): set axis height. (default: -1)
• sono_h (of type int?, which defaults to null): set sonogram height. (default: -1)
• fullhd (of type bool?, which defaults to null): set fullhd size. (default: true)
• sono_v (of type string?, which defaults to null): set sonogram volume. (default: 16)
• volume (of type string?, which defaults to null): set sonogram volume. (default: 16)
• bar_v (of type string?, which defaults to null): set bargraph volume. (default: sono_v)
• volume2 (of type string?, which defaults to null): set bargraph volume. (default: sono_v)
• sono_g (of type float?, which defaults to null): set sonogram gamma. (default: 3)
• gamma (of type float?, which defaults to null): set sonogram gamma. (default: 3)
• bar_g (of type float?, which defaults to null): set bargraph gamma. (default: 1)
• gamma2 (of type float?, which defaults to null): set bargraph gamma. (default: 1)
• bar_t (of type float?, which defaults to null): set bar transparency. (default: 1)
• timeclamp (of type float?, which defaults to null): set timeclamp. (default: 0.17)
• tc (of type float?, which defaults to null): set timeclamp. (default: 0.17)
• attack (of type float?, which defaults to null): set attack time. (default: 0)
• basefreq (of type float?, which defaults to null): set base frequency. (default: 20.015231264080075)
• endfreq (of type float?, which defaults to null): set end frequency. (default: 20495.596814417997)
• coeffclamp (of type float?, which defaults to null): set coeffclamp. (default: 1)
• tlength (of type string?, which defaults to null): set tlength. (default: 384tc/(384+tcf))
• count (of type int?, which defaults to null): set transform count. (default: 6)
• fcount (of type int?, which defaults to null): set frequency count. (default: 0)
• fontfile (of type string?, which defaults to null): set axis font file
• font (of type string?, which defaults to null): set axis font
• fontcolor (of type string?, which defaults to null): set font color. (default: st(0, (midi(f)-59.5)/12);st(1, if(between(ld(0),0,1), 0.5-0.5cos(2PI*ld(0)), 0));r(1-ld(1)) + b(ld(1)))
• axisfile (of type string?, which defaults to null): set axis image
• axis (of type bool?, which defaults to null): draw axis. (default: true)
• text (of type bool?, which defaults to null): draw axis. (default: true)
• csp (of type int?, which defaults to null): set color space. (default: 2, possible values: 2 (unspecified), 1 (bt709), 4 (fcc), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 9 (bt2020ncl))
• cscheme (of type string?, which defaults to null): set color scheme. (default: 1|0.5|0|0|0.5|1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showcqt.create

Ffmpeg filter: Convert input audio to a CQT (Constant/Clamped Q Transform) spectrum video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?fps : string?, ?rate : string?,
 ?r : string?, ?bar_h : int?, ?axis_h : int?, ?sono_h : int?,
 ?fullhd : bool?, ?sono_v : string?, ?volume : string?, ?bar_v : string?,
 ?volume2 : string?, ?sono_g : float?, ?gamma : float?, ?bar_g : float?,
 ?gamma2 : float?, ?bar_t : float?, ?timeclamp : float?, ?tc : float?,
 ?attack : float?, ?basefreq : float?, ?endfreq : float?,
 ?coeffclamp : float?, ?tlength : string?, ?count : int?, ?fcount : int?,
 ?fontfile : string?, ?font : string?, ?fontcolor : string?,
 ?axisfile : string?, ?axis : bool?, ?text : bool?, ?csp : int?,
 ?cscheme : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 1920x1080)
• s (of type string?, which defaults to null): set video size. (default: 1920x1080)
• fps (of type string?, which defaults to null): set video rate. (default: 25)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• bar_h (of type int?, which defaults to null): set bargraph height. (default: -1)
• axis_h (of type int?, which defaults to null): set axis height. (default: -1)
• sono_h (of type int?, which defaults to null): set sonogram height. (default: -1)
• fullhd (of type bool?, which defaults to null): set fullhd size. (default: true)
• sono_v (of type string?, which defaults to null): set sonogram volume. (default: 16)
• volume (of type string?, which defaults to null): set sonogram volume. (default: 16)
• bar_v (of type string?, which defaults to null): set bargraph volume. (default: sono_v)
• volume2 (of type string?, which defaults to null): set bargraph volume. (default: sono_v)
• sono_g (of type float?, which defaults to null): set sonogram gamma. (default: 3)
• gamma (of type float?, which defaults to null): set sonogram gamma. (default: 3)
• bar_g (of type float?, which defaults to null): set bargraph gamma. (default: 1)
• gamma2 (of type float?, which defaults to null): set bargraph gamma. (default: 1)
• bar_t (of type float?, which defaults to null): set bar transparency. (default: 1)
• timeclamp (of type float?, which defaults to null): set timeclamp. (default: 0.17)
• tc (of type float?, which defaults to null): set timeclamp. (default: 0.17)
• attack (of type float?, which defaults to null): set attack time. (default: 0)
• basefreq (of type float?, which defaults to null): set base frequency. (default: 20.015231264080075)
• endfreq (of type float?, which defaults to null): set end frequency. (default: 20495.596814417997)
• coeffclamp (of type float?, which defaults to null): set coeffclamp. (default: 1)
• tlength (of type string?, which defaults to null): set tlength. (default: 384tc/(384+tcf))
• count (of type int?, which defaults to null): set transform count. (default: 6)
• fcount (of type int?, which defaults to null): set frequency count. (default: 0)
• fontfile (of type string?, which defaults to null): set axis font file
• font (of type string?, which defaults to null): set axis font
• fontcolor (of type string?, which defaults to null): set font color. (default: st(0, (midi(f)-59.5)/12);st(1, if(between(ld(0),0,1), 0.5-0.5cos(2PI*ld(0)), 0));r(1-ld(1)) + b(ld(1)))
• axisfile (of type string?, which defaults to null): set axis image
• axis (of type bool?, which defaults to null): draw axis. (default: true)
• text (of type bool?, which defaults to null): draw axis. (default: true)
• csp (of type int?, which defaults to null): set color space. (default: 2, possible values: 2 (unspecified), 1 (bt709), 4 (fcc), 5 (bt470bg), 6 (smpte170m), 7 (smpte240m), 9 (bt2020ncl))
• cscheme (of type string?, which defaults to null): set color scheme. (default: 1|0.5|0|0|0.5|1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showcwt

Ffmpeg filter: Convert input audio to a CWT (Continuous Wavelet Transform) spectrum video output.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?, ?scale : int?,
 ?iscale : int?, ?min : float?, ?max : float?, ?imin : float?,
 ?imax : float?, ?logb : float?, ?deviation : float?, ?pps : int?,
 ?mode : int?, ?slide : int?, ?direction : int?, ?bar : float?,
 ?rotation : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 640x512)
• s (of type string?, which defaults to null): set video size. (default: 640x512)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• scale (of type int?, which defaults to null): set frequency scale. (default: 0, possible values: 0 (linear), 1 (log), 2 (bark), 3 (mel), 4 (erbs), 5 (sqrt), 6 (cbrt), 7 (qdrt), 8 (fm))
• iscale (of type int?, which defaults to null): set intensity scale. (default: 0, possible values: 1 (linear), 0 (log), 2 (sqrt), 3 (cbrt), 4 (qdrt))
• min (of type float?, which defaults to null): set minimum frequency. (default: 20)
• max (of type float?, which defaults to null): set maximum frequency. (default: 20000)
• imin (of type float?, which defaults to null): set minimum intensity. (default: 0)
• imax (of type float?, which defaults to null): set maximum intensity. (default: 1)
• logb (of type float?, which defaults to null): set logarithmic basis. (default: 0.0001)
• deviation (of type float?, which defaults to null): set frequency deviation. (default: 1)
• pps (of type int?, which defaults to null): set pixels per second. (default: 64)
• mode (of type int?, which defaults to null): set output mode. (default: 0, possible values: 0 (magnitude), 1 (phase), 2 (magphase), 3 (channel), 4 (stereo))
• slide (of type int?, which defaults to null): set slide mode. (default: 0, possible values: 0 (replace), 1 (scroll), 2 (frame))
• direction (of type int?, which defaults to null): set direction mode. (default: 0, possible values: 0 (lr), 1 (rl), 2 (ud), 3 (du))
• bar (of type float?, which defaults to null): set bargraph ratio. (default: 0)
• rotation (of type float?, which defaults to null): set color rotation. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showcwt.create

Ffmpeg filter: Convert input audio to a CWT (Continuous Wavelet Transform) spectrum video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?, ?scale : int?,
 ?iscale : int?, ?min : float?, ?max : float?, ?imin : float?,
 ?imax : float?, ?logb : float?, ?deviation : float?, ?pps : int?,
 ?mode : int?, ?slide : int?, ?direction : int?, ?bar : float?,
 ?rotation : float?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 640x512)
• s (of type string?, which defaults to null): set video size. (default: 640x512)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• scale (of type int?, which defaults to null): set frequency scale. (default: 0, possible values: 0 (linear), 1 (log), 2 (bark), 3 (mel), 4 (erbs), 5 (sqrt), 6 (cbrt), 7 (qdrt), 8 (fm))
• iscale (of type int?, which defaults to null): set intensity scale. (default: 0, possible values: 1 (linear), 0 (log), 2 (sqrt), 3 (cbrt), 4 (qdrt))
• min (of type float?, which defaults to null): set minimum frequency. (default: 20)
• max (of type float?, which defaults to null): set maximum frequency. (default: 20000)
• imin (of type float?, which defaults to null): set minimum intensity. (default: 0)
• imax (of type float?, which defaults to null): set maximum intensity. (default: 1)
• logb (of type float?, which defaults to null): set logarithmic basis. (default: 0.0001)
• deviation (of type float?, which defaults to null): set frequency deviation. (default: 1)
• pps (of type int?, which defaults to null): set pixels per second. (default: 64)
• mode (of type int?, which defaults to null): set output mode. (default: 0, possible values: 0 (magnitude), 1 (phase), 2 (magphase), 3 (channel), 4 (stereo))
• slide (of type int?, which defaults to null): set slide mode. (default: 0, possible values: 0 (replace), 1 (scroll), 2 (frame))
• direction (of type int?, which defaults to null): set direction mode. (default: 0, possible values: 0 (lr), 1 (rl), 2 (ud), 3 (du))
• bar (of type float?, which defaults to null): set bargraph ratio. (default: 0)
• rotation (of type float?, which defaults to null): set color rotation. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showfreqs

Ffmpeg filter: Convert input audio to a frequencies video output.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?, ?mode : int?,
 ?ascale : int?, ?fscale : int?, ?win_size : int?, ?win_func : int?,
 ?overlap : float?, ?averaging : int?, ?colors : string?, ?cmode : int?,
 ?minamp : float?, ?data : int?, ?channels : string?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 1024x512)
• s (of type string?, which defaults to null): set video size. (default: 1024x512)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• mode (of type int?, which defaults to null): set display mode. (default: 1, possible values: 0 (line), 1 (bar), 2 (dot))
• ascale (of type int?, which defaults to null): set amplitude scale. (default: 3, possible values: 0 (lin), 1 (sqrt), 2 (cbrt), 3 (log))
• fscale (of type int?, which defaults to null): set frequency scale. (default: 0, possible values: 0 (lin), 1 (log), 2 (rlog))
• win_size (of type int?, which defaults to null): set window size. (default: 2048)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 1)
• averaging (of type int?, which defaults to null): set time averaging. (default: 1)
• colors (of type string?, which defaults to null): set channels colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• cmode (of type int?, which defaults to null): set channel mode. (default: 0, possible values: 0 (combined), 1 (separate))
• minamp (of type float?, which defaults to null): set minimum amplitude. (default: 1e-06)
• data (of type int?, which defaults to null): set data mode. (default: 0, possible values: 0 (magnitude), 1 (phase), 2 (delay))
• channels (of type string?, which defaults to null): set channels to draw. (default: all)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showfreqs.create

Ffmpeg filter: Convert input audio to a frequencies video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?, ?mode : int?,
 ?ascale : int?, ?fscale : int?, ?win_size : int?, ?win_func : int?,
 ?overlap : float?, ?averaging : int?, ?colors : string?, ?cmode : int?,
 ?minamp : float?, ?data : int?, ?channels : string?, ffmpeg.filter.graph) ->
unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 1024x512)
• s (of type string?, which defaults to null): set video size. (default: 1024x512)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• mode (of type int?, which defaults to null): set display mode. (default: 1, possible values: 0 (line), 1 (bar), 2 (dot))
• ascale (of type int?, which defaults to null): set amplitude scale. (default: 3, possible values: 0 (lin), 1 (sqrt), 2 (cbrt), 3 (log))
• fscale (of type int?, which defaults to null): set frequency scale. (default: 0, possible values: 0 (lin), 1 (log), 2 (rlog))
• win_size (of type int?, which defaults to null): set window size. (default: 2048)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 1)
• averaging (of type int?, which defaults to null): set time averaging. (default: 1)
• colors (of type string?, which defaults to null): set channels colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• cmode (of type int?, which defaults to null): set channel mode. (default: 0, possible values: 0 (combined), 1 (separate))
• minamp (of type float?, which defaults to null): set minimum amplitude. (default: 1e-06)
• data (of type int?, which defaults to null): set data mode. (default: 0, possible values: 0 (magnitude), 1 (phase), 2 (delay))
• channels (of type string?, which defaults to null): set channels to draw. (default: all)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showinfo

Ffmpeg filter: Show textual information for each video frame.

Type:

(?checksum : bool?, ?udu_sei_as_ascii : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• checksum (of type bool?, which defaults to null): calculate checksums. (default: true)
• udu_sei_as_ascii (of type bool?, which defaults to null): try to print user data unregistered SEI as ascii character when possible. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.showinfo.create

Ffmpeg filter: Show textual information for each video frame. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?checksum : bool?, ?udu_sei_as_ascii : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• checksum (of type bool?, which defaults to null): calculate checksums. (default: true)
• udu_sei_as_ascii (of type bool?, which defaults to null): try to print user data unregistered SEI as ascii character when possible. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showpalette

Ffmpeg filter: Display frame palette.

Type:

(?s : int?, ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• s (of type int?, which defaults to null): set pixel box size. (default: 30)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.showpalette.create

Ffmpeg filter: Display frame palette. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?s : int?, ffmpeg.filter.graph) -> unit

Arguments:

• s (of type int?, which defaults to null): set pixel box size. (default: 30)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showspatial

Ffmpeg filter: Convert input audio to a spatial video output.

Type:

(?size : string?, ?s : string?, ?win_size : int?, ?win_func : int?,
 ?rate : string?, ?r : string?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 512x512)
• s (of type string?, which defaults to null): set video size. (default: 512x512)
• win_size (of type int?, which defaults to null): set window size. (default: 4096)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showspatial.create

Ffmpeg filter: Convert input audio to a spatial video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?win_size : int?, ?win_func : int?,
 ?rate : string?, ?r : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 512x512)
• s (of type string?, which defaults to null): set video size. (default: 512x512)
• win_size (of type int?, which defaults to null): set window size. (default: 4096)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showspectrum

Ffmpeg filter: Convert input audio to a spectrum video output.

Type:

(?size : string?, ?s : string?, ?slide : int?, ?mode : int?, ?color : int?,
 ?scale : int?, ?fscale : int?, ?saturation : float?, ?win_func : int?,
 ?orientation : int?, ?overlap : float?, ?gain : float?, ?data : int?,
 ?rotation : float?, ?start : int?, ?stop : int?, ?fps : string?,
 ?legend : bool?, ?drange : float?, ?limit : float?, ?opacity : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 640x512)
• s (of type string?, which defaults to null): set video size. (default: 640x512)
• slide (of type int?, which defaults to null): set sliding mode. (default: 0, possible values: 0 (replace), 1 (scroll), 2 (fullframe), 3 (rscroll), 4 (lreplace))
• mode (of type int?, which defaults to null): set channel display mode. (default: 0, possible values: 0 (combined), 1 (separate))
• color (of type int?, which defaults to null): set channel coloring. (default: 0, possible values: 0 (channel), 1 (intensity), 2 (rainbow), 3 (moreland), 4 (nebulae), 5 (fire), 6 (fiery), 7 (fruit), 8 (cool), 9 (magma), 10 (green), 11 (viridis), 12 (plasma), 13 (cividis), 14 (terrain))
• scale (of type int?, which defaults to null): set display scale. (default: 1, possible values: 0 (lin), 1 (sqrt), 2 (cbrt), 3 (log), 4 (4thrt), 5 (5thrt))
• fscale (of type int?, which defaults to null): set frequency scale. (default: 0, possible values: 0 (lin), 1 (log))
• saturation (of type float?, which defaults to null): color saturation multiplier. (default: 1)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• orientation (of type int?, which defaults to null): set orientation. (default: 0, possible values: 0 (vertical), 1 (horizontal))
• overlap (of type float?, which defaults to null): set window overlap. (default: 0)
• gain (of type float?, which defaults to null): set scale gain. (default: 1)
• data (of type int?, which defaults to null): set data mode. (default: 0, possible values: 0 (magnitude), 1 (phase), 2 (uphase))
• rotation (of type float?, which defaults to null): color rotation. (default: 0)
• start (of type int?, which defaults to null): start frequency. (default: 0)
• stop (of type int?, which defaults to null): stop frequency. (default: 0)
• fps (of type string?, which defaults to null): set video rate. (default: auto)
• legend (of type bool?, which defaults to null): draw legend. (default: false)
• drange (of type float?, which defaults to null): set dynamic range in dBFS. (default: 120)
• limit (of type float?, which defaults to null): set upper limit in dBFS. (default: 0)
• opacity (of type float?, which defaults to null): set opacity strength. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showspectrum.create

Ffmpeg filter: Convert input audio to a spectrum video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?slide : int?, ?mode : int?, ?color : int?,
 ?scale : int?, ?fscale : int?, ?saturation : float?, ?win_func : int?,
 ?orientation : int?, ?overlap : float?, ?gain : float?, ?data : int?,
 ?rotation : float?, ?start : int?, ?stop : int?, ?fps : string?,
 ?legend : bool?, ?drange : float?, ?limit : float?, ?opacity : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 640x512)
• s (of type string?, which defaults to null): set video size. (default: 640x512)
• slide (of type int?, which defaults to null): set sliding mode. (default: 0, possible values: 0 (replace), 1 (scroll), 2 (fullframe), 3 (rscroll), 4 (lreplace))
• mode (of type int?, which defaults to null): set channel display mode. (default: 0, possible values: 0 (combined), 1 (separate))
• color (of type int?, which defaults to null): set channel coloring. (default: 0, possible values: 0 (channel), 1 (intensity), 2 (rainbow), 3 (moreland), 4 (nebulae), 5 (fire), 6 (fiery), 7 (fruit), 8 (cool), 9 (magma), 10 (green), 11 (viridis), 12 (plasma), 13 (cividis), 14 (terrain))
• scale (of type int?, which defaults to null): set display scale. (default: 1, possible values: 0 (lin), 1 (sqrt), 2 (cbrt), 3 (log), 4 (4thrt), 5 (5thrt))
• fscale (of type int?, which defaults to null): set frequency scale. (default: 0, possible values: 0 (lin), 1 (log))
• saturation (of type float?, which defaults to null): color saturation multiplier. (default: 1)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• orientation (of type int?, which defaults to null): set orientation. (default: 0, possible values: 0 (vertical), 1 (horizontal))
• overlap (of type float?, which defaults to null): set window overlap. (default: 0)
• gain (of type float?, which defaults to null): set scale gain. (default: 1)
• data (of type int?, which defaults to null): set data mode. (default: 0, possible values: 0 (magnitude), 1 (phase), 2 (uphase))
• rotation (of type float?, which defaults to null): color rotation. (default: 0)
• start (of type int?, which defaults to null): start frequency. (default: 0)
• stop (of type int?, which defaults to null): stop frequency. (default: 0)
• fps (of type string?, which defaults to null): set video rate. (default: auto)
• legend (of type bool?, which defaults to null): draw legend. (default: false)
• drange (of type float?, which defaults to null): set dynamic range in dBFS. (default: 120)
• limit (of type float?, which defaults to null): set upper limit in dBFS. (default: 0)
• opacity (of type float?, which defaults to null): set opacity strength. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showspectrumpic

Ffmpeg filter: Convert input audio to a spectrum video output single picture.

Type:

(?size : string?, ?s : string?, ?mode : int?, ?color : int?, ?scale : int?,
 ?fscale : int?, ?saturation : float?, ?win_func : int?, ?orientation : int?,
 ?gain : float?, ?legend : bool?, ?rotation : float?, ?start : int?,
 ?stop : int?, ?drange : float?, ?limit : float?, ?opacity : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 4096x2048)
• s (of type string?, which defaults to null): set video size. (default: 4096x2048)
• mode (of type int?, which defaults to null): set channel display mode. (default: 0, possible values: 0 (combined), 1 (separate))
• color (of type int?, which defaults to null): set channel coloring. (default: 1, possible values: 0 (channel), 1 (intensity), 2 (rainbow), 3 (moreland), 4 (nebulae), 5 (fire), 6 (fiery), 7 (fruit), 8 (cool), 9 (magma), 10 (green), 11 (viridis), 12 (plasma), 13 (cividis), 14 (terrain))
• scale (of type int?, which defaults to null): set display scale. (default: 3, possible values: 0 (lin), 1 (sqrt), 2 (cbrt), 3 (log), 4 (4thrt), 5 (5thrt))
• fscale (of type int?, which defaults to null): set frequency scale. (default: 0, possible values: 0 (lin), 1 (log))
• saturation (of type float?, which defaults to null): color saturation multiplier. (default: 1)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• orientation (of type int?, which defaults to null): set orientation. (default: 0, possible values: 0 (vertical), 1 (horizontal))
• gain (of type float?, which defaults to null): set scale gain. (default: 1)
• legend (of type bool?, which defaults to null): draw legend. (default: true)
• rotation (of type float?, which defaults to null): color rotation. (default: 0)
• start (of type int?, which defaults to null): start frequency. (default: 0)
• stop (of type int?, which defaults to null): stop frequency. (default: 0)
• drange (of type float?, which defaults to null): set dynamic range in dBFS. (default: 120)
• limit (of type float?, which defaults to null): set upper limit in dBFS. (default: 0)
• opacity (of type float?, which defaults to null): set opacity strength. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showspectrumpic.create

Ffmpeg filter: Convert input audio to a spectrum video output single picture. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?mode : int?, ?color : int?, ?scale : int?,
 ?fscale : int?, ?saturation : float?, ?win_func : int?, ?orientation : int?,
 ?gain : float?, ?legend : bool?, ?rotation : float?, ?start : int?,
 ?stop : int?, ?drange : float?, ?limit : float?, ?opacity : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 4096x2048)
• s (of type string?, which defaults to null): set video size. (default: 4096x2048)
• mode (of type int?, which defaults to null): set channel display mode. (default: 0, possible values: 0 (combined), 1 (separate))
• color (of type int?, which defaults to null): set channel coloring. (default: 1, possible values: 0 (channel), 1 (intensity), 2 (rainbow), 3 (moreland), 4 (nebulae), 5 (fire), 6 (fiery), 7 (fruit), 8 (cool), 9 (magma), 10 (green), 11 (viridis), 12 (plasma), 13 (cividis), 14 (terrain))
• scale (of type int?, which defaults to null): set display scale. (default: 3, possible values: 0 (lin), 1 (sqrt), 2 (cbrt), 3 (log), 4 (4thrt), 5 (5thrt))
• fscale (of type int?, which defaults to null): set frequency scale. (default: 0, possible values: 0 (lin), 1 (log))
• saturation (of type float?, which defaults to null): color saturation multiplier. (default: 1)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• orientation (of type int?, which defaults to null): set orientation. (default: 0, possible values: 0 (vertical), 1 (horizontal))
• gain (of type float?, which defaults to null): set scale gain. (default: 1)
• legend (of type bool?, which defaults to null): draw legend. (default: true)
• rotation (of type float?, which defaults to null): color rotation. (default: 0)
• start (of type int?, which defaults to null): start frequency. (default: 0)
• stop (of type int?, which defaults to null): stop frequency. (default: 0)
• drange (of type float?, which defaults to null): set dynamic range in dBFS. (default: 120)
• limit (of type float?, which defaults to null): set upper limit in dBFS. (default: 0)
• opacity (of type float?, which defaults to null): set opacity strength. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showvolume

Ffmpeg filter: Convert input audio volume to video output.

Type:

(?rate : string?, ?r : string?, ?b : int?, ?w : int?, ?h : int?, ?f : float?,
 ?c : string?, ?t : bool?, ?v : bool?, ?dm : float?, ?dmc : string?,
 ?o : int?, ?s : int?, ?p : float?, ?m : int?, ?ds : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.video

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• b (of type int?, which defaults to null): set border width. (default: 1)
• w (of type int?, which defaults to null): set channel width. (default: 400)
• h (of type int?, which defaults to null): set channel height. (default: 20)
• f (of type float?, which defaults to null): set fade. (default: 0.95)
• c (of type string?, which defaults to null): set volume color expression. (default: PEAK*255+floor((1-PEAK)*255)*256+0xff000000)
• t (of type bool?, which defaults to null): display channel names. (default: true)
• v (of type bool?, which defaults to null): display volume value. (default: true)
• dm (of type float?, which defaults to null): duration for max value display. (default: 0)
• dmc (of type string?, which defaults to null): set color of the max value line. (default: orange)
• o (of type int?, which defaults to null): set orientation. (default: 0, possible values: 0 (h), 1 (v))
• s (of type int?, which defaults to null): set step size. (default: 0)
• p (of type float?, which defaults to null): set background opacity. (default: 0)
• m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (p), 1 (r))
• ds (of type int?, which defaults to null): set display scale. (default: 0, possible values: 0 (lin), 1 (log))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showvolume.create

Ffmpeg filter: Convert input audio volume to video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?rate : string?, ?r : string?, ?b : int?, ?w : int?, ?h : int?, ?f : float?,
 ?c : string?, ?t : bool?, ?v : bool?, ?dm : float?, ?dmc : string?,
 ?o : int?, ?s : int?, ?p : float?, ?m : int?, ?ds : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• b (of type int?, which defaults to null): set border width. (default: 1)
• w (of type int?, which defaults to null): set channel width. (default: 400)
• h (of type int?, which defaults to null): set channel height. (default: 20)
• f (of type float?, which defaults to null): set fade. (default: 0.95)
• c (of type string?, which defaults to null): set volume color expression. (default: PEAK*255+floor((1-PEAK)*255)*256+0xff000000)
• t (of type bool?, which defaults to null): display channel names. (default: true)
• v (of type bool?, which defaults to null): display volume value. (default: true)
• dm (of type float?, which defaults to null): duration for max value display. (default: 0)
• dmc (of type string?, which defaults to null): set color of the max value line. (default: orange)
• o (of type int?, which defaults to null): set orientation. (default: 0, possible values: 0 (h), 1 (v))
• s (of type int?, which defaults to null): set step size. (default: 0)
• p (of type float?, which defaults to null): set background opacity. (default: 0)
• m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (p), 1 (r))
• ds (of type int?, which defaults to null): set display scale. (default: 0, possible values: 0 (lin), 1 (log))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showwaves

Ffmpeg filter: Convert input audio to a video output.

Type:

(?size : string?, ?s : string?, ?mode : int?, ?n : string?, ?rate : string?,
 ?r : string?, ?split_channels : bool?, ?colors : string?, ?scale : int?,
 ?draw : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 600x240)
• s (of type string?, which defaults to null): set video size. (default: 600x240)
• mode (of type int?, which defaults to null): select display mode. (default: 0, possible values: 0 (point), 1 (line), 2 (p2p), 3 (cline))
• n (of type string?, which defaults to null): set how many samples to show in the same point. (default: 0/1)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• split_channels (of type bool?, which defaults to null): draw channels separately. (default: false)
• colors (of type string?, which defaults to null): set channels colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• scale (of type int?, which defaults to null): set amplitude scale. (default: 0, possible values: 0 (lin), 1 (log), 2 (sqrt), 3 (cbrt))
• draw (of type int?, which defaults to null): set draw mode. (default: 0, possible values: 0 (scale), 1 (full))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showwaves.create

Ffmpeg filter: Convert input audio to a video output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?mode : int?, ?n : string?, ?rate : string?,
 ?r : string?, ?split_channels : bool?, ?colors : string?, ?scale : int?,
 ?draw : int?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 600x240)
• s (of type string?, which defaults to null): set video size. (default: 600x240)
• mode (of type int?, which defaults to null): select display mode. (default: 0, possible values: 0 (point), 1 (line), 2 (p2p), 3 (cline))
• n (of type string?, which defaults to null): set how many samples to show in the same point. (default: 0/1)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• split_channels (of type bool?, which defaults to null): draw channels separately. (default: false)
• colors (of type string?, which defaults to null): set channels colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• scale (of type int?, which defaults to null): set amplitude scale. (default: 0, possible values: 0 (lin), 1 (log), 2 (sqrt), 3 (cbrt))
• draw (of type int?, which defaults to null): set draw mode. (default: 0, possible values: 0 (scale), 1 (full))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.showwavespic

Ffmpeg filter: Convert input audio to a video output single picture.

Type:

(?size : string?, ?s : string?, ?split_channels : bool?, ?colors : string?,
 ?scale : int?, ?draw : int?, ?filter : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 600x240)
• s (of type string?, which defaults to null): set video size. (default: 600x240)
• split_channels (of type bool?, which defaults to null): draw channels separately. (default: false)
• colors (of type string?, which defaults to null): set channels colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• scale (of type int?, which defaults to null): set amplitude scale. (default: 0, possible values: 0 (lin), 1 (log), 2 (sqrt), 3 (cbrt))
• draw (of type int?, which defaults to null): set draw mode. (default: 0, possible values: 0 (scale), 1 (full))
• filter (of type int?, which defaults to null): set filter mode. (default: 0, possible values: 0 (average), 1 (peak))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.showwavespic.create

Ffmpeg filter: Convert input audio to a video output single picture. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?split_channels : bool?, ?colors : string?,
 ?scale : int?, ?draw : int?, ?filter : int?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 600x240)
• s (of type string?, which defaults to null): set video size. (default: 600x240)
• split_channels (of type bool?, which defaults to null): draw channels separately. (default: false)
• colors (of type string?, which defaults to null): set channels colors. (default: red|green|blue|yellow|orange|lime|pink|magenta|brown)
• scale (of type int?, which defaults to null): set amplitude scale. (default: 0, possible values: 0 (lin), 1 (log), 2 (sqrt), 3 (cbrt))
• draw (of type int?, which defaults to null): set draw mode. (default: 0, possible values: 0 (scale), 1 (full))
• filter (of type int?, which defaults to null): set filter mode. (default: 0, possible values: 0 (average), 1 (peak))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.shuffleframes

Ffmpeg filter: Shuffle video frames.

Type:

(?mapping : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mapping (of type string?, which defaults to null): set destination indexes of input frames. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.shuffleframes.create

Ffmpeg filter: Shuffle video frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mapping : string?, ffmpeg.filter.graph) -> unit

Arguments:

• mapping (of type string?, which defaults to null): set destination indexes of input frames. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.shufflepixels

Ffmpeg filter: Shuffle video pixels.

Type:

(?direction : int?, ?d : int?, ?mode : int?, ?m : int?, ?width : int?,
 ?w : int?, ?height : int?, ?h : int?, ?seed : int?, ?s : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• direction (of type int?, which defaults to null): set shuffle direction. (default: 0, possible values: 0 (forward), 1 (inverse))
• d (of type int?, which defaults to null): set shuffle direction. (default: 0, possible values: 0 (forward), 1 (inverse))
• mode (of type int?, which defaults to null): set shuffle mode. (default: 0, possible values: 0 (horizontal), 1 (vertical), 2 (block))
• m (of type int?, which defaults to null): set shuffle mode. (default: 0, possible values: 0 (horizontal), 1 (vertical), 2 (block))
• width (of type int?, which defaults to null): set block width. (default: 10)
• w (of type int?, which defaults to null): set block width. (default: 10)
• height (of type int?, which defaults to null): set block height. (default: 10)
• h (of type int?, which defaults to null): set block height. (default: 10)
• seed (of type int?, which defaults to null): set random seed. (default: -1)
• s (of type int?, which defaults to null): set random seed. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.shufflepixels.create

Ffmpeg filter: Shuffle video pixels. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?direction : int?, ?d : int?, ?mode : int?, ?m : int?, ?width : int?,
 ?w : int?, ?height : int?, ?h : int?, ?seed : int?, ?s : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• direction (of type int?, which defaults to null): set shuffle direction. (default: 0, possible values: 0 (forward), 1 (inverse))
• d (of type int?, which defaults to null): set shuffle direction. (default: 0, possible values: 0 (forward), 1 (inverse))
• mode (of type int?, which defaults to null): set shuffle mode. (default: 0, possible values: 0 (horizontal), 1 (vertical), 2 (block))
• m (of type int?, which defaults to null): set shuffle mode. (default: 0, possible values: 0 (horizontal), 1 (vertical), 2 (block))
• width (of type int?, which defaults to null): set block width. (default: 10)
• w (of type int?, which defaults to null): set block width. (default: 10)
• height (of type int?, which defaults to null): set block height. (default: 10)
• h (of type int?, which defaults to null): set block height. (default: 10)
• seed (of type int?, which defaults to null): set random seed. (default: -1)
• s (of type int?, which defaults to null): set random seed. (default: -1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.shuffleplanes

Ffmpeg filter: Shuffle video planes.

Type:

(?map0 : int?, ?map1 : int?, ?map2 : int?, ?map3 : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• map0 (of type int?, which defaults to null): Index of the input plane to be used as the first output plane . (default: 0)
• map1 (of type int?, which defaults to null): Index of the input plane to be used as the second output plane . (default: 1)
• map2 (of type int?, which defaults to null): Index of the input plane to be used as the third output plane . (default: 2)
• map3 (of type int?, which defaults to null): Index of the input plane to be used as the fourth output plane . (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.shuffleplanes.create

Ffmpeg filter: Shuffle video planes. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?map0 : int?, ?map1 : int?, ?map2 : int?, ?map3 : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• map0 (of type int?, which defaults to null): Index of the input plane to be used as the first output plane . (default: 0)
• map1 (of type int?, which defaults to null): Index of the input plane to be used as the second output plane . (default: 1)
• map2 (of type int?, which defaults to null): Index of the input plane to be used as the third output plane . (default: 2)
• map3 (of type int?, which defaults to null): Index of the input plane to be used as the fourth output plane . (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sidechaincompress

Ffmpeg filter: Sidechain compressor.

Type:

(?level_in : float?, ?mode : int?, ?threshold : float?, ?ratio : float?,
 ?attack : float?, ?release : float?, ?makeup : float?, ?knee : float?,
 ?link : int?, ?detection : int?, ?level_sc : float?, ?mix : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set input gain. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (downward), 1 (upward))
• threshold (of type float?, which defaults to null): set threshold. (default: 0.125)
• ratio (of type float?, which defaults to null): set ratio. (default: 2)
• attack (of type float?, which defaults to null): set attack. (default: 20)
• release (of type float?, which defaults to null): set release. (default: 250)
• makeup (of type float?, which defaults to null): set make up gain. (default: 1)
• knee (of type float?, which defaults to null): set knee. (default: 2.82843)
• link (of type int?, which defaults to null): set link type. (default: 0, possible values: 0 (average), 1 (maximum))
• detection (of type int?, which defaults to null): set detection. (default: 1, possible values: 0 (peak), 1 (rms))
• level_sc (of type float?, which defaults to null): set sidechain gain. (default: 1)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.sidechaincompress.create

Ffmpeg filter: Sidechain compressor. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?mode : int?, ?threshold : float?, ?ratio : float?,
 ?attack : float?, ?release : float?, ?makeup : float?, ?knee : float?,
 ?link : int?, ?detection : int?, ?level_sc : float?, ?mix : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set input gain. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (downward), 1 (upward))
• threshold (of type float?, which defaults to null): set threshold. (default: 0.125)
• ratio (of type float?, which defaults to null): set ratio. (default: 2)
• attack (of type float?, which defaults to null): set attack. (default: 20)
• release (of type float?, which defaults to null): set release. (default: 250)
• makeup (of type float?, which defaults to null): set make up gain. (default: 1)
• knee (of type float?, which defaults to null): set knee. (default: 2.82843)
• link (of type int?, which defaults to null): set link type. (default: 0, possible values: 0 (average), 1 (maximum))
• detection (of type int?, which defaults to null): set detection. (default: 1, possible values: 0 (peak), 1 (rms))
• level_sc (of type float?, which defaults to null): set sidechain gain. (default: 1)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sidechaingate

Ffmpeg filter: Audio sidechain gate.

Type:

(?level_in : float?, ?mode : int?, ?range : float?, ?threshold : float?,
 ?ratio : float?, ?attack : float?, ?release : float?, ?makeup : float?,
 ?knee : float?, ?detection : int?, ?link : int?, ?level_sc : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set input level. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (downward), 1 (upward))
• range (of type float?, which defaults to null): set max gain reduction. (default: 0.06125)
• threshold (of type float?, which defaults to null): set threshold. (default: 0.125)
• ratio (of type float?, which defaults to null): set ratio. (default: 2)
• attack (of type float?, which defaults to null): set attack. (default: 20)
• release (of type float?, which defaults to null): set release. (default: 250)
• makeup (of type float?, which defaults to null): set makeup gain. (default: 1)
• knee (of type float?, which defaults to null): set knee. (default: 2.828427125)
• detection (of type int?, which defaults to null): set detection. (default: 1, possible values: 0 (peak), 1 (rms))
• link (of type int?, which defaults to null): set link. (default: 0, possible values: 0 (average), 1 (maximum))
• level_sc (of type float?, which defaults to null): set sidechain gain. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.sidechaingate.create

Ffmpeg filter: Audio sidechain gate. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?mode : int?, ?range : float?, ?threshold : float?,
 ?ratio : float?, ?attack : float?, ?release : float?, ?makeup : float?,
 ?knee : float?, ?detection : int?, ?link : int?, ?level_sc : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set input level. (default: 1)
• mode (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (downward), 1 (upward))
• range (of type float?, which defaults to null): set max gain reduction. (default: 0.06125)
• threshold (of type float?, which defaults to null): set threshold. (default: 0.125)
• ratio (of type float?, which defaults to null): set ratio. (default: 2)
• attack (of type float?, which defaults to null): set attack. (default: 20)
• release (of type float?, which defaults to null): set release. (default: 250)
• makeup (of type float?, which defaults to null): set makeup gain. (default: 1)
• knee (of type float?, which defaults to null): set knee. (default: 2.828427125)
• detection (of type int?, which defaults to null): set detection. (default: 1, possible values: 0 (peak), 1 (rms))
• link (of type int?, which defaults to null): set link. (default: 0, possible values: 0 (average), 1 (maximum))
• level_sc (of type float?, which defaults to null): set sidechain gain. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sidedata

Ffmpeg filter: Manipulate video frame side data.

Type:

(?mode : int?, ?type : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set a mode of operation. (default: 0, possible values: 0 (select), 1 (delete))
• type (of type int?, which defaults to null): set side data type. (default: -1, possible values: 0 (PANSCAN), 1 (A53_CC), 2 (STEREO3D), 3 (MATRIXENCODING), 4 (DOWNMIX_INFO), 5 (REPLAYGAIN), 6 (DISPLAYMATRIX), 7 (AFD), 8 (MOTION_VECTORS), 9 (SKIP_SAMPLES), 10 (AUDIO_SERVICE_TYPE), 11 (MASTERING_DISPLAY_METADATA), 12 (GOP_TIMECODE), 13 (SPHERICAL), 14 (CONTENT_LIGHT_LEVEL), 15 (ICC_PROFILE), 16 (S12M_TIMECOD), 16 (S12M_TIMECODE), 17 (DYNAMIC_HDR_PLUS), 18 (REGIONS_OF_INTEREST), 19 (VIDEO_ENC_PARAMS), 20 (SEI_UNREGISTERED), 21 (FILM_GRAIN_PARAMS), 22 (DETECTION_BOUNDING_BOXES), 22 (DETECTION_BBOXES), 23 (DOVI_RPU_BUFFER), 24 (DOVI_METADATA), 25 (DYNAMIC_HDR_VIVID), 26 (AMBIENT_VIEWING_ENVIRONMENT), 27 (VIDEO_HINT))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.sidedata.create

Ffmpeg filter: Manipulate video frame side data. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?type : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set a mode of operation. (default: 0, possible values: 0 (select), 1 (delete))
• type (of type int?, which defaults to null): set side data type. (default: -1, possible values: 0 (PANSCAN), 1 (A53_CC), 2 (STEREO3D), 3 (MATRIXENCODING), 4 (DOWNMIX_INFO), 5 (REPLAYGAIN), 6 (DISPLAYMATRIX), 7 (AFD), 8 (MOTION_VECTORS), 9 (SKIP_SAMPLES), 10 (AUDIO_SERVICE_TYPE), 11 (MASTERING_DISPLAY_METADATA), 12 (GOP_TIMECODE), 13 (SPHERICAL), 14 (CONTENT_LIGHT_LEVEL), 15 (ICC_PROFILE), 16 (S12M_TIMECOD), 16 (S12M_TIMECODE), 17 (DYNAMIC_HDR_PLUS), 18 (REGIONS_OF_INTEREST), 19 (VIDEO_ENC_PARAMS), 20 (SEI_UNREGISTERED), 21 (FILM_GRAIN_PARAMS), 22 (DETECTION_BOUNDING_BOXES), 22 (DETECTION_BBOXES), 23 (DOVI_RPU_BUFFER), 24 (DOVI_METADATA), 25 (DYNAMIC_HDR_VIVID), 26 (AMBIENT_VIEWING_ENVIRONMENT), 27 (VIDEO_HINT))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sierpinski

Ffmpeg filter: Render a Sierpinski fractal.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?, ?seed : int?,
 ?jump : int?, ?type : int?, ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set frame size. (default: 640x480)
• s (of type string?, which defaults to null): set frame size. (default: 640x480)
• rate (of type string?, which defaults to null): set frame rate. (default: 25)
• r (of type string?, which defaults to null): set frame rate. (default: 25)
• seed (of type int?, which defaults to null): set the seed. (default: -1)
• jump (of type int?, which defaults to null): set the jump. (default: 100)
• type (of type int?, which defaults to null): set fractal type. (default: 0, possible values: 0 (carpet), 1 (triangle))
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.sierpinski.create

Ffmpeg filter: Render a Sierpinski fractal. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?, ?seed : int?,
 ?jump : int?, ?type : int?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set frame size. (default: 640x480)
• s (of type string?, which defaults to null): set frame size. (default: 640x480)
• rate (of type string?, which defaults to null): set frame rate. (default: 25)
• r (of type string?, which defaults to null): set frame rate. (default: 25)
• seed (of type int?, which defaults to null): set the seed. (default: -1)
• jump (of type int?, which defaults to null): set the jump. (default: 100)
• type (of type int?, which defaults to null): set fractal type. (default: 0, possible values: 0 (carpet), 1 (triangle))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.signalstats

Ffmpeg filter: Generate statistics from video analysis.

Type:

(?stat : int?, ?out : int?, ?c : string?, ?color : string?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• stat (of type int?, which defaults to null): set statistics filters. (default: 0, possible values: 1 (tout), 2 (vrep), 4 (brng), combined by addition)
• out (of type int?, which defaults to null): set video filter. (default: -1, possible values: 0 (tout), 1 (vrep), 2 (brng))
• c (of type string?, which defaults to null): set highlight color. (default: yellow)
• color (of type string?, which defaults to null): set highlight color. (default: yellow)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.signalstats.create

Ffmpeg filter: Generate statistics from video analysis. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?stat : int?, ?out : int?, ?c : string?, ?color : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• stat (of type int?, which defaults to null): set statistics filters. (default: 0, possible values: 1 (tout), 2 (vrep), 4 (brng), combined by addition)
• out (of type int?, which defaults to null): set video filter. (default: -1, possible values: 0 (tout), 1 (vrep), 2 (brng))
• c (of type string?, which defaults to null): set highlight color. (default: yellow)
• color (of type string?, which defaults to null): set highlight color. (default: yellow)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.signature

Ffmpeg filter: Calculate the MPEG-7 video signature. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?detectmode : int?, ?nb_inputs : int?, ?filename : string?, ?format : int?,
 ?th_d : int?, ?th_dc : int?, ?th_xh : int?, ?th_di : int?, ?th_it : float?,
 ffmpeg.filter.graph, [ffmpeg.filter.audio], [ffmpeg.filter.video]) ->
ffmpeg.filter.video

Arguments:

• detectmode (of type int?, which defaults to null): set the detectmode. (default: 0, possible values: 0 (off), 1 (full), 2 (fast))
• nb_inputs (of type int?, which defaults to null): number of inputs. (default: 1)
• filename (of type string?, which defaults to null): filename for output files. (default: )
• format (of type int?, which defaults to null): set output format. (default: 0, possible values: 0 (binary), 1 (xml))
• th_d (of type int?, which defaults to null): threshold to detect one word as similar. (default: 9000)
• th_dc (of type int?, which defaults to null): threshold to detect all words as similar. (default: 60000)
• th_xh (of type int?, which defaults to null): threshold to detect frames as similar. (default: 116)
• th_di (of type int?, which defaults to null): minimum length of matching sequence in frames. (default: 0)
• th_it (of type float?, which defaults to null): threshold for relation of good to all frames. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.signature.create

Ffmpeg filter: Calculate the MPEG-7 video signature. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?detectmode : int?, ?nb_inputs : int?, ?filename : string?, ?format : int?,
 ?th_d : int?, ?th_dc : int?, ?th_xh : int?, ?th_di : int?, ?th_it : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• detectmode (of type int?, which defaults to null): set the detectmode. (default: 0, possible values: 0 (off), 1 (full), 2 (fast))
• nb_inputs (of type int?, which defaults to null): number of inputs. (default: 1)
• filename (of type string?, which defaults to null): filename for output files. (default: )
• format (of type int?, which defaults to null): set output format. (default: 0, possible values: 0 (binary), 1 (xml))
• th_d (of type int?, which defaults to null): threshold to detect one word as similar. (default: 9000)
• th_dc (of type int?, which defaults to null): threshold to detect all words as similar. (default: 60000)
• th_xh (of type int?, which defaults to null): threshold to detect frames as similar. (default: 116)
• th_di (of type int?, which defaults to null): minimum length of matching sequence in frames. (default: 0)
• th_it (of type float?, which defaults to null): threshold for relation of good to all frames. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.silencedetect

Ffmpeg filter: Detect silence.

Type:

(?n : float?, ?noise : float?, ?d : int?, ?duration : int?, ?mono : bool?,
 ?m : bool?, ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• n (of type float?, which defaults to null): set noise tolerance. (default: 0.001)
• noise (of type float?, which defaults to null): set noise tolerance. (default: 0.001)
• d (of type int?, which defaults to null): set minimum duration in seconds. (default: 2)
• duration (of type int?, which defaults to null): set minimum duration in seconds. (default: 2)
• mono (of type bool?, which defaults to null): check each channel separately. (default: false)
• m (of type bool?, which defaults to null): check each channel separately. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.silencedetect.create

Ffmpeg filter: Detect silence. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?n : float?, ?noise : float?, ?d : int?, ?duration : int?, ?mono : bool?,
 ?m : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• n (of type float?, which defaults to null): set noise tolerance. (default: 0.001)
• noise (of type float?, which defaults to null): set noise tolerance. (default: 0.001)
• d (of type int?, which defaults to null): set minimum duration in seconds. (default: 2)
• duration (of type int?, which defaults to null): set minimum duration in seconds. (default: 2)
• mono (of type bool?, which defaults to null): check each channel separately. (default: false)
• m (of type bool?, which defaults to null): check each channel separately. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.silenceremove

Ffmpeg filter: Remove silence.

Type:

(?start_periods : int?, ?start_duration : int?, ?start_threshold : float?,
 ?start_silence : int?, ?start_mode : int?, ?stop_periods : int?,
 ?stop_duration : int?, ?stop_threshold : float?, ?stop_silence : int?,
 ?stop_mode : int?, ?detection : int?, ?window : int?, ?timestamp : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• start_periods (of type int?, which defaults to null): set periods of silence parts to skip from start. (default: 0)
• start_duration (of type int?, which defaults to null): set start duration of non-silence part. (default: 0)
• start_threshold (of type float?, which defaults to null): set threshold for start silence detection. (default: 0)
• start_silence (of type int?, which defaults to null): set start duration of silence part to keep. (default: 0)
• start_mode (of type int?, which defaults to null): set which channel will trigger trimming from start. (default: 0, possible values: 0 (any), 1 (all))
• stop_periods (of type int?, which defaults to null): set periods of silence parts to skip from end. (default: 0)
• stop_duration (of type int?, which defaults to null): set stop duration of silence part. (default: 0)
• stop_threshold (of type float?, which defaults to null): set threshold for stop silence detection. (default: 0)
• stop_silence (of type int?, which defaults to null): set stop duration of silence part to keep. (default: 0)
• stop_mode (of type int?, which defaults to null): set which channel will trigger trimming from end. (default: 1, possible values: 0 (any), 1 (all))
• detection (of type int?, which defaults to null): set how silence is detected. (default: 1, possible values: 0 (avg), 1 (rms), 2 (peak), 3 (median), 4 (ptp), 5 (dev))
• window (of type int?, which defaults to null): set duration of window for silence detection. (default: 0.02)
• timestamp (of type int?, which defaults to null): set how every output frame timestamp is processed. (default: 0, possible values: 0 (write), 1 (copy))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.silenceremove.create

Ffmpeg filter: Remove silence. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?start_periods : int?, ?start_duration : int?, ?start_threshold : float?,
 ?start_silence : int?, ?start_mode : int?, ?stop_periods : int?,
 ?stop_duration : int?, ?stop_threshold : float?, ?stop_silence : int?,
 ?stop_mode : int?, ?detection : int?, ?window : int?, ?timestamp : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• start_periods (of type int?, which defaults to null): set periods of silence parts to skip from start. (default: 0)
• start_duration (of type int?, which defaults to null): set start duration of non-silence part. (default: 0)
• start_threshold (of type float?, which defaults to null): set threshold for start silence detection. (default: 0)
• start_silence (of type int?, which defaults to null): set start duration of silence part to keep. (default: 0)
• start_mode (of type int?, which defaults to null): set which channel will trigger trimming from start. (default: 0, possible values: 0 (any), 1 (all))
• stop_periods (of type int?, which defaults to null): set periods of silence parts to skip from end. (default: 0)
• stop_duration (of type int?, which defaults to null): set stop duration of silence part. (default: 0)
• stop_threshold (of type float?, which defaults to null): set threshold for stop silence detection. (default: 0)
• stop_silence (of type int?, which defaults to null): set stop duration of silence part to keep. (default: 0)
• stop_mode (of type int?, which defaults to null): set which channel will trigger trimming from end. (default: 1, possible values: 0 (any), 1 (all))
• detection (of type int?, which defaults to null): set how silence is detected. (default: 1, possible values: 0 (avg), 1 (rms), 2 (peak), 3 (median), 4 (ptp), 5 (dev))
• window (of type int?, which defaults to null): set duration of window for silence detection. (default: 0.02)
• timestamp (of type int?, which defaults to null): set how every output frame timestamp is processed. (default: 0, possible values: 0 (write), 1 (copy))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sinc

Ffmpeg filter: Generate a sinc kaiser-windowed low-pass, high-pass, band-pass, or band-reject FIR coefficients.

Type:

(?sample_rate : int?, ?r : int?, ?nb_samples : int?, ?n : int?, ?hp : float?,
 ?lp : float?, ?phase : float?, ?beta : float?, ?att : float?,
 ?round : bool?, ?hptaps : int?, ?lptaps : int?, ffmpeg.filter.graph) ->
ffmpeg.filter.audio

Arguments:

• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• hp (of type float?, which defaults to null): set high-pass filter frequency. (default: 0)
• lp (of type float?, which defaults to null): set low-pass filter frequency. (default: 0)
• phase (of type float?, which defaults to null): set filter phase response. (default: 50)
• beta (of type float?, which defaults to null): set kaiser window beta. (default: -1)
• att (of type float?, which defaults to null): set stop-band attenuation. (default: 120)
• round (of type bool?, which defaults to null): enable rounding. (default: false)
• hptaps (of type int?, which defaults to null): set number of taps for high-pass filter. (default: 0)
• lptaps (of type int?, which defaults to null): set number of taps for low-pass filter. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.sinc.create

Ffmpeg filter: Generate a sinc kaiser-windowed low-pass, high-pass, band-pass, or band-reject FIR coefficients. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sample_rate : int?, ?r : int?, ?nb_samples : int?, ?n : int?, ?hp : float?,
 ?lp : float?, ?phase : float?, ?beta : float?, ?att : float?,
 ?round : bool?, ?hptaps : int?, ?lptaps : int?, ffmpeg.filter.graph) -> unit

Arguments:

• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• r (of type int?, which defaults to null): set sample rate. (default: 44100)
• nb_samples (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• n (of type int?, which defaults to null): set the number of samples per requested frame. (default: 1024)
• hp (of type float?, which defaults to null): set high-pass filter frequency. (default: 0)
• lp (of type float?, which defaults to null): set low-pass filter frequency. (default: 0)
• phase (of type float?, which defaults to null): set filter phase response. (default: 50)
• beta (of type float?, which defaults to null): set kaiser window beta. (default: -1)
• att (of type float?, which defaults to null): set stop-band attenuation. (default: 120)
• round (of type bool?, which defaults to null): enable rounding. (default: false)
• hptaps (of type int?, which defaults to null): set number of taps for high-pass filter. (default: 0)
• lptaps (of type int?, which defaults to null): set number of taps for low-pass filter. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sine

Ffmpeg filter: Generate sine wave audio signal.

Type:

(?frequency : float?, ?f : float?, ?beep_factor : float?, ?b : float?,
 ?sample_rate : int?, ?r : int?, ?duration : int?, ?d : int?,
 ?samples_per_frame : string?, ffmpeg.filter.graph) -> ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set the sine frequency. (default: 440)
• f (of type float?, which defaults to null): set the sine frequency. (default: 440)
• beep_factor (of type float?, which defaults to null): set the beep frequency factor. (default: 0)
• b (of type float?, which defaults to null): set the beep frequency factor. (default: 0)
• sample_rate (of type int?, which defaults to null): set the sample rate. (default: 44100)
• r (of type int?, which defaults to null): set the sample rate. (default: 44100)
• duration (of type int?, which defaults to null): set the audio duration. (default: 0)
• d (of type int?, which defaults to null): set the audio duration. (default: 0)
• samples_per_frame (of type string?, which defaults to null): set the number of samples per frame. (default: 1024)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.sine.create

Ffmpeg filter: Generate sine wave audio signal. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?beep_factor : float?, ?b : float?,
 ?sample_rate : int?, ?r : int?, ?duration : int?, ?d : int?,
 ?samples_per_frame : string?, ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set the sine frequency. (default: 440)
• f (of type float?, which defaults to null): set the sine frequency. (default: 440)
• beep_factor (of type float?, which defaults to null): set the beep frequency factor. (default: 0)
• b (of type float?, which defaults to null): set the beep frequency factor. (default: 0)
• sample_rate (of type int?, which defaults to null): set the sample rate. (default: 44100)
• r (of type int?, which defaults to null): set the sample rate. (default: 44100)
• duration (of type int?, which defaults to null): set the audio duration. (default: 0)
• d (of type int?, which defaults to null): set the audio duration. (default: 0)
• samples_per_frame (of type string?, which defaults to null): set the number of samples per frame. (default: 1024)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.siti

Ffmpeg filter: Calculate spatial information (SI) and temporal information (TI).

Type:

(?print_summary : bool?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• print_summary (of type bool?, which defaults to null): Print summary showing average values. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.siti.create

Ffmpeg filter: Calculate spatial information (SI) and temporal information (TI). Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?print_summary : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• print_summary (of type bool?, which defaults to null): Print summary showing average values. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.smartblur

Ffmpeg filter: Blur the input video without impacting the outlines.

Type:

(?luma_radius : float?, ?lr : float?, ?luma_strength : float?, ?ls : float?,
 ?luma_threshold : int?, ?lt : int?, ?chroma_radius : float?, ?cr : float?,
 ?chroma_strength : float?, ?cs : float?, ?chroma_threshold : int?,
 ?ct : int?, ?alpha_radius : float?, ?ar : float?, ?alpha_strength : float?,
 ?as : float?, ?alpha_threshold : int?, ?at : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• luma_radius (of type float?, which defaults to null): set luma radius. (default: 1)
• lr (of type float?, which defaults to null): set luma radius. (default: 1)
• luma_strength (of type float?, which defaults to null): set luma strength. (default: 1)
• ls (of type float?, which defaults to null): set luma strength. (default: 1)
• luma_threshold (of type int?, which defaults to null): set luma threshold. (default: 0)
• lt (of type int?, which defaults to null): set luma threshold. (default: 0)
• chroma_radius (of type float?, which defaults to null): set chroma radius. (default: -0.9)
• cr (of type float?, which defaults to null): set chroma radius. (default: -0.9)
• chroma_strength (of type float?, which defaults to null): set chroma strength. (default: -2)
• cs (of type float?, which defaults to null): set chroma strength. (default: -2)
• chroma_threshold (of type int?, which defaults to null): set chroma threshold. (default: -31)
• ct (of type int?, which defaults to null): set chroma threshold. (default: -31)
• alpha_radius (of type float?, which defaults to null): set alpha radius. (default: -0.9)
• ar (of type float?, which defaults to null): set alpha radius. (default: -0.9)
• alpha_strength (of type float?, which defaults to null): set alpha strength. (default: -2)
• as (of type float?, which defaults to null): set alpha strength. (default: -2)
• alpha_threshold (of type int?, which defaults to null): set alpha threshold. (default: -31)
• at (of type int?, which defaults to null): set alpha threshold. (default: -31)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.smartblur.create

Ffmpeg filter: Blur the input video without impacting the outlines. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?luma_radius : float?, ?lr : float?, ?luma_strength : float?, ?ls : float?,
 ?luma_threshold : int?, ?lt : int?, ?chroma_radius : float?, ?cr : float?,
 ?chroma_strength : float?, ?cs : float?, ?chroma_threshold : int?,
 ?ct : int?, ?alpha_radius : float?, ?ar : float?, ?alpha_strength : float?,
 ?as : float?, ?alpha_threshold : int?, ?at : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• luma_radius (of type float?, which defaults to null): set luma radius. (default: 1)
• lr (of type float?, which defaults to null): set luma radius. (default: 1)
• luma_strength (of type float?, which defaults to null): set luma strength. (default: 1)
• ls (of type float?, which defaults to null): set luma strength. (default: 1)
• luma_threshold (of type int?, which defaults to null): set luma threshold. (default: 0)
• lt (of type int?, which defaults to null): set luma threshold. (default: 0)
• chroma_radius (of type float?, which defaults to null): set chroma radius. (default: -0.9)
• cr (of type float?, which defaults to null): set chroma radius. (default: -0.9)
• chroma_strength (of type float?, which defaults to null): set chroma strength. (default: -2)
• cs (of type float?, which defaults to null): set chroma strength. (default: -2)
• chroma_threshold (of type int?, which defaults to null): set chroma threshold. (default: -31)
• ct (of type int?, which defaults to null): set chroma threshold. (default: -31)
• alpha_radius (of type float?, which defaults to null): set alpha radius. (default: -0.9)
• ar (of type float?, which defaults to null): set alpha radius. (default: -0.9)
• alpha_strength (of type float?, which defaults to null): set alpha strength. (default: -2)
• as (of type float?, which defaults to null): set alpha strength. (default: -2)
• alpha_threshold (of type int?, which defaults to null): set alpha threshold. (default: -31)
• at (of type int?, which defaults to null): set alpha threshold. (default: -31)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.smptebars

Ffmpeg filter: Generate SMPTE color bars.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.smptebars.create

Ffmpeg filter: Generate SMPTE color bars. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.smptehdbars

Ffmpeg filter: Generate SMPTE HD color bars.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.smptehdbars.create

Ffmpeg filter: Generate SMPTE HD color bars. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.sobel

Ffmpeg filter: Apply sobel operator.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.sobel.create

Ffmpeg filter: Apply sobel operator. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?scale : float?, ?delta : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• scale (of type float?, which defaults to null): set scale. (default: 1)
• delta (of type float?, which defaults to null): set delta. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.spectrumsynth

Ffmpeg filter: Convert input spectrum videos to audio output.

Type:

(?sample_rate : int?, ?channels : int?, ?scale : int?, ?slide : int?,
 ?win_func : int?, ?overlap : float?, ?orientation : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.audio

Arguments:

• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• channels (of type int?, which defaults to null): set channels. (default: 1)
• scale (of type int?, which defaults to null): set input amplitude scale. (default: 1, possible values: 0 (lin), 1 (log))
• slide (of type int?, which defaults to null): set input sliding mode. (default: 2, possible values: 0 (replace), 1 (scroll), 2 (fullframe), 3 (rscroll))
• win_func (of type int?, which defaults to null): set window function. (default: 0, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 1)
• orientation (of type int?, which defaults to null): set orientation. (default: 0, possible values: 0 (vertical), 1 (horizontal))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.spectrumsynth.create

Ffmpeg filter: Convert input spectrum videos to audio output. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?sample_rate : int?, ?channels : int?, ?scale : int?, ?slide : int?,
 ?win_func : int?, ?overlap : float?, ?orientation : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• sample_rate (of type int?, which defaults to null): set sample rate. (default: 44100)
• channels (of type int?, which defaults to null): set channels. (default: 1)
• scale (of type int?, which defaults to null): set input amplitude scale. (default: 1, possible values: 0 (lin), 1 (log))
• slide (of type int?, which defaults to null): set input sliding mode. (default: 2, possible values: 0 (replace), 1 (scroll), 2 (fullframe), 3 (rscroll))
• win_func (of type int?, which defaults to null): set window function. (default: 0, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 1)
• orientation (of type int?, which defaults to null): set orientation. (default: 0, possible values: 0 (vertical), 1 (horizontal))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.speechnorm

Ffmpeg filter: Speech Normalizer.

Type:

(?peak : float?, ?p : float?, ?expansion : float?, ?e : float?,
 ?compression : float?, ?c : float?, ?threshold : float?, ?t : float?,
 ?raise : float?, ?r : float?, ?fall : float?, ?f : float?,
 ?channels : string?, ?h : string?, ?invert : bool?, ?i : bool?,
 ?link : bool?, ?l : bool?, ?rms : float?, ?m : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• peak (of type float?, which defaults to null): set the peak value. (default: 0.95)
• p (of type float?, which defaults to null): set the peak value. (default: 0.95)
• expansion (of type float?, which defaults to null): set the max expansion factor. (default: 2)
• e (of type float?, which defaults to null): set the max expansion factor. (default: 2)
• compression (of type float?, which defaults to null): set the max compression factor. (default: 2)
• c (of type float?, which defaults to null): set the max compression factor. (default: 2)
• threshold (of type float?, which defaults to null): set the threshold value. (default: 0)
• t (of type float?, which defaults to null): set the threshold value. (default: 0)
• raise (of type float?, which defaults to null): set the expansion raising amount. (default: 0.001)
• r (of type float?, which defaults to null): set the expansion raising amount. (default: 0.001)
• fall (of type float?, which defaults to null): set the compression raising amount. (default: 0.001)
• f (of type float?, which defaults to null): set the compression raising amount. (default: 0.001)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• h (of type string?, which defaults to null): set channels to filter. (default: all)
• invert (of type bool?, which defaults to null): set inverted filtering. (default: false)
• i (of type bool?, which defaults to null): set inverted filtering. (default: false)
• link (of type bool?, which defaults to null): set linked channels filtering. (default: false)
• l (of type bool?, which defaults to null): set linked channels filtering. (default: false)
• rms (of type float?, which defaults to null): set the RMS value. (default: 0)
• m (of type float?, which defaults to null): set the RMS value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.speechnorm.create

Ffmpeg filter: Speech Normalizer. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?peak : float?, ?p : float?, ?expansion : float?, ?e : float?,
 ?compression : float?, ?c : float?, ?threshold : float?, ?t : float?,
 ?raise : float?, ?r : float?, ?fall : float?, ?f : float?,
 ?channels : string?, ?h : string?, ?invert : bool?, ?i : bool?,
 ?link : bool?, ?l : bool?, ?rms : float?, ?m : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• peak (of type float?, which defaults to null): set the peak value. (default: 0.95)
• p (of type float?, which defaults to null): set the peak value. (default: 0.95)
• expansion (of type float?, which defaults to null): set the max expansion factor. (default: 2)
• e (of type float?, which defaults to null): set the max expansion factor. (default: 2)
• compression (of type float?, which defaults to null): set the max compression factor. (default: 2)
• c (of type float?, which defaults to null): set the max compression factor. (default: 2)
• threshold (of type float?, which defaults to null): set the threshold value. (default: 0)
• t (of type float?, which defaults to null): set the threshold value. (default: 0)
• raise (of type float?, which defaults to null): set the expansion raising amount. (default: 0.001)
• r (of type float?, which defaults to null): set the expansion raising amount. (default: 0.001)
• fall (of type float?, which defaults to null): set the compression raising amount. (default: 0.001)
• f (of type float?, which defaults to null): set the compression raising amount. (default: 0.001)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• h (of type string?, which defaults to null): set channels to filter. (default: all)
• invert (of type bool?, which defaults to null): set inverted filtering. (default: false)
• i (of type bool?, which defaults to null): set inverted filtering. (default: false)
• link (of type bool?, which defaults to null): set linked channels filtering. (default: false)
• l (of type bool?, which defaults to null): set linked channels filtering. (default: false)
• rms (of type float?, which defaults to null): set the RMS value. (default: 0)
• m (of type float?, which defaults to null): set the RMS value. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.split

Ffmpeg filter: Pass on the input to N video outputs. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?outputs : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• outputs (of type int?, which defaults to null): set number of outputs. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.split.create

Ffmpeg filter: Pass on the input to N video outputs. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?outputs : int?, ffmpeg.filter.graph) -> unit

Arguments:

• outputs (of type int?, which defaults to null): set number of outputs. (default: 2)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.spp

Ffmpeg filter: Apply a simple post processing filter.

Type:

(?quality : int?, ?qp : int?, ?mode : int?, ?use_bframe_qp : bool?,
 ?dct : int?, ?idct : int?, ?bits_per_sample : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• quality (of type int?, which defaults to null): set quality. (default: 3)
• qp (of type int?, which defaults to null): force a constant quantizer parameter. (default: 0)
• mode (of type int?, which defaults to null): set thresholding mode. (default: 0, possible values: 0 (hard), 1 (soft))
• use_bframe_qp (of type bool?, which defaults to null): use B-frames' QP. (default: false)
• dct (of type int?, which defaults to null): DCT algorithm. (default: 0, possible values: 0 (auto), 1 (fastint), 2 (int), 3 (mmx), 5 (altivec), 6 (faan))
• idct (of type int?, which defaults to null): select IDCT implementation. (default: 0, possible values: 0 (auto), 1 (int), 2 (simple), 3 (simplemmx), 7 (arm), 8 (altivec), 10 (simplearm), 16 (simplearmv5te), 17 (simplearmv6), 22 (simpleneon), 14 (xvid), 14 (xvidmmx), 20 (faani), 128 (simpleauto))
• bits_per_sample (of type int?, which defaults to null): Default: 8
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.spp.create

Ffmpeg filter: Apply a simple post processing filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?quality : int?, ?qp : int?, ?mode : int?, ?use_bframe_qp : bool?,
 ?dct : int?, ?idct : int?, ?bits_per_sample : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• quality (of type int?, which defaults to null): set quality. (default: 3)
• qp (of type int?, which defaults to null): force a constant quantizer parameter. (default: 0)
• mode (of type int?, which defaults to null): set thresholding mode. (default: 0, possible values: 0 (hard), 1 (soft))
• use_bframe_qp (of type bool?, which defaults to null): use B-frames' QP. (default: false)
• dct (of type int?, which defaults to null): DCT algorithm. (default: 0, possible values: 0 (auto), 1 (fastint), 2 (int), 3 (mmx), 5 (altivec), 6 (faan))
• idct (of type int?, which defaults to null): select IDCT implementation. (default: 0, possible values: 0 (auto), 1 (int), 2 (simple), 3 (simplemmx), 7 (arm), 8 (altivec), 10 (simplearm), 16 (simplearmv5te), 17 (simplearmv6), 22 (simpleneon), 14 (xvid), 14 (xvidmmx), 20 (faani), 128 (simpleauto))
• bits_per_sample (of type int?, which defaults to null): Default: 8
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ssim

Ffmpeg filter: Calculate the SSIM between two video streams.

Type:

(?stats_file : string?, ?f : string?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame difference information
• f (of type string?, which defaults to null): Set file where to store per-frame difference information
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.ssim.create

Ffmpeg filter: Calculate the SSIM between two video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?stats_file : string?, ?f : string?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame difference information
• f (of type string?, which defaults to null): Set file where to store per-frame difference information
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.ssim360

Ffmpeg filter: Calculate the SSIM between two 360 video streams.

Type:

(?stats_file : string?, ?f : string?, ?compute_chroma : int?,
 ?frame_skip_ratio : int?, ?ref_projection : int?, ?main_projection : int?,
 ?ref_stereo : int?, ?main_stereo : int?, ?ref_pad : float?,
 ?main_pad : float?, ?use_tape : int?, ?heatmap_str : string?,
 ?default_heatmap_width : int?, ?default_heatmap_height : int?,
 ?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame difference information
• f (of type string?, which defaults to null): Set file where to store per-frame difference information
• compute_chroma (of type int?, which defaults to null): Specifies if non-luma channels must be computed. (default: 1)
• frame_skip_ratio (of type int?, which defaults to null): Specifies the number of frames to be skipped from evaluation, for every evaluated frame. (default: 0)
• ref_projection (of type int?, which defaults to null): projection of the reference video. (default: 4, possible values: 4 (e), 4 (equirect), 0 (c3x2), 1 (c2x3), 2 (barrel), 3 (barrelsplit))
• main_projection (of type int?, which defaults to null): projection of the main video. (default: 5, possible values: 4 (e), 4 (equirect), 0 (c3x2), 1 (c2x3), 2 (barrel), 3 (barrelsplit))
• ref_stereo (of type int?, which defaults to null): stereo format of the reference video. (default: 2, possible values: 2 (mono), 0 (tb), 1 (lr))
• main_stereo (of type int?, which defaults to null): stereo format of main video. (default: 3, possible values: 2 (mono), 0 (tb), 1 (lr))
• ref_pad (of type float?, which defaults to null): Expansion (padding) coefficient for each cube face of the reference video. (default: 0)
• main_pad (of type float?, which defaults to null): Expansion (padding) coefficient for each cube face of the main video. (default: 0)
• use_tape (of type int?, which defaults to null): Specifies if the tape based SSIM 360 algorithm must be used independent of the input video types. (default: 0)
• heatmap_str (of type string?, which defaults to null): Heatmap data for view-based evaluation. For heatmap file format, please refer to EntSphericalVideoHeatmapData.
• default_heatmap_width (of type int?, which defaults to null): Default heatmap dimension. Will be used when dimension is not specified in heatmap data.. (default: 32)
• default_heatmap_height (of type int?, which defaults to null): Default heatmap dimension. Will be used when dimension is not specified in heatmap data.. (default: 16)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.ssim360.create

Ffmpeg filter: Calculate the SSIM between two 360 video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?stats_file : string?, ?f : string?, ?compute_chroma : int?,
 ?frame_skip_ratio : int?, ?ref_projection : int?, ?main_projection : int?,
 ?ref_stereo : int?, ?main_stereo : int?, ?ref_pad : float?,
 ?main_pad : float?, ?use_tape : int?, ?heatmap_str : string?,
 ?default_heatmap_width : int?, ?default_heatmap_height : int?,
 ?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame difference information
• f (of type string?, which defaults to null): Set file where to store per-frame difference information
• compute_chroma (of type int?, which defaults to null): Specifies if non-luma channels must be computed. (default: 1)
• frame_skip_ratio (of type int?, which defaults to null): Specifies the number of frames to be skipped from evaluation, for every evaluated frame. (default: 0)
• ref_projection (of type int?, which defaults to null): projection of the reference video. (default: 4, possible values: 4 (e), 4 (equirect), 0 (c3x2), 1 (c2x3), 2 (barrel), 3 (barrelsplit))
• main_projection (of type int?, which defaults to null): projection of the main video. (default: 5, possible values: 4 (e), 4 (equirect), 0 (c3x2), 1 (c2x3), 2 (barrel), 3 (barrelsplit))
• ref_stereo (of type int?, which defaults to null): stereo format of the reference video. (default: 2, possible values: 2 (mono), 0 (tb), 1 (lr))
• main_stereo (of type int?, which defaults to null): stereo format of main video. (default: 3, possible values: 2 (mono), 0 (tb), 1 (lr))
• ref_pad (of type float?, which defaults to null): Expansion (padding) coefficient for each cube face of the reference video. (default: 0)
• main_pad (of type float?, which defaults to null): Expansion (padding) coefficient for each cube face of the main video. (default: 0)
• use_tape (of type int?, which defaults to null): Specifies if the tape based SSIM 360 algorithm must be used independent of the input video types. (default: 0)
• heatmap_str (of type string?, which defaults to null): Heatmap data for view-based evaluation. For heatmap file format, please refer to EntSphericalVideoHeatmapData.
• default_heatmap_width (of type int?, which defaults to null): Default heatmap dimension. Will be used when dimension is not specified in heatmap data.. (default: 32)
• default_heatmap_height (of type int?, which defaults to null): Default heatmap dimension. Will be used when dimension is not specified in heatmap data.. (default: 16)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.stereo3d

Ffmpeg filter: Convert video stereoscopic 3D view.

Type:

(?in : int?, ?out : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• in (of type int?, which defaults to null): set input format. (default: 18, possible values: 24 (ab2l), 24 (tb2l), 25 (ab2r), 25 (tb2r), 22 (abl), 22 (tbl), 23 (abr), 23 (tbr), 26 (al), 27 (ar), 20 (sbs2l), 21 (sbs2r), 18 (sbsl), 19 (sbsr), 16 (irl), 17 (irr), 30 (icl), 31 (icr))
• out (of type int?, which defaults to null): set output format. (default: 3, possible values: 24 (ab2l), 24 (tb2l), 25 (ab2r), 25 (tb2r), 22 (abl), 22 (tbl), 23 (abr), 23 (tbr), 6 (agmc), 7 (agmd), 4 (agmg), 5 (agmh), 26 (al), 27 (ar), 12 (arbg), 2 (arcc), 3 (arcd), 0 (arcg), 1 (arch), 13 (argg), 10 (aybc), 11 (aybd), 8 (aybg), 9 (aybh), 16 (irl), 17 (irr), 14 (ml), 15 (mr), 20 (sbs2l), 21 (sbs2r), 18 (sbsl), 19 (sbsr), 28 (chl), 29 (chr), 30 (icl), 31 (icr), 32 (hdmi))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.stereo3d.create

Ffmpeg filter: Convert video stereoscopic 3D view. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?in : int?, ?out : int?, ffmpeg.filter.graph) -> unit

Arguments:

• in (of type int?, which defaults to null): set input format. (default: 18, possible values: 24 (ab2l), 24 (tb2l), 25 (ab2r), 25 (tb2r), 22 (abl), 22 (tbl), 23 (abr), 23 (tbr), 26 (al), 27 (ar), 20 (sbs2l), 21 (sbs2r), 18 (sbsl), 19 (sbsr), 16 (irl), 17 (irr), 30 (icl), 31 (icr))
• out (of type int?, which defaults to null): set output format. (default: 3, possible values: 24 (ab2l), 24 (tb2l), 25 (ab2r), 25 (tb2r), 22 (abl), 22 (tbl), 23 (abr), 23 (tbr), 6 (agmc), 7 (agmd), 4 (agmg), 5 (agmh), 26 (al), 27 (ar), 12 (arbg), 2 (arcc), 3 (arcd), 0 (arcg), 1 (arch), 13 (argg), 10 (aybc), 11 (aybd), 8 (aybg), 9 (aybh), 16 (irl), 17 (irr), 14 (ml), 15 (mr), 20 (sbs2l), 21 (sbs2r), 18 (sbsl), 19 (sbsr), 28 (chl), 29 (chr), 30 (icl), 31 (icr), 32 (hdmi))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.stereotools

Ffmpeg filter: Apply various stereo tools.

Type:

(?level_in : float?, ?level_out : float?, ?balance_in : float?,
 ?balance_out : float?, ?softclip : bool?, ?mutel : bool?, ?muter : bool?,
 ?phasel : bool?, ?phaser : bool?, ?mode : int?, ?slev : float?,
 ?sbal : float?, ?mlev : float?, ?mpan : float?, ?base : float?,
 ?delay : float?, ?sclevel : float?, ?phase : float?, ?bmode_in : int?,
 ?bmode_out : int?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• level_in (of type float?, which defaults to null): set level in. (default: 1)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• balance_in (of type float?, which defaults to null): set balance in. (default: 0)
• balance_out (of type float?, which defaults to null): set balance out. (default: 0)
• softclip (of type bool?, which defaults to null): enable softclip. (default: false)
• mutel (of type bool?, which defaults to null): mute L. (default: false)
• muter (of type bool?, which defaults to null): mute R. (default: false)
• phasel (of type bool?, which defaults to null): phase L. (default: false)
• phaser (of type bool?, which defaults to null): phase R. (default: false)
• mode (of type int?, which defaults to null): set stereo mode. (default: 0, possible values: 0 (lr>lr), 1 (lr>ms), 2 (ms>lr), 3 (lr>ll), 4 (lr>rr), 5 (lr>l+r), 6 (lr>rl), 7 (ms>ll), 8 (ms>rr), 9 (ms>rl), 10 (lr>l-r))
• slev (of type float?, which defaults to null): set side level. (default: 1)
• sbal (of type float?, which defaults to null): set side balance. (default: 0)
• mlev (of type float?, which defaults to null): set middle level. (default: 1)
• mpan (of type float?, which defaults to null): set middle pan. (default: 0)
• base (of type float?, which defaults to null): set stereo base. (default: 0)
• delay (of type float?, which defaults to null): set delay. (default: 0)
• sclevel (of type float?, which defaults to null): set S/C level. (default: 1)
• phase (of type float?, which defaults to null): set stereo phase. (default: 0)
• bmode_in (of type int?, which defaults to null): set balance in mode. (default: 0, possible values: 0 (balance), 1 (amplitude), 2 (power))
• bmode_out (of type int?, which defaults to null): set balance out mode. (default: 0, possible values: 0 (balance), 1 (amplitude), 2 (power))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.stereotools.create

Ffmpeg filter: Apply various stereo tools. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?level_in : float?, ?level_out : float?, ?balance_in : float?,
 ?balance_out : float?, ?softclip : bool?, ?mutel : bool?, ?muter : bool?,
 ?phasel : bool?, ?phaser : bool?, ?mode : int?, ?slev : float?,
 ?sbal : float?, ?mlev : float?, ?mpan : float?, ?base : float?,
 ?delay : float?, ?sclevel : float?, ?phase : float?, ?bmode_in : int?,
 ?bmode_out : int?, ffmpeg.filter.graph) -> unit

Arguments:

• level_in (of type float?, which defaults to null): set level in. (default: 1)
• level_out (of type float?, which defaults to null): set level out. (default: 1)
• balance_in (of type float?, which defaults to null): set balance in. (default: 0)
• balance_out (of type float?, which defaults to null): set balance out. (default: 0)
• softclip (of type bool?, which defaults to null): enable softclip. (default: false)
• mutel (of type bool?, which defaults to null): mute L. (default: false)
• muter (of type bool?, which defaults to null): mute R. (default: false)
• phasel (of type bool?, which defaults to null): phase L. (default: false)
• phaser (of type bool?, which defaults to null): phase R. (default: false)
• mode (of type int?, which defaults to null): set stereo mode. (default: 0, possible values: 0 (lr>lr), 1 (lr>ms), 2 (ms>lr), 3 (lr>ll), 4 (lr>rr), 5 (lr>l+r), 6 (lr>rl), 7 (ms>ll), 8 (ms>rr), 9 (ms>rl), 10 (lr>l-r))
• slev (of type float?, which defaults to null): set side level. (default: 1)
• sbal (of type float?, which defaults to null): set side balance. (default: 0)
• mlev (of type float?, which defaults to null): set middle level. (default: 1)
• mpan (of type float?, which defaults to null): set middle pan. (default: 0)
• base (of type float?, which defaults to null): set stereo base. (default: 0)
• delay (of type float?, which defaults to null): set delay. (default: 0)
• sclevel (of type float?, which defaults to null): set S/C level. (default: 1)
• phase (of type float?, which defaults to null): set stereo phase. (default: 0)
• bmode_in (of type int?, which defaults to null): set balance in mode. (default: 0, possible values: 0 (balance), 1 (amplitude), 2 (power))
• bmode_out (of type int?, which defaults to null): set balance out mode. (default: 0, possible values: 0 (balance), 1 (amplitude), 2 (power))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.stereowiden

Ffmpeg filter: Apply stereo widening effect.

Type:

(?delay : float?, ?feedback : float?, ?crossfeed : float?, ?drymix : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• delay (of type float?, which defaults to null): set delay time. (default: 20)
• feedback (of type float?, which defaults to null): set feedback gain. (default: 0.3)
• crossfeed (of type float?, which defaults to null): set cross feed. (default: 0.3)
• drymix (of type float?, which defaults to null): set dry-mix. (default: 0.8)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.stereowiden.create

Ffmpeg filter: Apply stereo widening effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?delay : float?, ?feedback : float?, ?crossfeed : float?, ?drymix : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• delay (of type float?, which defaults to null): set delay time. (default: 20)
• feedback (of type float?, which defaults to null): set feedback gain. (default: 0.3)
• crossfeed (of type float?, which defaults to null): set cross feed. (default: 0.3)
• drymix (of type float?, which defaults to null): set dry-mix. (default: 0.8)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.streamselect

Ffmpeg filter: Select video streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(?inputs : int?, ?map : string?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> [ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

• inputs (of type int?, which defaults to null): number of input streams. (default: 2)
• map (of type string?, which defaults to null): input indexes to remap to outputs
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.streamselect.create

Ffmpeg filter: Select video streams. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?map : string?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): number of input streams. (default: 2)
• map (of type string?, which defaults to null): input indexes to remap to outputs
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.subtitles

Ffmpeg filter: Render text subtitles onto input video using the libass library.

Type:

(?filename : string?, ?f : string?, ?original_size : string?,
 ?fontsdir : string?, ?alpha : bool?, ?charenc : string?,
 ?stream_index : int?, ?si : int?, ?force_style : string?,
 ?wrap_unicode : bool?, ?shaping : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• filename (of type string?, which defaults to null): set the filename of file to read
• f (of type string?, which defaults to null): set the filename of file to read
• original_size (of type string?, which defaults to null): set the size of the original video (used to scale fonts)
• fontsdir (of type string?, which defaults to null): set the directory containing the fonts to read
• alpha (of type bool?, which defaults to null): enable processing of alpha channel. (default: false)
• charenc (of type string?, which defaults to null): set input character encoding
• stream_index (of type int?, which defaults to null): set stream index. (default: -1)
• si (of type int?, which defaults to null): set stream index. (default: -1)
• force_style (of type string?, which defaults to null): force subtitle style
• wrap_unicode (of type bool?, which defaults to null): break lines according to the Unicode Line Breaking Algorithm
• shaping (of type int?, which defaults to null): set shaping engine. (default: -1, possible values: -1 (auto), 0 (simple), 1 (complex))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.subtitles.create

Ffmpeg filter: Render text subtitles onto input video using the libass library. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filename : string?, ?f : string?, ?original_size : string?,
 ?fontsdir : string?, ?alpha : bool?, ?charenc : string?,
 ?stream_index : int?, ?si : int?, ?force_style : string?,
 ?wrap_unicode : bool?, ?shaping : int?, ffmpeg.filter.graph) -> unit

Arguments:

• filename (of type string?, which defaults to null): set the filename of file to read
• f (of type string?, which defaults to null): set the filename of file to read
• original_size (of type string?, which defaults to null): set the size of the original video (used to scale fonts)
• fontsdir (of type string?, which defaults to null): set the directory containing the fonts to read
• alpha (of type bool?, which defaults to null): enable processing of alpha channel. (default: false)
• charenc (of type string?, which defaults to null): set input character encoding
• stream_index (of type int?, which defaults to null): set stream index. (default: -1)
• si (of type int?, which defaults to null): set stream index. (default: -1)
• force_style (of type string?, which defaults to null): force subtitle style
• wrap_unicode (of type bool?, which defaults to null): break lines according to the Unicode Line Breaking Algorithm
• shaping (of type int?, which defaults to null): set shaping engine. (default: -1, possible values: -1 (auto), 0 (simple), 1 (complex))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.super2xsai

Ffmpeg filter: Scale the input by 2x using the Super2xSaI pixel art algorithm.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.super2xsai.create

Ffmpeg filter: Scale the input by 2x using the Super2xSaI pixel art algorithm. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.superequalizer

Ffmpeg filter: Apply 18 band equalization filter.

Type:

(?1b : float?, ?2b : float?, ?3b : float?, ?4b : float?, ?5b : float?,
 ?6b : float?, ?7b : float?, ?8b : float?, ?9b : float?, ?10b : float?,
 ?11b : float?, ?12b : float?, ?13b : float?, ?14b : float?, ?15b : float?,
 ?16b : float?, ?17b : float?, ?18b : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• 1b (of type float?, which defaults to null): set 65Hz band gain. (default: 1)
• 2b (of type float?, which defaults to null): set 92Hz band gain. (default: 1)
• 3b (of type float?, which defaults to null): set 131Hz band gain. (default: 1)
• 4b (of type float?, which defaults to null): set 185Hz band gain. (default: 1)
• 5b (of type float?, which defaults to null): set 262Hz band gain. (default: 1)
• 6b (of type float?, which defaults to null): set 370Hz band gain. (default: 1)
• 7b (of type float?, which defaults to null): set 523Hz band gain. (default: 1)
• 8b (of type float?, which defaults to null): set 740Hz band gain. (default: 1)
• 9b (of type float?, which defaults to null): set 1047Hz band gain. (default: 1)
• 10b (of type float?, which defaults to null): set 1480Hz band gain. (default: 1)
• 11b (of type float?, which defaults to null): set 2093Hz band gain. (default: 1)
• 12b (of type float?, which defaults to null): set 2960Hz band gain. (default: 1)
• 13b (of type float?, which defaults to null): set 4186Hz band gain. (default: 1)
• 14b (of type float?, which defaults to null): set 5920Hz band gain. (default: 1)
• 15b (of type float?, which defaults to null): set 8372Hz band gain. (default: 1)
• 16b (of type float?, which defaults to null): set 11840Hz band gain. (default: 1)
• 17b (of type float?, which defaults to null): set 16744Hz band gain. (default: 1)
• 18b (of type float?, which defaults to null): set 20000Hz band gain. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.superequalizer.create

Ffmpeg filter: Apply 18 band equalization filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?1b : float?, ?2b : float?, ?3b : float?, ?4b : float?, ?5b : float?,
 ?6b : float?, ?7b : float?, ?8b : float?, ?9b : float?, ?10b : float?,
 ?11b : float?, ?12b : float?, ?13b : float?, ?14b : float?, ?15b : float?,
 ?16b : float?, ?17b : float?, ?18b : float?, ffmpeg.filter.graph) -> unit

Arguments:

• 1b (of type float?, which defaults to null): set 65Hz band gain. (default: 1)
• 2b (of type float?, which defaults to null): set 92Hz band gain. (default: 1)
• 3b (of type float?, which defaults to null): set 131Hz band gain. (default: 1)
• 4b (of type float?, which defaults to null): set 185Hz band gain. (default: 1)
• 5b (of type float?, which defaults to null): set 262Hz band gain. (default: 1)
• 6b (of type float?, which defaults to null): set 370Hz band gain. (default: 1)
• 7b (of type float?, which defaults to null): set 523Hz band gain. (default: 1)
• 8b (of type float?, which defaults to null): set 740Hz band gain. (default: 1)
• 9b (of type float?, which defaults to null): set 1047Hz band gain. (default: 1)
• 10b (of type float?, which defaults to null): set 1480Hz band gain. (default: 1)
• 11b (of type float?, which defaults to null): set 2093Hz band gain. (default: 1)
• 12b (of type float?, which defaults to null): set 2960Hz band gain. (default: 1)
• 13b (of type float?, which defaults to null): set 4186Hz band gain. (default: 1)
• 14b (of type float?, which defaults to null): set 5920Hz band gain. (default: 1)
• 15b (of type float?, which defaults to null): set 8372Hz band gain. (default: 1)
• 16b (of type float?, which defaults to null): set 11840Hz band gain. (default: 1)
• 17b (of type float?, which defaults to null): set 16744Hz band gain. (default: 1)
• 18b (of type float?, which defaults to null): set 20000Hz band gain. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.surround

Ffmpeg filter: Apply audio surround upmix filter.

Type:

(?chl_out : string?, ?chl_in : string?, ?level_in : float?,
 ?level_out : float?, ?lfe : bool?, ?lfe_low : int?, ?lfe_high : int?,
 ?lfe_mode : int?, ?smooth : float?, ?angle : float?, ?focus : float?,
 ?fc_in : float?, ?fc_out : float?, ?fl_in : float?, ?fl_out : float?,
 ?fr_in : float?, ?fr_out : float?, ?sl_in : float?, ?sl_out : float?,
 ?sr_in : float?, ?sr_out : float?, ?bl_in : float?, ?bl_out : float?,
 ?br_in : float?, ?br_out : float?, ?bc_in : float?, ?bc_out : float?,
 ?lfe_in : float?, ?lfe_out : float?, ?allx : float?, ?ally : float?,
 ?fcx : float?, ?flx : float?, ?frx : float?, ?blx : float?, ?brx : float?,
 ?slx : float?, ?srx : float?, ?bcx : float?, ?fcy : float?, ?fly : float?,
 ?fry : float?, ?bly : float?, ?bry : float?, ?sly : float?, ?sry : float?,
 ?bcy : float?, ?win_size : int?, ?win_func : int?, ?overlap : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• chl_out (of type string?, which defaults to null): set output channel layout. (default: 5.1)
• chl_in (of type string?, which defaults to null): set input channel layout. (default: stereo)
• level_in (of type float?, which defaults to null): set input level. (default: 1)
• level_out (of type float?, which defaults to null): set output level. (default: 1)
• lfe (of type bool?, which defaults to null): output LFE. (default: true)
• lfe_low (of type int?, which defaults to null): LFE low cut off. (default: 128)
• lfe_high (of type int?, which defaults to null): LFE high cut off. (default: 256)
• lfe_mode (of type int?, which defaults to null): set LFE channel mode. (default: 0, possible values: 0 (add), 1 (sub))
• smooth (of type float?, which defaults to null): set temporal smoothness strength. (default: 0)
• angle (of type float?, which defaults to null): set soundfield transform angle. (default: 90)
• focus (of type float?, which defaults to null): set soundfield transform focus. (default: 0)
• fc_in (of type float?, which defaults to null): set front center channel input level. (default: 1)
• fc_out (of type float?, which defaults to null): set front center channel output level. (default: 1)
• fl_in (of type float?, which defaults to null): set front left channel input level. (default: 1)
• fl_out (of type float?, which defaults to null): set front left channel output level. (default: 1)
• fr_in (of type float?, which defaults to null): set front right channel input level. (default: 1)
• fr_out (of type float?, which defaults to null): set front right channel output level. (default: 1)
• sl_in (of type float?, which defaults to null): set side left channel input level. (default: 1)
• sl_out (of type float?, which defaults to null): set side left channel output level. (default: 1)
• sr_in (of type float?, which defaults to null): set side right channel input level. (default: 1)
• sr_out (of type float?, which defaults to null): set side right channel output level. (default: 1)
• bl_in (of type float?, which defaults to null): set back left channel input level. (default: 1)
• bl_out (of type float?, which defaults to null): set back left channel output level. (default: 1)
• br_in (of type float?, which defaults to null): set back right channel input level. (default: 1)
• br_out (of type float?, which defaults to null): set back right channel output level. (default: 1)
• bc_in (of type float?, which defaults to null): set back center channel input level. (default: 1)
• bc_out (of type float?, which defaults to null): set back center channel output level. (default: 1)
• lfe_in (of type float?, which defaults to null): set lfe channel input level. (default: 1)
• lfe_out (of type float?, which defaults to null): set lfe channel output level. (default: 1)
• allx (of type float?, which defaults to null): set all channel's x spread. (default: -1)
• ally (of type float?, which defaults to null): set all channel's y spread. (default: -1)
• fcx (of type float?, which defaults to null): set front center channel x spread. (default: 0.5)
• flx (of type float?, which defaults to null): set front left channel x spread. (default: 0.5)
• frx (of type float?, which defaults to null): set front right channel x spread. (default: 0.5)
• blx (of type float?, which defaults to null): set back left channel x spread. (default: 0.5)
• brx (of type float?, which defaults to null): set back right channel x spread. (default: 0.5)
• slx (of type float?, which defaults to null): set side left channel x spread. (default: 0.5)
• srx (of type float?, which defaults to null): set side right channel x spread. (default: 0.5)
• bcx (of type float?, which defaults to null): set back center channel x spread. (default: 0.5)
• fcy (of type float?, which defaults to null): set front center channel y spread. (default: 0.5)
• fly (of type float?, which defaults to null): set front left channel y spread. (default: 0.5)
• fry (of type float?, which defaults to null): set front right channel y spread. (default: 0.5)
• bly (of type float?, which defaults to null): set back left channel y spread. (default: 0.5)
• bry (of type float?, which defaults to null): set back right channel y spread. (default: 0.5)
• sly (of type float?, which defaults to null): set side left channel y spread. (default: 0.5)
• sry (of type float?, which defaults to null): set side right channel y spread. (default: 0.5)
• bcy (of type float?, which defaults to null): set back center channel y spread. (default: 0.5)
• win_size (of type int?, which defaults to null): set window size. (default: 4096)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.surround.create

Ffmpeg filter: Apply audio surround upmix filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?chl_out : string?, ?chl_in : string?, ?level_in : float?,
 ?level_out : float?, ?lfe : bool?, ?lfe_low : int?, ?lfe_high : int?,
 ?lfe_mode : int?, ?smooth : float?, ?angle : float?, ?focus : float?,
 ?fc_in : float?, ?fc_out : float?, ?fl_in : float?, ?fl_out : float?,
 ?fr_in : float?, ?fr_out : float?, ?sl_in : float?, ?sl_out : float?,
 ?sr_in : float?, ?sr_out : float?, ?bl_in : float?, ?bl_out : float?,
 ?br_in : float?, ?br_out : float?, ?bc_in : float?, ?bc_out : float?,
 ?lfe_in : float?, ?lfe_out : float?, ?allx : float?, ?ally : float?,
 ?fcx : float?, ?flx : float?, ?frx : float?, ?blx : float?, ?brx : float?,
 ?slx : float?, ?srx : float?, ?bcx : float?, ?fcy : float?, ?fly : float?,
 ?fry : float?, ?bly : float?, ?bry : float?, ?sly : float?, ?sry : float?,
 ?bcy : float?, ?win_size : int?, ?win_func : int?, ?overlap : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• chl_out (of type string?, which defaults to null): set output channel layout. (default: 5.1)
• chl_in (of type string?, which defaults to null): set input channel layout. (default: stereo)
• level_in (of type float?, which defaults to null): set input level. (default: 1)
• level_out (of type float?, which defaults to null): set output level. (default: 1)
• lfe (of type bool?, which defaults to null): output LFE. (default: true)
• lfe_low (of type int?, which defaults to null): LFE low cut off. (default: 128)
• lfe_high (of type int?, which defaults to null): LFE high cut off. (default: 256)
• lfe_mode (of type int?, which defaults to null): set LFE channel mode. (default: 0, possible values: 0 (add), 1 (sub))
• smooth (of type float?, which defaults to null): set temporal smoothness strength. (default: 0)
• angle (of type float?, which defaults to null): set soundfield transform angle. (default: 90)
• focus (of type float?, which defaults to null): set soundfield transform focus. (default: 0)
• fc_in (of type float?, which defaults to null): set front center channel input level. (default: 1)
• fc_out (of type float?, which defaults to null): set front center channel output level. (default: 1)
• fl_in (of type float?, which defaults to null): set front left channel input level. (default: 1)
• fl_out (of type float?, which defaults to null): set front left channel output level. (default: 1)
• fr_in (of type float?, which defaults to null): set front right channel input level. (default: 1)
• fr_out (of type float?, which defaults to null): set front right channel output level. (default: 1)
• sl_in (of type float?, which defaults to null): set side left channel input level. (default: 1)
• sl_out (of type float?, which defaults to null): set side left channel output level. (default: 1)
• sr_in (of type float?, which defaults to null): set side right channel input level. (default: 1)
• sr_out (of type float?, which defaults to null): set side right channel output level. (default: 1)
• bl_in (of type float?, which defaults to null): set back left channel input level. (default: 1)
• bl_out (of type float?, which defaults to null): set back left channel output level. (default: 1)
• br_in (of type float?, which defaults to null): set back right channel input level. (default: 1)
• br_out (of type float?, which defaults to null): set back right channel output level. (default: 1)
• bc_in (of type float?, which defaults to null): set back center channel input level. (default: 1)
• bc_out (of type float?, which defaults to null): set back center channel output level. (default: 1)
• lfe_in (of type float?, which defaults to null): set lfe channel input level. (default: 1)
• lfe_out (of type float?, which defaults to null): set lfe channel output level. (default: 1)
• allx (of type float?, which defaults to null): set all channel's x spread. (default: -1)
• ally (of type float?, which defaults to null): set all channel's y spread. (default: -1)
• fcx (of type float?, which defaults to null): set front center channel x spread. (default: 0.5)
• flx (of type float?, which defaults to null): set front left channel x spread. (default: 0.5)
• frx (of type float?, which defaults to null): set front right channel x spread. (default: 0.5)
• blx (of type float?, which defaults to null): set back left channel x spread. (default: 0.5)
• brx (of type float?, which defaults to null): set back right channel x spread. (default: 0.5)
• slx (of type float?, which defaults to null): set side left channel x spread. (default: 0.5)
• srx (of type float?, which defaults to null): set side right channel x spread. (default: 0.5)
• bcx (of type float?, which defaults to null): set back center channel x spread. (default: 0.5)
• fcy (of type float?, which defaults to null): set front center channel y spread. (default: 0.5)
• fly (of type float?, which defaults to null): set front left channel y spread. (default: 0.5)
• fry (of type float?, which defaults to null): set front right channel y spread. (default: 0.5)
• bly (of type float?, which defaults to null): set back left channel y spread. (default: 0.5)
• bry (of type float?, which defaults to null): set back right channel y spread. (default: 0.5)
• sly (of type float?, which defaults to null): set side left channel y spread. (default: 0.5)
• sry (of type float?, which defaults to null): set side right channel y spread. (default: 0.5)
• bcy (of type float?, which defaults to null): set back center channel y spread. (default: 0.5)
• win_size (of type int?, which defaults to null): set window size. (default: 4096)
• win_func (of type int?, which defaults to null): set window function. (default: 1, possible values: 0 (rect), 4 (bartlett), 1 (hann), 1 (hanning), 2 (hamming), 3 (blackman), 5 (welch), 6 (flattop), 7 (bharris), 8 (bnuttall), 11 (bhann), 9 (sine), 10 (nuttall), 12 (lanczos), 13 (gauss), 14 (tukey), 15 (dolph), 16 (cauchy), 17 (parzen), 18 (poisson), 19 (bohman), 20 (kaiser))
• overlap (of type float?, which defaults to null): set window overlap. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.swaprect

Ffmpeg filter: Swap 2 rectangular objects in video.

Type:

(?w : string?, ?h : string?, ?x1 : string?, ?y1 : string?, ?x2 : string?,
 ?y2 : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• w (of type string?, which defaults to null): set rect width. (default: w/2)
• h (of type string?, which defaults to null): set rect height. (default: h/2)
• x1 (of type string?, which defaults to null): set 1st rect x top left coordinate. (default: w/2)
• y1 (of type string?, which defaults to null): set 1st rect y top left coordinate. (default: h/2)
• x2 (of type string?, which defaults to null): set 2nd rect x top left coordinate. (default: 0)
• y2 (of type string?, which defaults to null): set 2nd rect y top left coordinate. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.swaprect.create

Ffmpeg filter: Swap 2 rectangular objects in video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?w : string?, ?h : string?, ?x1 : string?, ?y1 : string?, ?x2 : string?,
 ?y2 : string?, ffmpeg.filter.graph) -> unit

Arguments:

• w (of type string?, which defaults to null): set rect width. (default: w/2)
• h (of type string?, which defaults to null): set rect height. (default: h/2)
• x1 (of type string?, which defaults to null): set 1st rect x top left coordinate. (default: w/2)
• y1 (of type string?, which defaults to null): set 1st rect y top left coordinate. (default: h/2)
• x2 (of type string?, which defaults to null): set 2nd rect x top left coordinate. (default: 0)
• y2 (of type string?, which defaults to null): set 2nd rect y top left coordinate. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.swapuv

Ffmpeg filter: Swap U and V components.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.swapuv.create

Ffmpeg filter: Swap U and V components. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tblend

Ffmpeg filter: Blend successive frames.

Type:

(?c0_mode : int?, ?c1_mode : int?, ?c2_mode : int?, ?c3_mode : int?,
 ?all_mode : int?, ?c0_expr : string?, ?c1_expr : string?,
 ?c2_expr : string?, ?c3_expr : string?, ?all_expr : string?,
 ?c0_opacity : float?, ?c1_opacity : float?, ?c2_opacity : float?,
 ?c3_opacity : float?, ?all_opacity : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• c0_mode (of type int?, which defaults to null): set component #0 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c1_mode (of type int?, which defaults to null): set component #1 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c2_mode (of type int?, which defaults to null): set component #2 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c3_mode (of type int?, which defaults to null): set component #3 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• all_mode (of type int?, which defaults to null): set blend mode for all components. (default: -1, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c0_expr (of type string?, which defaults to null): set color component #0 expression
• c1_expr (of type string?, which defaults to null): set color component #1 expression
• c2_expr (of type string?, which defaults to null): set color component #2 expression
• c3_expr (of type string?, which defaults to null): set color component #3 expression
• all_expr (of type string?, which defaults to null): set expression for all color components
• c0_opacity (of type float?, which defaults to null): set color component #0 opacity. (default: 1)
• c1_opacity (of type float?, which defaults to null): set color component #1 opacity. (default: 1)
• c2_opacity (of type float?, which defaults to null): set color component #2 opacity. (default: 1)
• c3_opacity (of type float?, which defaults to null): set color component #3 opacity. (default: 1)
• all_opacity (of type float?, which defaults to null): set opacity for all color components. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tblend.create

Ffmpeg filter: Blend successive frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?c0_mode : int?, ?c1_mode : int?, ?c2_mode : int?, ?c3_mode : int?,
 ?all_mode : int?, ?c0_expr : string?, ?c1_expr : string?,
 ?c2_expr : string?, ?c3_expr : string?, ?all_expr : string?,
 ?c0_opacity : float?, ?c1_opacity : float?, ?c2_opacity : float?,
 ?c3_opacity : float?, ?all_opacity : float?, ffmpeg.filter.graph) -> unit

Arguments:

• c0_mode (of type int?, which defaults to null): set component #0 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c1_mode (of type int?, which defaults to null): set component #1 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c2_mode (of type int?, which defaults to null): set component #2 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c3_mode (of type int?, which defaults to null): set component #3 blend mode. (default: 0, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• all_mode (of type int?, which defaults to null): set blend mode for all components. (default: -1, possible values: 1 (addition), 28 (addition128), 28 (grainmerge), 2 (and), 3 (average), 4 (burn), 5 (darken), 6 (difference), 7 (difference128), 7 (grainextract), 8 (divide), 9 (dodge), 10 (exclusion), 32 (extremity), 31 (freeze), 27 (glow), 11 (hardlight), 25 (hardmix), 30 (heat), 12 (lighten), 26 (linearlight), 13 (multiply), 29 (multiply128), 14 (negation), 0 (normal), 15 (or), 16 (overlay), 17 (phoenix), 18 (pinlight), 19 (reflect), 20 (screen), 21 (softlight), 22 (subtract), 23 (vividlight), 24 (xor), 33 (softdifference), 34 (geometric), 35 (harmonic), 36 (bleach), 37 (stain), 38 (interpolate), 39 (hardoverlay))
• c0_expr (of type string?, which defaults to null): set color component #0 expression
• c1_expr (of type string?, which defaults to null): set color component #1 expression
• c2_expr (of type string?, which defaults to null): set color component #2 expression
• c3_expr (of type string?, which defaults to null): set color component #3 expression
• all_expr (of type string?, which defaults to null): set expression for all color components
• c0_opacity (of type float?, which defaults to null): set color component #0 opacity. (default: 1)
• c1_opacity (of type float?, which defaults to null): set color component #1 opacity. (default: 1)
• c2_opacity (of type float?, which defaults to null): set color component #2 opacity. (default: 1)
• c3_opacity (of type float?, which defaults to null): set color component #3 opacity. (default: 1)
• all_opacity (of type float?, which defaults to null): set opacity for all color components. (default: 1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.telecine

Ffmpeg filter: Apply a telecine pattern.

Type:

(?first_field : int?, ?pattern : string?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• first_field (of type int?, which defaults to null): select first field. (default: 0, possible values: 0 (top), 0 (t), 1 (bottom), 1 (b))
• pattern (of type string?, which defaults to null): pattern that describe for how many fields a frame is to be displayed. (default: 23)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.telecine.create

Ffmpeg filter: Apply a telecine pattern. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?first_field : int?, ?pattern : string?, ffmpeg.filter.graph) -> unit

Arguments:

• first_field (of type int?, which defaults to null): select first field. (default: 0, possible values: 0 (top), 0 (t), 1 (bottom), 1 (b))
• pattern (of type string?, which defaults to null): pattern that describe for how many fields a frame is to be displayed. (default: 23)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.testsrc

Ffmpeg filter: Generate test pattern.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?decimals : int?, ?n : int?,
 ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• decimals (of type int?, which defaults to null): set number of decimals to show. (default: 0)
• n (of type int?, which defaults to null): set number of decimals to show. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.testsrc.create

Ffmpeg filter: Generate test pattern. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?decimals : int?, ?n : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• decimals (of type int?, which defaults to null): set number of decimals to show. (default: 0)
• n (of type int?, which defaults to null): set number of decimals to show. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.testsrc2

Ffmpeg filter: Generate another test pattern.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?alpha : int?,
 ffmpeg.filter.graph) -> ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• alpha (of type int?, which defaults to null): set global alpha (opacity). (default: 255)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.testsrc2.create

Ffmpeg filter: Generate another test pattern. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?alpha : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• alpha (of type int?, which defaults to null): set global alpha (opacity). (default: 255)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.thistogram

Ffmpeg filter: Compute and draw a temporal histogram.

Type:

(?width : int?, ?w : int?, ?display_mode : int?, ?d : int?,
 ?levels_mode : int?, ?m : int?, ?components : int?, ?c : int?,
 ?bgopacity : float?, ?b : float?, ?envelope : bool?, ?e : bool?,
 ?ecolor : string?, ?ec : string?, ?slide : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• width (of type int?, which defaults to null): set width. (default: 0)
• w (of type int?, which defaults to null): set width. (default: 0)
• display_mode (of type int?, which defaults to null): set display mode. (default: 2, possible values: 0 (overlay), 1 (parade), 2 (stack))
• d (of type int?, which defaults to null): set display mode. (default: 2, possible values: 0 (overlay), 1 (parade), 2 (stack))
• levels_mode (of type int?, which defaults to null): set levels mode. (default: 0, possible values: 0 (linear), 1 (logarithmic))
• m (of type int?, which defaults to null): set levels mode. (default: 0, possible values: 0 (linear), 1 (logarithmic))
• components (of type int?, which defaults to null): set color components to display. (default: 7)
• c (of type int?, which defaults to null): set color components to display. (default: 7)
• bgopacity (of type float?, which defaults to null): set background opacity. (default: 0.9)
• b (of type float?, which defaults to null): set background opacity. (default: 0.9)
• envelope (of type bool?, which defaults to null): display envelope. (default: false)
• e (of type bool?, which defaults to null): display envelope. (default: false)
• ecolor (of type string?, which defaults to null): set envelope color. (default: gold)
• ec (of type string?, which defaults to null): set envelope color. (default: gold)
• slide (of type int?, which defaults to null): set slide mode. (default: 1, possible values: 0 (frame), 1 (replace), 2 (scroll), 3 (rscroll), 4 (picture))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.thistogram.create

Ffmpeg filter: Compute and draw a temporal histogram. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?width : int?, ?w : int?, ?display_mode : int?, ?d : int?,
 ?levels_mode : int?, ?m : int?, ?components : int?, ?c : int?,
 ?bgopacity : float?, ?b : float?, ?envelope : bool?, ?e : bool?,
 ?ecolor : string?, ?ec : string?, ?slide : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• width (of type int?, which defaults to null): set width. (default: 0)
• w (of type int?, which defaults to null): set width. (default: 0)
• display_mode (of type int?, which defaults to null): set display mode. (default: 2, possible values: 0 (overlay), 1 (parade), 2 (stack))
• d (of type int?, which defaults to null): set display mode. (default: 2, possible values: 0 (overlay), 1 (parade), 2 (stack))
• levels_mode (of type int?, which defaults to null): set levels mode. (default: 0, possible values: 0 (linear), 1 (logarithmic))
• m (of type int?, which defaults to null): set levels mode. (default: 0, possible values: 0 (linear), 1 (logarithmic))
• components (of type int?, which defaults to null): set color components to display. (default: 7)
• c (of type int?, which defaults to null): set color components to display. (default: 7)
• bgopacity (of type float?, which defaults to null): set background opacity. (default: 0.9)
• b (of type float?, which defaults to null): set background opacity. (default: 0.9)
• envelope (of type bool?, which defaults to null): display envelope. (default: false)
• e (of type bool?, which defaults to null): display envelope. (default: false)
• ecolor (of type string?, which defaults to null): set envelope color. (default: gold)
• ec (of type string?, which defaults to null): set envelope color. (default: gold)
• slide (of type int?, which defaults to null): set slide mode. (default: 1, possible values: 0 (frame), 1 (replace), 2 (scroll), 3 (rscroll), 4 (picture))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.threshold

Ffmpeg filter: Threshold first video stream using other video streams.

Type:

(?planes : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.threshold.create

Ffmpeg filter: Threshold first video stream using other video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.thumbnail

Ffmpeg filter: Select the most representative frame in a given sequence of consecutive frames.

Type:

(?n : int?, ?log : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• n (of type int?, which defaults to null): set the frames batch size. (default: 100)
• log (of type int?, which defaults to null): force stats logging level. (default: 32, possible values: -8 (quiet), 32 (info), 40 (verbose))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.thumbnail.create

Ffmpeg filter: Select the most representative frame in a given sequence of consecutive frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?n : int?, ?log : int?, ffmpeg.filter.graph) -> unit

Arguments:

• n (of type int?, which defaults to null): set the frames batch size. (default: 100)
• log (of type int?, which defaults to null): force stats logging level. (default: 32, possible values: -8 (quiet), 32 (info), 40 (verbose))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tile

Ffmpeg filter: Tile several successive frames together.

Type:

(?layout : string?, ?nb_frames : int?, ?margin : int?, ?padding : int?,
 ?color : string?, ?overlap : int?, ?init_padding : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• layout (of type string?, which defaults to null): set grid size. (default: 6x5)
• nb_frames (of type int?, which defaults to null): set maximum number of frame to render. (default: 0)
• margin (of type int?, which defaults to null): set outer border margin in pixels. (default: 0)
• padding (of type int?, which defaults to null): set inner border thickness in pixels. (default: 0)
• color (of type string?, which defaults to null): set the color of the unused area. (default: black)
• overlap (of type int?, which defaults to null): set how many frames to overlap for each render. (default: 0)
• init_padding (of type int?, which defaults to null): set how many frames to initially pad. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tile.create

Ffmpeg filter: Tile several successive frames together. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?layout : string?, ?nb_frames : int?, ?margin : int?, ?padding : int?,
 ?color : string?, ?overlap : int?, ?init_padding : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• layout (of type string?, which defaults to null): set grid size. (default: 6x5)
• nb_frames (of type int?, which defaults to null): set maximum number of frame to render. (default: 0)
• margin (of type int?, which defaults to null): set outer border margin in pixels. (default: 0)
• padding (of type int?, which defaults to null): set inner border thickness in pixels. (default: 0)
• color (of type string?, which defaults to null): set the color of the unused area. (default: black)
• overlap (of type int?, which defaults to null): set how many frames to overlap for each render. (default: 0)
• init_padding (of type int?, which defaults to null): set how many frames to initially pad. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tiltandshift

Ffmpeg filter: Generate a tilt-and-shift'd video.

Type:

(?tilt : int?, ?start : int?, ?end : int?, ?hold : int?, ?pad : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• tilt (of type int?, which defaults to null): Tilt the video horizontally while shifting. (default: 1)
• start (of type int?, which defaults to null): Action at the start of input. (default: 0, possible values: 0 (none), 1 (frame), 2 (black))
• end (of type int?, which defaults to null): Action at the end of input. (default: 0, possible values: 0 (none), 1 (frame), 2 (black))
• hold (of type int?, which defaults to null): Number of columns to hold at the start of the video. (default: 0)
• pad (of type int?, which defaults to null): Number of columns to pad at the end of the video. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tiltandshift.create

Ffmpeg filter: Generate a tilt-and-shift'd video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?tilt : int?, ?start : int?, ?end : int?, ?hold : int?, ?pad : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• tilt (of type int?, which defaults to null): Tilt the video horizontally while shifting. (default: 1)
• start (of type int?, which defaults to null): Action at the start of input. (default: 0, possible values: 0 (none), 1 (frame), 2 (black))
• end (of type int?, which defaults to null): Action at the end of input. (default: 0, possible values: 0 (none), 1 (frame), 2 (black))
• hold (of type int?, which defaults to null): Number of columns to hold at the start of the video. (default: 0)
• pad (of type int?, which defaults to null): Number of columns to pad at the end of the video. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tiltshelf

Ffmpeg filter: Apply a tilt shelf filter.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.tiltshelf.create

Ffmpeg filter: Apply a tilt shelf filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tinterlace

Ffmpeg filter: Perform temporal field interlacing.

Type:

(?mode : int?, ?flags : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): select interlace mode. (default: 0, possible values: 0 (merge), 1 (drop_even), 2 (drop_odd), 3 (pad), 4 (interleave_top), 5 (interleave_bottom), 6 (interlacex2), 7 (mergex2))
• flags (of type int?, which defaults to null): set flags. (default: 0, possible values: 1 (low_pass_filter), 1 (vlpf), 2 (complex_filter), 2 (cvlpf), 4 (exact_tb), 8 (bypass_il), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tinterlace.create

Ffmpeg filter: Perform temporal field interlacing. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?flags : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): select interlace mode. (default: 0, possible values: 0 (merge), 1 (drop_even), 2 (drop_odd), 3 (pad), 4 (interleave_top), 5 (interleave_bottom), 6 (interlacex2), 7 (mergex2))
• flags (of type int?, which defaults to null): set flags. (default: 0, possible values: 1 (low_pass_filter), 1 (vlpf), 2 (complex_filter), 2 (cvlpf), 4 (exact_tb), 8 (bypass_il), combined by addition)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tlut2

Ffmpeg filter: Compute and apply a lookup table from two successive frames.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: x)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: x)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: x)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: x)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tlut2.create

Ffmpeg filter: Compute and apply a lookup table from two successive frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?c0 : string?, ?c1 : string?, ?c2 : string?, ?c3 : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• c0 (of type string?, which defaults to null): set component #0 expression. (default: x)
• c1 (of type string?, which defaults to null): set component #1 expression. (default: x)
• c2 (of type string?, which defaults to null): set component #2 expression. (default: x)
• c3 (of type string?, which defaults to null): set component #3 expression. (default: x)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tmedian

Ffmpeg filter: Pick median pixels from successive frames.

Type:

(?radius : int?, ?planes : int?, ?percentile : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• radius (of type int?, which defaults to null): set median filter radius. (default: 1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• percentile (of type float?, which defaults to null): set percentile. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tmedian.create

Ffmpeg filter: Pick median pixels from successive frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?radius : int?, ?planes : int?, ?percentile : float?, ffmpeg.filter.graph) ->
unit

Arguments:

• radius (of type int?, which defaults to null): set median filter radius. (default: 1)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• percentile (of type float?, which defaults to null): set percentile. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tmidequalizer

Ffmpeg filter: Apply Temporal Midway Equalization.

Type:

(?radius : int?, ?sigma : float?, ?planes : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• radius (of type int?, which defaults to null): set radius. (default: 5)
• sigma (of type float?, which defaults to null): set sigma. (default: 0.5)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tmidequalizer.create

Ffmpeg filter: Apply Temporal Midway Equalization. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?radius : int?, ?sigma : float?, ?planes : int?, ffmpeg.filter.graph) ->
unit

Arguments:

• radius (of type int?, which defaults to null): set radius. (default: 5)
• sigma (of type float?, which defaults to null): set sigma. (default: 0.5)
• planes (of type int?, which defaults to null): set planes. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tmix

Ffmpeg filter: Mix successive video frames.

Type:

(?frames : int?, ?weights : string?, ?scale : float?, ?planes : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• frames (of type int?, which defaults to null): set number of successive frames to mix. (default: 3)
• weights (of type string?, which defaults to null): set weight for each frame. (default: 1 1 1)
• scale (of type float?, which defaults to null): set scale. (default: 0)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tmix.create

Ffmpeg filter: Mix successive video frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frames : int?, ?weights : string?, ?scale : float?, ?planes : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• frames (of type int?, which defaults to null): set number of successive frames to mix. (default: 3)
• weights (of type string?, which defaults to null): set weight for each frame. (default: 1 1 1)
• scale (of type float?, which defaults to null): set scale. (default: 0)
• planes (of type int?, which defaults to null): set what planes to filter. (default: 15)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tonemap

Ffmpeg filter: Conversion to/from different dynamic ranges.

Type:

(?tonemap : int?, ?param : float?, ?desat : float?, ?peak : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• tonemap (of type int?, which defaults to null): tonemap algorithm selection. (default: 0, possible values: 0 (none), 1 (linear), 2 (gamma), 3 (clip), 4 (reinhard), 5 (hable), 6 (mobius))
• param (of type float?, which defaults to null): tonemap parameter. (default: nan)
• desat (of type float?, which defaults to null): desaturation strength. (default: 2)
• peak (of type float?, which defaults to null): signal peak override. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tonemap.create

Ffmpeg filter: Conversion to/from different dynamic ranges. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?tonemap : int?, ?param : float?, ?desat : float?, ?peak : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• tonemap (of type int?, which defaults to null): tonemap algorithm selection. (default: 0, possible values: 0 (none), 1 (linear), 2 (gamma), 3 (clip), 4 (reinhard), 5 (hable), 6 (mobius))
• param (of type float?, which defaults to null): tonemap parameter. (default: nan)
• desat (of type float?, which defaults to null): desaturation strength. (default: 2)
• peak (of type float?, which defaults to null): signal peak override. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tpad

Ffmpeg filter: Temporarily pad video frames.

Type:

(?start : int?, ?stop : int?, ?start_mode : int?, ?stop_mode : int?,
 ?start_duration : int?, ?stop_duration : int?, ?color : string?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• start (of type int?, which defaults to null): set the number of frames to delay input. (default: 0)
• stop (of type int?, which defaults to null): set the number of frames to add after input finished. (default: 0)
• start_mode (of type int?, which defaults to null): set the mode of added frames to start. (default: 0, possible values: 0 (add), 1 (clone))
• stop_mode (of type int?, which defaults to null): set the mode of added frames to end. (default: 0, possible values: 0 (add), 1 (clone))
• start_duration (of type int?, which defaults to null): set the duration to delay input. (default: 0)
• stop_duration (of type int?, which defaults to null): set the duration to pad input. (default: 0)
• color (of type string?, which defaults to null): set the color of the added frames. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.tpad.create

Ffmpeg filter: Temporarily pad video frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?start : int?, ?stop : int?, ?start_mode : int?, ?stop_mode : int?,
 ?start_duration : int?, ?stop_duration : int?, ?color : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• start (of type int?, which defaults to null): set the number of frames to delay input. (default: 0)
• stop (of type int?, which defaults to null): set the number of frames to add after input finished. (default: 0)
• start_mode (of type int?, which defaults to null): set the mode of added frames to start. (default: 0, possible values: 0 (add), 1 (clone))
• stop_mode (of type int?, which defaults to null): set the mode of added frames to end. (default: 0, possible values: 0 (add), 1 (clone))
• start_duration (of type int?, which defaults to null): set the duration to delay input. (default: 0)
• stop_duration (of type int?, which defaults to null): set the duration to pad input. (default: 0)
• color (of type string?, which defaults to null): set the color of the added frames. (default: black)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.transpose

Ffmpeg filter: Transpose input video.

Type:

(?dir : int?, ?passthrough : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• dir (of type int?, which defaults to null): set transpose direction. (default: 0, possible values: 0 (cclock_flip), 1 (clock), 2 (cclock), 3 (clock_flip))
• passthrough (of type int?, which defaults to null): do not apply transposition if the input matches the specified geometry. (default: 0, possible values: 0 (none), 2 (portrait), 1 (landscape))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.transpose.create

Ffmpeg filter: Transpose input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?dir : int?, ?passthrough : int?, ffmpeg.filter.graph) -> unit

Arguments:

• dir (of type int?, which defaults to null): set transpose direction. (default: 0, possible values: 0 (cclock_flip), 1 (clock), 2 (cclock), 3 (clock_flip))
• passthrough (of type int?, which defaults to null): do not apply transposition if the input matches the specified geometry. (default: 0, possible values: 0 (none), 2 (portrait), 1 (landscape))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.treble

Ffmpeg filter: Boost or cut upper frequencies.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.treble.create

Ffmpeg filter: Boost or cut upper frequencies. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?frequency : float?, ?f : float?, ?width_type : int?, ?t : int?,
 ?width : float?, ?w : float?, ?gain : float?, ?g : float?, ?poles : int?,
 ?p : int?, ?mix : float?, ?m : float?, ?channels : string?, ?c : string?,
 ?normalize : bool?, ?n : bool?, ?transform : int?, ?a : int?,
 ?precision : int?, ?r : int?, ?blocksize : int?, ?b : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• frequency (of type float?, which defaults to null): set central frequency. (default: 3000)
• f (of type float?, which defaults to null): set central frequency. (default: 3000)
• width_type (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• t (of type int?, which defaults to null): set filter-width type. (default: 3, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
• width (of type float?, which defaults to null): set width. (default: 0.5)
• w (of type float?, which defaults to null): set width. (default: 0.5)
• gain (of type float?, which defaults to null): set gain. (default: 0)
• g (of type float?, which defaults to null): set gain. (default: 0)
• poles (of type int?, which defaults to null): set number of poles. (default: 2)
• p (of type int?, which defaults to null): set number of poles. (default: 2)
• mix (of type float?, which defaults to null): set mix. (default: 1)
• m (of type float?, which defaults to null): set mix. (default: 1)
• channels (of type string?, which defaults to null): set channels to filter. (default: all)
• c (of type string?, which defaults to null): set channels to filter. (default: all)
• normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
• n (of type bool?, which defaults to null): normalize coefficients. (default: false)
• transform (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• a (of type int?, which defaults to null): set transform type. (default: 0, possible values: 0 (di), 1 (dii), 2 (tdi), 3 (tdii), 4 (latt), 5 (svf), 6 (zdf))
• precision (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• r (of type int?, which defaults to null): set filtering precision. (default: -1, possible values: -1 (auto), 0 (s16), 1 (s32), 2 (f32), 3 (f64))
• blocksize (of type int?, which defaults to null): set the block size. (default: 0)
• b (of type int?, which defaults to null): set the block size. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.tremolo

Ffmpeg filter: Apply tremolo effect.

Type:

(?f : float?, ?d : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• f (of type float?, which defaults to null): set frequency in hertz. (default: 5)
• d (of type float?, which defaults to null): set depth as percentage. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.tremolo.create

Ffmpeg filter: Apply tremolo effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?f : float?, ?d : float?, ffmpeg.filter.graph) -> unit

Arguments:

• f (of type float?, which defaults to null): set frequency in hertz. (default: 5)
• d (of type float?, which defaults to null): set depth as percentage. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.trim

Ffmpeg filter: Pick one continuous section from the input, drop the rest.

Type:

(?start : int?, ?starti : int?, ?end : int?, ?endi : int?, ?start_pts : int?,
 ?end_pts : int?, ?duration : int?, ?durationi : int?, ?start_frame : int?,
 ?end_frame : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• start (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854.775)
• starti (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854.775)
• end (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854.775)
• endi (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854.775)
• start_pts (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: -9223372036854775808)
• end_pts (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: -9223372036854775808)
• duration (of type int?, which defaults to null): Maximum duration of the output. (default: 0)
• durationi (of type int?, which defaults to null): Maximum duration of the output. (default: 0)
• start_frame (of type int?, which defaults to null): Number of the first frame that should be passed to the output. (default: -1)
• end_frame (of type int?, which defaults to null): Number of the first frame that should be dropped again. (default: 9223372036854775807)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.trim.create

Ffmpeg filter: Pick one continuous section from the input, drop the rest. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?start : int?, ?starti : int?, ?end : int?, ?endi : int?, ?start_pts : int?,
 ?end_pts : int?, ?duration : int?, ?durationi : int?, ?start_frame : int?,
 ?end_frame : int?, ffmpeg.filter.graph) -> unit

Arguments:

• start (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854.775)
• starti (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854.775)
• end (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854.775)
• endi (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854.775)
• start_pts (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: -9223372036854775808)
• end_pts (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: -9223372036854775808)
• duration (of type int?, which defaults to null): Maximum duration of the output. (default: 0)
• durationi (of type int?, which defaults to null): Maximum duration of the output. (default: 0)
• start_frame (of type int?, which defaults to null): Number of the first frame that should be passed to the output. (default: -1)
• end_frame (of type int?, which defaults to null): Number of the first frame that should be dropped again. (default: 9223372036854775807)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.unpremultiply

Ffmpeg filter: UnPreMultiply first stream with first plane of second stream. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?planes : int?, ?inplace : bool?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• inplace (of type bool?, which defaults to null): enable inplace mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.unpremultiply.create

Ffmpeg filter: UnPreMultiply first stream with first plane of second stream. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?inplace : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes. (default: 15)
• inplace (of type bool?, which defaults to null): enable inplace mode. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.unsharp

Ffmpeg filter: Sharpen or blur the input video.

Type:

(?luma_msize_x : int?, ?lx : int?, ?luma_msize_y : int?, ?ly : int?,
 ?luma_amount : float?, ?la : float?, ?chroma_msize_x : int?, ?cx : int?,
 ?chroma_msize_y : int?, ?cy : int?, ?chroma_amount : float?, ?ca : float?,
 ?alpha_msize_x : int?, ?ax : int?, ?alpha_msize_y : int?, ?ay : int?,
 ?alpha_amount : float?, ?aa : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• luma_msize_x (of type int?, which defaults to null): set luma matrix horizontal size. (default: 5)
• lx (of type int?, which defaults to null): set luma matrix horizontal size. (default: 5)
• luma_msize_y (of type int?, which defaults to null): set luma matrix vertical size. (default: 5)
• ly (of type int?, which defaults to null): set luma matrix vertical size. (default: 5)
• luma_amount (of type float?, which defaults to null): set luma effect strength. (default: 1)
• la (of type float?, which defaults to null): set luma effect strength. (default: 1)
• chroma_msize_x (of type int?, which defaults to null): set chroma matrix horizontal size. (default: 5)
• cx (of type int?, which defaults to null): set chroma matrix horizontal size. (default: 5)
• chroma_msize_y (of type int?, which defaults to null): set chroma matrix vertical size. (default: 5)
• cy (of type int?, which defaults to null): set chroma matrix vertical size. (default: 5)
• chroma_amount (of type float?, which defaults to null): set chroma effect strength. (default: 0)
• ca (of type float?, which defaults to null): set chroma effect strength. (default: 0)
• alpha_msize_x (of type int?, which defaults to null): set alpha matrix horizontal size. (default: 5)
• ax (of type int?, which defaults to null): set alpha matrix horizontal size. (default: 5)
• alpha_msize_y (of type int?, which defaults to null): set alpha matrix vertical size. (default: 5)
• ay (of type int?, which defaults to null): set alpha matrix vertical size. (default: 5)
• alpha_amount (of type float?, which defaults to null): set alpha effect strength. (default: 0)
• aa (of type float?, which defaults to null): set alpha effect strength. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.unsharp.create

Ffmpeg filter: Sharpen or blur the input video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?luma_msize_x : int?, ?lx : int?, ?luma_msize_y : int?, ?ly : int?,
 ?luma_amount : float?, ?la : float?, ?chroma_msize_x : int?, ?cx : int?,
 ?chroma_msize_y : int?, ?cy : int?, ?chroma_amount : float?, ?ca : float?,
 ?alpha_msize_x : int?, ?ax : int?, ?alpha_msize_y : int?, ?ay : int?,
 ?alpha_amount : float?, ?aa : float?, ffmpeg.filter.graph) -> unit

Arguments:

• luma_msize_x (of type int?, which defaults to null): set luma matrix horizontal size. (default: 5)
• lx (of type int?, which defaults to null): set luma matrix horizontal size. (default: 5)
• luma_msize_y (of type int?, which defaults to null): set luma matrix vertical size. (default: 5)
• ly (of type int?, which defaults to null): set luma matrix vertical size. (default: 5)
• luma_amount (of type float?, which defaults to null): set luma effect strength. (default: 1)
• la (of type float?, which defaults to null): set luma effect strength. (default: 1)
• chroma_msize_x (of type int?, which defaults to null): set chroma matrix horizontal size. (default: 5)
• cx (of type int?, which defaults to null): set chroma matrix horizontal size. (default: 5)
• chroma_msize_y (of type int?, which defaults to null): set chroma matrix vertical size. (default: 5)
• cy (of type int?, which defaults to null): set chroma matrix vertical size. (default: 5)
• chroma_amount (of type float?, which defaults to null): set chroma effect strength. (default: 0)
• ca (of type float?, which defaults to null): set chroma effect strength. (default: 0)
• alpha_msize_x (of type int?, which defaults to null): set alpha matrix horizontal size. (default: 5)
• ax (of type int?, which defaults to null): set alpha matrix horizontal size. (default: 5)
• alpha_msize_y (of type int?, which defaults to null): set alpha matrix vertical size. (default: 5)
• ay (of type int?, which defaults to null): set alpha matrix vertical size. (default: 5)
• alpha_amount (of type float?, which defaults to null): set alpha effect strength. (default: 0)
• aa (of type float?, which defaults to null): set alpha effect strength. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.untile

Ffmpeg filter: Untile a frame into a sequence of frames.

Type:

(?layout : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• layout (of type string?, which defaults to null): set grid size. (default: 6x5)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.untile.create

Ffmpeg filter: Untile a frame into a sequence of frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?layout : string?, ffmpeg.filter.graph) -> unit

Arguments:

• layout (of type string?, which defaults to null): set grid size. (default: 6x5)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.uspp

Ffmpeg filter: Apply Ultra Simple / Slow Post-processing filter.

Type:

(?quality : int?, ?qp : int?, ?use_bframe_qp : bool?, ?codec : string?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• quality (of type int?, which defaults to null): set quality. (default: 3)
• qp (of type int?, which defaults to null): force a constant quantizer parameter. (default: 0)
• use_bframe_qp (of type bool?, which defaults to null): use B-frames' QP. (default: false)
• codec (of type string?, which defaults to null): Codec name. (default: snow)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.uspp.create

Ffmpeg filter: Apply Ultra Simple / Slow Post-processing filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?quality : int?, ?qp : int?, ?use_bframe_qp : bool?, ?codec : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• quality (of type int?, which defaults to null): set quality. (default: 3)
• qp (of type int?, which defaults to null): force a constant quantizer parameter. (default: 0)
• use_bframe_qp (of type bool?, which defaults to null): use B-frames' QP. (default: false)
• codec (of type string?, which defaults to null): Codec name. (default: snow)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.v360

Ffmpeg filter: Convert 360 projection of video.

Type:

(?input : int?, ?output : int?, ?interp : int?, ?w : int?, ?h : int?,
 ?in_stereo : int?, ?out_stereo : int?, ?in_forder : string?,
 ?out_forder : string?, ?in_frot : string?, ?out_frot : string?,
 ?in_pad : float?, ?out_pad : float?, ?fin_pad : int?, ?fout_pad : int?,
 ?yaw : float?, ?pitch : float?, ?roll : float?, ?rorder : string?,
 ?h_fov : float?, ?v_fov : float?, ?d_fov : float?, ?h_flip : bool?,
 ?v_flip : bool?, ?d_flip : bool?, ?ih_flip : bool?, ?iv_flip : bool?,
 ?in_trans : bool?, ?out_trans : bool?, ?ih_fov : float?, ?iv_fov : float?,
 ?id_fov : float?, ?h_offset : float?, ?v_offset : float?,
 ?alpha_mask : bool?, ?reset_rot : bool?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• input (of type int?, which defaults to null): set input projection. (default: 0, possible values: 0 (e), 0 (equirect), 1 (c3x2), 2 (c6x1), 3 (eac), 5 (dfisheye), 4 (flat), 4 (rectilinear), 4 (gnomonic), 6 (barrel), 6 (fb), 7 (c1x6), 8 (sg), 9 (mercator), 10 (ball), 11 (hammer), 12 (sinusoidal), 13 (fisheye), 14 (pannini), 15 (cylindrical), 17 (tetrahedron), 18 (barrelsplit), 19 (tsp), 20 (hequirect), 20 (he), 21 (equisolid), 22 (og), 23 (octahedron), 24 (cylindricalea))
• output (of type int?, which defaults to null): set output projection. (default: 1, possible values: 0 (e), 0 (equirect), 1 (c3x2), 2 (c6x1), 3 (eac), 5 (dfisheye), 4 (flat), 4 (rectilinear), 4 (gnomonic), 6 (barrel), 6 (fb), 7 (c1x6), 8 (sg), 9 (mercator), 10 (ball), 11 (hammer), 12 (sinusoidal), 13 (fisheye), 14 (pannini), 15 (cylindrical), 16 (perspective), 17 (tetrahedron), 18 (barrelsplit), 19 (tsp), 20 (hequirect), 20 (he), 21 (equisolid), 22 (og), 23 (octahedron), 24 (cylindricalea))
• interp (of type int?, which defaults to null): set interpolation method. (default: 1, possible values: 0 (near), 0 (nearest), 1 (line), 1 (linear), 2 (lagrange9), 3 (cube), 3 (cubic), 4 (lanc), 4 (lanczos), 5 (sp16), 5 (spline16), 6 (gauss), 6 (gaussian), 7 (mitchell))
• w (of type int?, which defaults to null): output width. (default: 0)
• h (of type int?, which defaults to null): output height. (default: 0)
• in_stereo (of type int?, which defaults to null): input stereo format. (default: 0, possible values: 0 (2d), 1 (sbs), 2 (tb))
• out_stereo (of type int?, which defaults to null): output stereo format. (default: 0, possible values: 0 (2d), 1 (sbs), 2 (tb))
• in_forder (of type string?, which defaults to null): input cubemap face order. (default: rludfb)
• out_forder (of type string?, which defaults to null): output cubemap face order. (default: rludfb)
• in_frot (of type string?, which defaults to null): input cubemap face rotation. (default: 000000)
• out_frot (of type string?, which defaults to null): output cubemap face rotation. (default: 000000)
• in_pad (of type float?, which defaults to null): percent input cubemap pads. (default: 0)
• out_pad (of type float?, which defaults to null): percent output cubemap pads. (default: 0)
• fin_pad (of type int?, which defaults to null): fixed input cubemap pads. (default: 0)
• fout_pad (of type int?, which defaults to null): fixed output cubemap pads. (default: 0)
• yaw (of type float?, which defaults to null): yaw rotation. (default: 0)
• pitch (of type float?, which defaults to null): pitch rotation. (default: 0)
• roll (of type float?, which defaults to null): roll rotation. (default: 0)
• rorder (of type string?, which defaults to null): rotation order. (default: ypr)
• h_fov (of type float?, which defaults to null): output horizontal field of view. (default: 0)
• v_fov (of type float?, which defaults to null): output vertical field of view. (default: 0)
• d_fov (of type float?, which defaults to null): output diagonal field of view. (default: 0)
• h_flip (of type bool?, which defaults to null): flip out video horizontally. (default: false)
• v_flip (of type bool?, which defaults to null): flip out video vertically. (default: false)
• d_flip (of type bool?, which defaults to null): flip out video indepth. (default: false)
• ih_flip (of type bool?, which defaults to null): flip in video horizontally. (default: false)
• iv_flip (of type bool?, which defaults to null): flip in video vertically. (default: false)
• in_trans (of type bool?, which defaults to null): transpose video input. (default: false)
• out_trans (of type bool?, which defaults to null): transpose video output. (default: false)
• ih_fov (of type float?, which defaults to null): input horizontal field of view. (default: 0)
• iv_fov (of type float?, which defaults to null): input vertical field of view. (default: 0)
• id_fov (of type float?, which defaults to null): input diagonal field of view. (default: 0)
• h_offset (of type float?, which defaults to null): output horizontal off-axis offset. (default: 0)
• v_offset (of type float?, which defaults to null): output vertical off-axis offset. (default: 0)
• alpha_mask (of type bool?, which defaults to null): build mask in alpha plane. (default: false)
• reset_rot (of type bool?, which defaults to null): reset rotation. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.v360.create

Ffmpeg filter: Convert 360 projection of video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?input : int?, ?output : int?, ?interp : int?, ?w : int?, ?h : int?,
 ?in_stereo : int?, ?out_stereo : int?, ?in_forder : string?,
 ?out_forder : string?, ?in_frot : string?, ?out_frot : string?,
 ?in_pad : float?, ?out_pad : float?, ?fin_pad : int?, ?fout_pad : int?,
 ?yaw : float?, ?pitch : float?, ?roll : float?, ?rorder : string?,
 ?h_fov : float?, ?v_fov : float?, ?d_fov : float?, ?h_flip : bool?,
 ?v_flip : bool?, ?d_flip : bool?, ?ih_flip : bool?, ?iv_flip : bool?,
 ?in_trans : bool?, ?out_trans : bool?, ?ih_fov : float?, ?iv_fov : float?,
 ?id_fov : float?, ?h_offset : float?, ?v_offset : float?,
 ?alpha_mask : bool?, ?reset_rot : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• input (of type int?, which defaults to null): set input projection. (default: 0, possible values: 0 (e), 0 (equirect), 1 (c3x2), 2 (c6x1), 3 (eac), 5 (dfisheye), 4 (flat), 4 (rectilinear), 4 (gnomonic), 6 (barrel), 6 (fb), 7 (c1x6), 8 (sg), 9 (mercator), 10 (ball), 11 (hammer), 12 (sinusoidal), 13 (fisheye), 14 (pannini), 15 (cylindrical), 17 (tetrahedron), 18 (barrelsplit), 19 (tsp), 20 (hequirect), 20 (he), 21 (equisolid), 22 (og), 23 (octahedron), 24 (cylindricalea))
• output (of type int?, which defaults to null): set output projection. (default: 1, possible values: 0 (e), 0 (equirect), 1 (c3x2), 2 (c6x1), 3 (eac), 5 (dfisheye), 4 (flat), 4 (rectilinear), 4 (gnomonic), 6 (barrel), 6 (fb), 7 (c1x6), 8 (sg), 9 (mercator), 10 (ball), 11 (hammer), 12 (sinusoidal), 13 (fisheye), 14 (pannini), 15 (cylindrical), 16 (perspective), 17 (tetrahedron), 18 (barrelsplit), 19 (tsp), 20 (hequirect), 20 (he), 21 (equisolid), 22 (og), 23 (octahedron), 24 (cylindricalea))
• interp (of type int?, which defaults to null): set interpolation method. (default: 1, possible values: 0 (near), 0 (nearest), 1 (line), 1 (linear), 2 (lagrange9), 3 (cube), 3 (cubic), 4 (lanc), 4 (lanczos), 5 (sp16), 5 (spline16), 6 (gauss), 6 (gaussian), 7 (mitchell))
• w (of type int?, which defaults to null): output width. (default: 0)
• h (of type int?, which defaults to null): output height. (default: 0)
• in_stereo (of type int?, which defaults to null): input stereo format. (default: 0, possible values: 0 (2d), 1 (sbs), 2 (tb))
• out_stereo (of type int?, which defaults to null): output stereo format. (default: 0, possible values: 0 (2d), 1 (sbs), 2 (tb))
• in_forder (of type string?, which defaults to null): input cubemap face order. (default: rludfb)
• out_forder (of type string?, which defaults to null): output cubemap face order. (default: rludfb)
• in_frot (of type string?, which defaults to null): input cubemap face rotation. (default: 000000)
• out_frot (of type string?, which defaults to null): output cubemap face rotation. (default: 000000)
• in_pad (of type float?, which defaults to null): percent input cubemap pads. (default: 0)
• out_pad (of type float?, which defaults to null): percent output cubemap pads. (default: 0)
• fin_pad (of type int?, which defaults to null): fixed input cubemap pads. (default: 0)
• fout_pad (of type int?, which defaults to null): fixed output cubemap pads. (default: 0)
• yaw (of type float?, which defaults to null): yaw rotation. (default: 0)
• pitch (of type float?, which defaults to null): pitch rotation. (default: 0)
• roll (of type float?, which defaults to null): roll rotation. (default: 0)
• rorder (of type string?, which defaults to null): rotation order. (default: ypr)
• h_fov (of type float?, which defaults to null): output horizontal field of view. (default: 0)
• v_fov (of type float?, which defaults to null): output vertical field of view. (default: 0)
• d_fov (of type float?, which defaults to null): output diagonal field of view. (default: 0)
• h_flip (of type bool?, which defaults to null): flip out video horizontally. (default: false)
• v_flip (of type bool?, which defaults to null): flip out video vertically. (default: false)
• d_flip (of type bool?, which defaults to null): flip out video indepth. (default: false)
• ih_flip (of type bool?, which defaults to null): flip in video horizontally. (default: false)
• iv_flip (of type bool?, which defaults to null): flip in video vertically. (default: false)
• in_trans (of type bool?, which defaults to null): transpose video input. (default: false)
• out_trans (of type bool?, which defaults to null): transpose video output. (default: false)
• ih_fov (of type float?, which defaults to null): input horizontal field of view. (default: 0)
• iv_fov (of type float?, which defaults to null): input vertical field of view. (default: 0)
• id_fov (of type float?, which defaults to null): input diagonal field of view. (default: 0)
• h_offset (of type float?, which defaults to null): output horizontal off-axis offset. (default: 0)
• v_offset (of type float?, which defaults to null): output vertical off-axis offset. (default: 0)
• alpha_mask (of type bool?, which defaults to null): build mask in alpha plane. (default: false)
• reset_rot (of type bool?, which defaults to null): reset rotation. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vaguedenoiser

Ffmpeg filter: Apply a Wavelet based Denoiser.

Type:

(?threshold : float?, ?method : int?, ?nsteps : int?, ?percent : float?,
 ?planes : int?, ?type : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• threshold (of type float?, which defaults to null): set filtering strength. (default: 2)
• method (of type int?, which defaults to null): set filtering method. (default: 2, possible values: 0 (hard), 1 (soft), 2 (garrote))
• nsteps (of type int?, which defaults to null): set number of steps. (default: 6)
• percent (of type float?, which defaults to null): set percent of full denoising. (default: 85)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• type (of type int?, which defaults to null): set threshold type. (default: 0, possible values: 0 (universal), 1 (bayes))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.vaguedenoiser.create

Ffmpeg filter: Apply a Wavelet based Denoiser. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?threshold : float?, ?method : int?, ?nsteps : int?, ?percent : float?,
 ?planes : int?, ?type : int?, ffmpeg.filter.graph) -> unit

Arguments:

• threshold (of type float?, which defaults to null): set filtering strength. (default: 2)
• method (of type int?, which defaults to null): set filtering method. (default: 2, possible values: 0 (hard), 1 (soft), 2 (garrote))
• nsteps (of type int?, which defaults to null): set number of steps. (default: 6)
• percent (of type float?, which defaults to null): set percent of full denoising. (default: 85)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• type (of type int?, which defaults to null): set threshold type. (default: 0, possible values: 0 (universal), 1 (bayes))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.varblur

Ffmpeg filter: Apply Variable Blur filter.

Type:

(?min_r : int?, ?max_r : int?, ?planes : int?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• min_r (of type int?, which defaults to null): set min blur radius. (default: 0)
• max_r (of type int?, which defaults to null): set max blur radius. (default: 8)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.varblur.create

Ffmpeg filter: Apply Variable Blur filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?min_r : int?, ?max_r : int?, ?planes : int?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• min_r (of type int?, which defaults to null): set min blur radius. (default: 0)
• max_r (of type int?, which defaults to null): set max blur radius. (default: 8)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vectorscope

Ffmpeg filter: Video vectorscope.

Type:

(?mode : int?, ?m : int?, ?x : int?, ?y : int?, ?intensity : float?,
 ?i : float?, ?envelope : int?, ?e : int?, ?graticule : int?, ?g : int?,
 ?opacity : float?, ?o : float?, ?flags : int?, ?f : int?,
 ?bgopacity : float?, ?b : float?, ?lthreshold : float?, ?l : float?,
 ?hthreshold : float?, ?h : float?, ?colorspace : int?, ?c : int?,
 ?tint0 : float?, ?t0 : float?, ?tint1 : float?, ?t1 : float?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set vectorscope mode. (default: 0, possible values: 0 (gray), 0 (tint), 1 (color), 2 (color2), 3 (color3), 4 (color4), 5 (color5))
• m (of type int?, which defaults to null): set vectorscope mode. (default: 0, possible values: 0 (gray), 0 (tint), 1 (color), 2 (color2), 3 (color3), 4 (color4), 5 (color5))
• x (of type int?, which defaults to null): set color component on X axis. (default: 1)
• y (of type int?, which defaults to null): set color component on Y axis. (default: 2)
• intensity (of type float?, which defaults to null): set intensity. (default: 0.004)
• i (of type float?, which defaults to null): set intensity. (default: 0.004)
• envelope (of type int?, which defaults to null): set envelope. (default: 0, possible values: 0 (none), 1 (instant), 2 (peak), 3 (peak+instant))
• e (of type int?, which defaults to null): set envelope. (default: 0, possible values: 0 (none), 1 (instant), 2 (peak), 3 (peak+instant))
• graticule (of type int?, which defaults to null): set graticule. (default: 0, possible values: 0 (none), 1 (green), 2 (color), 3 (invert))
• g (of type int?, which defaults to null): set graticule. (default: 0, possible values: 0 (none), 1 (green), 2 (color), 3 (invert))
• opacity (of type float?, which defaults to null): set graticule opacity. (default: 0.75)
• o (of type float?, which defaults to null): set graticule opacity. (default: 0.75)
• flags (of type int?, which defaults to null): set graticule flags. (default: 4, possible values: 1 (white), 2 (black), 4 (name), combined by addition)
• f (of type int?, which defaults to null): set graticule flags. (default: 4, possible values: 1 (white), 2 (black), 4 (name), combined by addition)
• bgopacity (of type float?, which defaults to null): set background opacity. (default: 0.3)
• b (of type float?, which defaults to null): set background opacity. (default: 0.3)
• lthreshold (of type float?, which defaults to null): set low threshold. (default: 0)
• l (of type float?, which defaults to null): set low threshold. (default: 0)
• hthreshold (of type float?, which defaults to null): set high threshold. (default: 1)
• h (of type float?, which defaults to null): set high threshold. (default: 1)
• colorspace (of type int?, which defaults to null): set colorspace. (default: 0, possible values: 0 (auto), 1 (601), 2 (709))
• c (of type int?, which defaults to null): set colorspace. (default: 0, possible values: 0 (auto), 1 (601), 2 (709))
• tint0 (of type float?, which defaults to null): set 1st tint. (default: 0)
• t0 (of type float?, which defaults to null): set 1st tint. (default: 0)
• tint1 (of type float?, which defaults to null): set 2nd tint. (default: 0)
• t1 (of type float?, which defaults to null): set 2nd tint. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.vectorscope.create

Ffmpeg filter: Video vectorscope. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?m : int?, ?x : int?, ?y : int?, ?intensity : float?,
 ?i : float?, ?envelope : int?, ?e : int?, ?graticule : int?, ?g : int?,
 ?opacity : float?, ?o : float?, ?flags : int?, ?f : int?,
 ?bgopacity : float?, ?b : float?, ?lthreshold : float?, ?l : float?,
 ?hthreshold : float?, ?h : float?, ?colorspace : int?, ?c : int?,
 ?tint0 : float?, ?t0 : float?, ?tint1 : float?, ?t1 : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set vectorscope mode. (default: 0, possible values: 0 (gray), 0 (tint), 1 (color), 2 (color2), 3 (color3), 4 (color4), 5 (color5))
• m (of type int?, which defaults to null): set vectorscope mode. (default: 0, possible values: 0 (gray), 0 (tint), 1 (color), 2 (color2), 3 (color3), 4 (color4), 5 (color5))
• x (of type int?, which defaults to null): set color component on X axis. (default: 1)
• y (of type int?, which defaults to null): set color component on Y axis. (default: 2)
• intensity (of type float?, which defaults to null): set intensity. (default: 0.004)
• i (of type float?, which defaults to null): set intensity. (default: 0.004)
• envelope (of type int?, which defaults to null): set envelope. (default: 0, possible values: 0 (none), 1 (instant), 2 (peak), 3 (peak+instant))
• e (of type int?, which defaults to null): set envelope. (default: 0, possible values: 0 (none), 1 (instant), 2 (peak), 3 (peak+instant))
• graticule (of type int?, which defaults to null): set graticule. (default: 0, possible values: 0 (none), 1 (green), 2 (color), 3 (invert))
• g (of type int?, which defaults to null): set graticule. (default: 0, possible values: 0 (none), 1 (green), 2 (color), 3 (invert))
• opacity (of type float?, which defaults to null): set graticule opacity. (default: 0.75)
• o (of type float?, which defaults to null): set graticule opacity. (default: 0.75)
• flags (of type int?, which defaults to null): set graticule flags. (default: 4, possible values: 1 (white), 2 (black), 4 (name), combined by addition)
• f (of type int?, which defaults to null): set graticule flags. (default: 4, possible values: 1 (white), 2 (black), 4 (name), combined by addition)
• bgopacity (of type float?, which defaults to null): set background opacity. (default: 0.3)
• b (of type float?, which defaults to null): set background opacity. (default: 0.3)
• lthreshold (of type float?, which defaults to null): set low threshold. (default: 0)
• l (of type float?, which defaults to null): set low threshold. (default: 0)
• hthreshold (of type float?, which defaults to null): set high threshold. (default: 1)
• h (of type float?, which defaults to null): set high threshold. (default: 1)
• colorspace (of type int?, which defaults to null): set colorspace. (default: 0, possible values: 0 (auto), 1 (601), 2 (709))
• c (of type int?, which defaults to null): set colorspace. (default: 0, possible values: 0 (auto), 1 (601), 2 (709))
• tint0 (of type float?, which defaults to null): set 1st tint. (default: 0)
• t0 (of type float?, which defaults to null): set 1st tint. (default: 0)
• tint1 (of type float?, which defaults to null): set 2nd tint. (default: 0)
• t1 (of type float?, which defaults to null): set 2nd tint. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vflip

Ffmpeg filter: Flip the input video vertically.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.vflip.create

Ffmpeg filter: Flip the input video vertically. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vfrdet

Ffmpeg filter: Variable frame rate detect filter.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.vfrdet.create

Ffmpeg filter: Variable frame rate detect filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vibrance

Ffmpeg filter: Boost or alter saturation.

Type:

(?intensity : float?, ?rbal : float?, ?gbal : float?, ?bbal : float?,
 ?rlum : float?, ?glum : float?, ?blum : float?, ?alternate : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• intensity (of type float?, which defaults to null): set the intensity value. (default: 0)
• rbal (of type float?, which defaults to null): set the red balance value. (default: 1)
• gbal (of type float?, which defaults to null): set the green balance value. (default: 1)
• bbal (of type float?, which defaults to null): set the blue balance value. (default: 1)
• rlum (of type float?, which defaults to null): set the red luma coefficient. (default: 0.212656)
• glum (of type float?, which defaults to null): set the green luma coefficient. (default: 0.715158)
• blum (of type float?, which defaults to null): set the blue luma coefficient. (default: 0.072186)
• alternate (of type bool?, which defaults to null): use alternate colors. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.vibrance.create

Ffmpeg filter: Boost or alter saturation. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?intensity : float?, ?rbal : float?, ?gbal : float?, ?bbal : float?,
 ?rlum : float?, ?glum : float?, ?blum : float?, ?alternate : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• intensity (of type float?, which defaults to null): set the intensity value. (default: 0)
• rbal (of type float?, which defaults to null): set the red balance value. (default: 1)
• gbal (of type float?, which defaults to null): set the green balance value. (default: 1)
• bbal (of type float?, which defaults to null): set the blue balance value. (default: 1)
• rlum (of type float?, which defaults to null): set the red luma coefficient. (default: 0.212656)
• glum (of type float?, which defaults to null): set the green luma coefficient. (default: 0.715158)
• blum (of type float?, which defaults to null): set the blue luma coefficient. (default: 0.072186)
• alternate (of type bool?, which defaults to null): use alternate colors. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vibrato

Ffmpeg filter: Apply vibrato effect.

Type:

(?f : float?, ?d : float?, ffmpeg.filter.graph, ffmpeg.filter.audio) ->
ffmpeg.filter.audio

Arguments:

• f (of type float?, which defaults to null): set frequency in hertz. (default: 5)
• d (of type float?, which defaults to null): set depth as percentage. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.vibrato.create

Ffmpeg filter: Apply vibrato effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?f : float?, ?d : float?, ffmpeg.filter.graph) -> unit

Arguments:

• f (of type float?, which defaults to null): set frequency in hertz. (default: 5)
• d (of type float?, which defaults to null): set depth as percentage. (default: 0.5)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vif

Ffmpeg filter: Calculate the VIF between two video streams.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph, ffmpeg.filter.video,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.vif.create

Ffmpeg filter: Calculate the VIF between two video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?eof_action : int?, ?shortest : bool?, ?repeatlast : bool?,
 ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vignette

Ffmpeg filter: Make or reverse a vignette effect.

Type:

(?angle : string?, ?a : string?, ?x0 : string?, ?y0 : string?, ?mode : int?,
 ?eval : int?, ?dither : bool?, ?aspect : string?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• angle (of type string?, which defaults to null): set lens angle. (default: PI/5)
• a (of type string?, which defaults to null): set lens angle. (default: PI/5)
• x0 (of type string?, which defaults to null): set circle center position on x-axis. (default: w/2)
• y0 (of type string?, which defaults to null): set circle center position on y-axis. (default: h/2)
• mode (of type int?, which defaults to null): set forward/backward mode. (default: 0, possible values: 0 (forward), 1 (backward))
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• dither (of type bool?, which defaults to null): set dithering. (default: true)
• aspect (of type string?, which defaults to null): set aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.vignette.create

Ffmpeg filter: Make or reverse a vignette effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?angle : string?, ?a : string?, ?x0 : string?, ?y0 : string?, ?mode : int?,
 ?eval : int?, ?dither : bool?, ?aspect : string?, ffmpeg.filter.graph) ->
unit

Arguments:

• angle (of type string?, which defaults to null): set lens angle. (default: PI/5)
• a (of type string?, which defaults to null): set lens angle. (default: PI/5)
• x0 (of type string?, which defaults to null): set circle center position on x-axis. (default: w/2)
• y0 (of type string?, which defaults to null): set circle center position on y-axis. (default: h/2)
• mode (of type int?, which defaults to null): set forward/backward mode. (default: 0, possible values: 0 (forward), 1 (backward))
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (init), 1 (frame))
• dither (of type bool?, which defaults to null): set dithering. (default: true)
• aspect (of type string?, which defaults to null): set aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.virtualbass

Ffmpeg filter: Audio Virtual Bass.

Type:

(?cutoff : float?, ?strength : float?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• cutoff (of type float?, which defaults to null): set virtual bass cutoff. (default: 250)
• strength (of type float?, which defaults to null): set virtual bass strength. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.virtualbass.create

Ffmpeg filter: Audio Virtual Bass. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?cutoff : float?, ?strength : float?, ffmpeg.filter.graph) -> unit

Arguments:

• cutoff (of type float?, which defaults to null): set virtual bass cutoff. (default: 250)
• strength (of type float?, which defaults to null): set virtual bass strength. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vmafmotion

Ffmpeg filter: Calculate the VMAF Motion score.

Type:

(?stats_file : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame difference information
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.vmafmotion.create

Ffmpeg filter: Calculate the VMAF Motion score. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?stats_file : string?, ffmpeg.filter.graph) -> unit

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame difference information
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.volume

Ffmpeg filter: Change input volume.

Type:

(?volume : string?, ?precision : int?, ?eval : int?, ?replaygain : int?,
 ?replaygain_preamp : float?, ?replaygain_noclip : bool?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• volume (of type string?, which defaults to null): set volume adjustment expression. (default: 1.0)
• precision (of type int?, which defaults to null): select mathematical precision. (default: 1, possible values: 0 (fixed), 1 (float), 2 (double))
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (once), 1 (frame))
• replaygain (of type int?, which defaults to null): Apply replaygain side data when present. (default: 0, possible values: 0 (drop), 1 (ignore), 2 (track), 3 (album))
• replaygain_preamp (of type float?, which defaults to null): Apply replaygain pre-amplification. (default: 0)
• replaygain_noclip (of type bool?, which defaults to null): Apply replaygain clipping prevention. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.volume.create

Ffmpeg filter: Change input volume. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?volume : string?, ?precision : int?, ?eval : int?, ?replaygain : int?,
 ?replaygain_preamp : float?, ?replaygain_noclip : bool?,
 ffmpeg.filter.graph) -> unit

Arguments:

• volume (of type string?, which defaults to null): set volume adjustment expression. (default: 1.0)
• precision (of type int?, which defaults to null): select mathematical precision. (default: 1, possible values: 0 (fixed), 1 (float), 2 (double))
• eval (of type int?, which defaults to null): specify when to evaluate expressions. (default: 0, possible values: 0 (once), 1 (frame))
• replaygain (of type int?, which defaults to null): Apply replaygain side data when present. (default: 0, possible values: 0 (drop), 1 (ignore), 2 (track), 3 (album))
• replaygain_preamp (of type float?, which defaults to null): Apply replaygain pre-amplification. (default: 0)
• replaygain_noclip (of type bool?, which defaults to null): Apply replaygain clipping prevention. (default: true)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.volumedetect

Ffmpeg filter: Detect audio volume.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.volumedetect.create

Ffmpeg filter: Detect audio volume. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(ffmpeg.filter.graph) -> unit

Arguments:

• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.audio): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.audio) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.vstack

Ffmpeg filter: Stack video inputs vertically. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?shortest : bool?, ffmpeg.filter.graph,
 [ffmpeg.filter.audio], [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.vstack.create

Ffmpeg filter: Stack video inputs vertically. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?shortest : bool?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.w3fdif

Ffmpeg filter: Apply Martin Weston three field deinterlace.

Type:

(?filter : int?, ?mode : int?, ?parity : int?, ?deint : int?,
 ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• filter (of type int?, which defaults to null): specify the filter. (default: 1, possible values: 0 (simple), 1 (complex))
• mode (of type int?, which defaults to null): specify the interlacing mode. (default: 1, possible values: 0 (frame), 1 (field))
• parity (of type int?, which defaults to null): specify the assumed picture field parity. (default: -1, possible values: 0 (tff), 1 (bff), -1 (auto))
• deint (of type int?, which defaults to null): specify which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.w3fdif.create

Ffmpeg filter: Apply Martin Weston three field deinterlace. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?filter : int?, ?mode : int?, ?parity : int?, ?deint : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• filter (of type int?, which defaults to null): specify the filter. (default: 1, possible values: 0 (simple), 1 (complex))
• mode (of type int?, which defaults to null): specify the interlacing mode. (default: 1, possible values: 0 (frame), 1 (field))
• parity (of type int?, which defaults to null): specify the assumed picture field parity. (default: -1, possible values: 0 (tff), 1 (bff), -1 (auto))
• deint (of type int?, which defaults to null): specify which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.waveform

Ffmpeg filter: Video waveform monitor.

Type:

(?mode : int?, ?m : int?, ?intensity : float?, ?i : float?, ?mirror : bool?,
 ?r : bool?, ?display : int?, ?d : int?, ?components : int?, ?c : int?,
 ?envelope : int?, ?e : int?, ?filter : int?, ?f : int?, ?graticule : int?,
 ?g : int?, ?opacity : float?, ?o : float?, ?flags : int?, ?fl : int?,
 ?scale : int?, ?s : int?, ?bgopacity : float?, ?b : float?, ?tint0 : float?,
 ?t0 : float?, ?tint1 : float?, ?t1 : float?, ?fitmode : int?, ?fm : int?,
 ?input : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): set mode. (default: 1, possible values: 0 (row), 1 (column))
• m (of type int?, which defaults to null): set mode. (default: 1, possible values: 0 (row), 1 (column))
• intensity (of type float?, which defaults to null): set intensity. (default: 0.04)
• i (of type float?, which defaults to null): set intensity. (default: 0.04)
• mirror (of type bool?, which defaults to null): set mirroring. (default: true)
• r (of type bool?, which defaults to null): set mirroring. (default: true)
• display (of type int?, which defaults to null): set display mode. (default: 1, possible values: 0 (overlay), 1 (stack), 2 (parade))
• d (of type int?, which defaults to null): set display mode. (default: 1, possible values: 0 (overlay), 1 (stack), 2 (parade))
• components (of type int?, which defaults to null): set components to display. (default: 1)
• c (of type int?, which defaults to null): set components to display. (default: 1)
• envelope (of type int?, which defaults to null): set envelope to display. (default: 0, possible values: 0 (none), 1 (instant), 2 (peak), 3 (peak+instant))
• e (of type int?, which defaults to null): set envelope to display. (default: 0, possible values: 0 (none), 1 (instant), 2 (peak), 3 (peak+instant))
• filter (of type int?, which defaults to null): set filter. (default: 0, possible values: 0 (lowpass), 1 (flat), 2 (aflat), 3 (chroma), 4 (color), 5 (acolor), 6 (xflat), 7 (yflat))
• f (of type int?, which defaults to null): set filter. (default: 0, possible values: 0 (lowpass), 1 (flat), 2 (aflat), 3 (chroma), 4 (color), 5 (acolor), 6 (xflat), 7 (yflat))
• graticule (of type int?, which defaults to null): set graticule. (default: 0, possible values: 0 (none), 1 (green), 2 (orange), 3 (invert))
• g (of type int?, which defaults to null): set graticule. (default: 0, possible values: 0 (none), 1 (green), 2 (orange), 3 (invert))
• opacity (of type float?, which defaults to null): set graticule opacity. (default: 0.75)
• o (of type float?, which defaults to null): set graticule opacity. (default: 0.75)
• flags (of type int?, which defaults to null): set graticule flags. (default: 1, possible values: 1 (numbers), 2 (dots), combined by addition)
• fl (of type int?, which defaults to null): set graticule flags. (default: 1, possible values: 1 (numbers), 2 (dots), combined by addition)
• scale (of type int?, which defaults to null): set scale. (default: 0, possible values: 0 (digital), 1 (millivolts), 2 (ire))
• s (of type int?, which defaults to null): set scale. (default: 0, possible values: 0 (digital), 1 (millivolts), 2 (ire))
• bgopacity (of type float?, which defaults to null): set background opacity. (default: 0.75)
• b (of type float?, which defaults to null): set background opacity. (default: 0.75)
• tint0 (of type float?, which defaults to null): set 1st tint. (default: 0)
• t0 (of type float?, which defaults to null): set 1st tint. (default: 0)
• tint1 (of type float?, which defaults to null): set 2nd tint. (default: 0)
• t1 (of type float?, which defaults to null): set 2nd tint. (default: 0)
• fitmode (of type int?, which defaults to null): set fit mode. (default: 0, possible values: 0 (none), 1 (size))
• fm (of type int?, which defaults to null): set fit mode. (default: 0, possible values: 0 (none), 1 (size))
• input (of type int?, which defaults to null): set input formats selection. (default: 1, possible values: 0 (all), 1 (first))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.waveform.create

Ffmpeg filter: Video waveform monitor. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?m : int?, ?intensity : float?, ?i : float?, ?mirror : bool?,
 ?r : bool?, ?display : int?, ?d : int?, ?components : int?, ?c : int?,
 ?envelope : int?, ?e : int?, ?filter : int?, ?f : int?, ?graticule : int?,
 ?g : int?, ?opacity : float?, ?o : float?, ?flags : int?, ?fl : int?,
 ?scale : int?, ?s : int?, ?bgopacity : float?, ?b : float?, ?tint0 : float?,
 ?t0 : float?, ?tint1 : float?, ?t1 : float?, ?fitmode : int?, ?fm : int?,
 ?input : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): set mode. (default: 1, possible values: 0 (row), 1 (column))
• m (of type int?, which defaults to null): set mode. (default: 1, possible values: 0 (row), 1 (column))
• intensity (of type float?, which defaults to null): set intensity. (default: 0.04)
• i (of type float?, which defaults to null): set intensity. (default: 0.04)
• mirror (of type bool?, which defaults to null): set mirroring. (default: true)
• r (of type bool?, which defaults to null): set mirroring. (default: true)
• display (of type int?, which defaults to null): set display mode. (default: 1, possible values: 0 (overlay), 1 (stack), 2 (parade))
• d (of type int?, which defaults to null): set display mode. (default: 1, possible values: 0 (overlay), 1 (stack), 2 (parade))
• components (of type int?, which defaults to null): set components to display. (default: 1)
• c (of type int?, which defaults to null): set components to display. (default: 1)
• envelope (of type int?, which defaults to null): set envelope to display. (default: 0, possible values: 0 (none), 1 (instant), 2 (peak), 3 (peak+instant))
• e (of type int?, which defaults to null): set envelope to display. (default: 0, possible values: 0 (none), 1 (instant), 2 (peak), 3 (peak+instant))
• filter (of type int?, which defaults to null): set filter. (default: 0, possible values: 0 (lowpass), 1 (flat), 2 (aflat), 3 (chroma), 4 (color), 5 (acolor), 6 (xflat), 7 (yflat))
• f (of type int?, which defaults to null): set filter. (default: 0, possible values: 0 (lowpass), 1 (flat), 2 (aflat), 3 (chroma), 4 (color), 5 (acolor), 6 (xflat), 7 (yflat))
• graticule (of type int?, which defaults to null): set graticule. (default: 0, possible values: 0 (none), 1 (green), 2 (orange), 3 (invert))
• g (of type int?, which defaults to null): set graticule. (default: 0, possible values: 0 (none), 1 (green), 2 (orange), 3 (invert))
• opacity (of type float?, which defaults to null): set graticule opacity. (default: 0.75)
• o (of type float?, which defaults to null): set graticule opacity. (default: 0.75)
• flags (of type int?, which defaults to null): set graticule flags. (default: 1, possible values: 1 (numbers), 2 (dots), combined by addition)
• fl (of type int?, which defaults to null): set graticule flags. (default: 1, possible values: 1 (numbers), 2 (dots), combined by addition)
• scale (of type int?, which defaults to null): set scale. (default: 0, possible values: 0 (digital), 1 (millivolts), 2 (ire))
• s (of type int?, which defaults to null): set scale. (default: 0, possible values: 0 (digital), 1 (millivolts), 2 (ire))
• bgopacity (of type float?, which defaults to null): set background opacity. (default: 0.75)
• b (of type float?, which defaults to null): set background opacity. (default: 0.75)
• tint0 (of type float?, which defaults to null): set 1st tint. (default: 0)
• t0 (of type float?, which defaults to null): set 1st tint. (default: 0)
• tint1 (of type float?, which defaults to null): set 2nd tint. (default: 0)
• t1 (of type float?, which defaults to null): set 2nd tint. (default: 0)
• fitmode (of type int?, which defaults to null): set fit mode. (default: 0, possible values: 0 (none), 1 (size))
• fm (of type int?, which defaults to null): set fit mode. (default: 0, possible values: 0 (none), 1 (size))
• input (of type int?, which defaults to null): set input formats selection. (default: 1, possible values: 0 (all), 1 (first))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.weave

Ffmpeg filter: Weave input video fields into frames.

Type:

(?first_field : int?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• first_field (of type int?, which defaults to null): set first field. (default: 0, possible values: 0 (top), 0 (t), 1 (bottom), 1 (b))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.weave.create

Ffmpeg filter: Weave input video fields into frames. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?first_field : int?, ffmpeg.filter.graph) -> unit

Arguments:

• first_field (of type int?, which defaults to null): set first field. (default: 0, possible values: 0 (top), 0 (t), 1 (bottom), 1 (b))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.xbr

Ffmpeg filter: Scale the input using xBR algorithm.

Type:

(?n : int?, ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• n (of type int?, which defaults to null): set scale factor. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.xbr.create

Ffmpeg filter: Scale the input using xBR algorithm. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?n : int?, ffmpeg.filter.graph) -> unit

Arguments:

• n (of type int?, which defaults to null): set scale factor. (default: 3)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.xcorrelate

Ffmpeg filter: Cross-correlate first video stream with second video stream.

Type:

(?planes : int?, ?secondary : int?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• planes (of type int?, which defaults to null): set planes to cross-correlate. (default: 7)
• secondary (of type int?, which defaults to null): when to process secondary frame. (default: 1, possible values: 0 (first), 1 (all))
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.xcorrelate.create

Ffmpeg filter: Cross-correlate first video stream with second video stream. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?planes : int?, ?secondary : int?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• planes (of type int?, which defaults to null): set planes to cross-correlate. (default: 7)
• secondary (of type int?, which defaults to null): when to process secondary frame. (default: 1, possible values: 0 (first), 1 (all))
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.xfade

Ffmpeg filter: Cross fade one video with another video.

Type:

(?transition : int?, ?duration : int?, ?offset : int?, ?expr : string?,
 ffmpeg.filter.graph, ffmpeg.filter.video, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• transition (of type int?, which defaults to null): set cross fade transition. (default: 0, possible values: -1 (custom), 0 (fade), 1 (wipeleft), 2 (wiperight), 3 (wipeup), 4 (wipedown), 5 (slideleft), 6 (slideright), 7 (slideup), 8 (slidedown), 9 (circlecrop), 10 (rectcrop), 11 (distance), 12 (fadeblack), 13 (fadewhite), 14 (radial), 15 (smoothleft), 16 (smoothright), 17 (smoothup), 18 (smoothdown), 19 (circleopen), 20 (circleclose), 21 (vertopen), 22 (vertclose), 23 (horzopen), 24 (horzclose), 25 (dissolve), 26 (pixelize), 27 (diagtl), 28 (diagtr), 29 (diagbl), 30 (diagbr), 31 (hlslice), 32 (hrslice), 33 (vuslice), 34 (vdslice), 35 (hblur), 36 (fadegrays), 37 (wipetl), 38 (wipetr), 39 (wipebl), 40 (wipebr), 41 (squeezeh), 42 (squeezev), 43 (zoomin), 44 (fadefast), 45 (fadeslow), 46 (hlwind), 47 (hrwind), 48 (vuwind), 49 (vdwind), 50 (coverleft), 51 (coverright), 52 (coverup), 53 (coverdown), 54 (revealleft), 55 (revealright), 56 (revealup), 57 (revealdown))
• duration (of type int?, which defaults to null): set cross fade duration. (default: 1)
• offset (of type int?, which defaults to null): set cross fade start relative to first input stream. (default: 0)
• expr (of type string?, which defaults to null): set expression for custom transition
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.xfade.create

Ffmpeg filter: Cross fade one video with another video. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?transition : int?, ?duration : int?, ?offset : int?, ?expr : string?,
 ffmpeg.filter.graph) -> unit

Arguments:

• transition (of type int?, which defaults to null): set cross fade transition. (default: 0, possible values: -1 (custom), 0 (fade), 1 (wipeleft), 2 (wiperight), 3 (wipeup), 4 (wipedown), 5 (slideleft), 6 (slideright), 7 (slideup), 8 (slidedown), 9 (circlecrop), 10 (rectcrop), 11 (distance), 12 (fadeblack), 13 (fadewhite), 14 (radial), 15 (smoothleft), 16 (smoothright), 17 (smoothup), 18 (smoothdown), 19 (circleopen), 20 (circleclose), 21 (vertopen), 22 (vertclose), 23 (horzopen), 24 (horzclose), 25 (dissolve), 26 (pixelize), 27 (diagtl), 28 (diagtr), 29 (diagbl), 30 (diagbr), 31 (hlslice), 32 (hrslice), 33 (vuslice), 34 (vdslice), 35 (hblur), 36 (fadegrays), 37 (wipetl), 38 (wipetr), 39 (wipebl), 40 (wipebr), 41 (squeezeh), 42 (squeezev), 43 (zoomin), 44 (fadefast), 45 (fadeslow), 46 (hlwind), 47 (hrwind), 48 (vuwind), 49 (vdwind), 50 (coverleft), 51 (coverright), 52 (coverup), 53 (coverdown), 54 (revealleft), 55 (revealright), 56 (revealup), 57 (revealdown))
• duration (of type int?, which defaults to null): set cross fade duration. (default: 1)
• offset (of type int?, which defaults to null): set cross fade start relative to first input stream. (default: 0)
• expr (of type string?, which defaults to null): set expression for custom transition
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.xmedian

Ffmpeg filter: Pick median pixels from several video inputs. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?planes : int?, ?percentile : float?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph, [ffmpeg.filter.audio], [ffmpeg.filter.video]) ->
ffmpeg.filter.video

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 3)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• percentile (of type float?, which defaults to null): set percentile. (default: 0.5)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.xmedian.create

Ffmpeg filter: Pick median pixels from several video inputs. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?planes : int?, ?percentile : float?, ?eof_action : int?,
 ?shortest : bool?, ?repeatlast : bool?, ?ts_sync_mode : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 3)
• planes (of type int?, which defaults to null): set planes to filter. (default: 15)
• percentile (of type float?, which defaults to null): set percentile. (default: 0.5)
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.xpsnr

Ffmpeg filter: Calculate the extended perceptually weighted peak signal-to-noise ratio (XPSNR) between two video streams.

Type:

(?stats_file : string?, ?f : string?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame XPSNR information
• f (of type string?, which defaults to null): Set file where to store per-frame XPSNR information
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.xpsnr.create

Ffmpeg filter: Calculate the extended perceptually weighted peak signal-to-noise ratio (XPSNR) between two video streams. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?stats_file : string?, ?f : string?, ?eof_action : int?, ?shortest : bool?,
 ?repeatlast : bool?, ?ts_sync_mode : int?, ffmpeg.filter.graph) -> unit

Arguments:

• stats_file (of type string?, which defaults to null): Set file where to store per-frame XPSNR information
• f (of type string?, which defaults to null): Set file where to store per-frame XPSNR information
• eof_action (of type int?, which defaults to null): Action to take when encountering EOF from secondary input . (default: 0, possible values: 0 (repeat), 1 (endall), 2 (pass))
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• repeatlast (of type bool?, which defaults to null): extend last frame of secondary streams beyond EOF. (default: true)
• ts_sync_mode (of type int?, which defaults to null): How strictly to sync streams based on secondary input timestamps. (default: 0, possible values: 0 (default), 1 (nearest))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.xstack

Ffmpeg filter: Stack video inputs into custom layout. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime.

Type:

(?inputs : int?, ?layout : string?, ?grid : string?, ?shortest : bool?,
 ?fill : string?, ffmpeg.filter.graph, [ffmpeg.filter.audio],
 [ffmpeg.filter.video]) -> ffmpeg.filter.video

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• layout (of type string?, which defaults to null): set custom layout
• grid (of type string?, which defaults to null): set fixed size grid layout
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• fill (of type string?, which defaults to null): set the color for unused pixels. (default: none)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type [ffmpeg.filter.audio])
• (unlabeled) (of type [ffmpeg.filter.video])

ffmpeg.filter.xstack.create

Ffmpeg filter: Stack video inputs into custom layout. This filter has dynamic inputs: last two arguments are lists of audio and video inputs. Total number of inputs is determined at runtime. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?inputs : int?, ?layout : string?, ?grid : string?, ?shortest : bool?,
 ?fill : string?, ffmpeg.filter.graph) -> unit

Arguments:

• inputs (of type int?, which defaults to null): set number of inputs. (default: 2)
• layout (of type string?, which defaults to null): set custom layout
• grid (of type string?, which defaults to null): set fixed size grid layout
• shortest (of type bool?, which defaults to null): force termination when the shortest input terminates. (default: false)
• fill (of type string?, which defaults to null): set the color for unused pixels. (default: none)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.yadif

Ffmpeg filter: Deinterlace the input image.

Type:

(?mode : int?, ?parity : int?, ?deint : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• mode (of type int?, which defaults to null): specify the interlacing mode. (default: 0, possible values: 0 (send_frame), 1 (send_field), 2 (send_frame_nospatial), 3 (send_field_nospatial))
• parity (of type int?, which defaults to null): specify the assumed picture field parity. (default: -1, possible values: 0 (tff), 1 (bff), -1 (auto))
• deint (of type int?, which defaults to null): specify which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.yadif.create

Ffmpeg filter: Deinterlace the input image. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?mode : int?, ?parity : int?, ?deint : int?, ffmpeg.filter.graph) -> unit

Arguments:

• mode (of type int?, which defaults to null): specify the interlacing mode. (default: 0, possible values: 0 (send_frame), 1 (send_field), 2 (send_frame_nospatial), 3 (send_field_nospatial))
• parity (of type int?, which defaults to null): specify the assumed picture field parity. (default: -1, possible values: 0 (tff), 1 (bff), -1 (auto))
• deint (of type int?, which defaults to null): specify which frames to deinterlace. (default: 0, possible values: 0 (all), 1 (interlaced))
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.yaepblur

Ffmpeg filter: Yet another edge preserving blur filter.

Type:

(?radius : int?, ?r : int?, ?planes : int?, ?p : int?, ?sigma : int?,
 ?s : int?, ffmpeg.filter.graph, ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

• radius (of type int?, which defaults to null): set window radius. (default: 3)
• r (of type int?, which defaults to null): set window radius. (default: 3)
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• p (of type int?, which defaults to null): set planes to filter. (default: 1)
• sigma (of type int?, which defaults to null): set blur strength. (default: 128)
• s (of type int?, which defaults to null): set blur strength. (default: 128)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.yaepblur.create

Ffmpeg filter: Yet another edge preserving blur filter. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?radius : int?, ?r : int?, ?planes : int?, ?p : int?, ?sigma : int?,
 ?s : int?, ffmpeg.filter.graph) -> unit

Arguments:

• radius (of type int?, which defaults to null): set window radius. (default: 3)
• r (of type int?, which defaults to null): set window radius. (default: 3)
• planes (of type int?, which defaults to null): set planes to filter. (default: 1)
• p (of type int?, which defaults to null): set planes to filter. (default: 1)
• sigma (of type int?, which defaults to null): set blur strength. (default: 128)
• s (of type int?, which defaults to null): set blur strength. (default: 128)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

ffmpeg.filter.yuvtestsrc

Ffmpeg filter: Generate YUV test pattern.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.yuvtestsrc.create

Ffmpeg filter: Generate YUV test pattern. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.zoneplate

Ffmpeg filter: Generate zone-plate.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?precision : int?, ?xo : int?,
 ?yo : int?, ?to : int?, ?k0 : int?, ?kx : int?, ?ky : int?, ?kt : int?,
 ?kxt : int?, ?kyt : int?, ?kxy : int?, ?kx2 : int?, ?ky2 : int?,
 ?kt2 : int?, ?ku : int?, ?kv : int?, ffmpeg.filter.graph) ->
ffmpeg.filter.video

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• precision (of type int?, which defaults to null): set LUT precision. (default: 10)
• xo (of type int?, which defaults to null): set X-axis offset. (default: 0)
• yo (of type int?, which defaults to null): set Y-axis offset. (default: 0)
• to (of type int?, which defaults to null): set T-axis offset. (default: 0)
• k0 (of type int?, which defaults to null): set 0-order phase. (default: 0)
• kx (of type int?, which defaults to null): set 1-order X-axis phase. (default: 0)
• ky (of type int?, which defaults to null): set 1-order Y-axis phase. (default: 0)
• kt (of type int?, which defaults to null): set 1-order T-axis phase. (default: 0)
• kxt (of type int?, which defaults to null): set X-axis*T-axis product phase. (default: 0)
• kyt (of type int?, which defaults to null): set Y-axis*T-axis product phase. (default: 0)
• kxy (of type int?, which defaults to null): set X-axis*Y-axis product phase. (default: 0)
• kx2 (of type int?, which defaults to null): set 2-order X-axis phase. (default: 0)
• ky2 (of type int?, which defaults to null): set 2-order Y-axis phase. (default: 0)
• kt2 (of type int?, which defaults to null): set 2-order T-axis phase. (default: 0)
• ku (of type int?, which defaults to null): set 0-order U-color phase. (default: 0)
• kv (of type int?, which defaults to null): set 0-order V-color phase. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

ffmpeg.filter.zoneplate.create

Ffmpeg filter: Generate zone-plate. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?size : string?, ?s : string?, ?rate : string?, ?r : string?,
 ?duration : int?, ?d : int?, ?sar : string?, ?precision : int?, ?xo : int?,
 ?yo : int?, ?to : int?, ?k0 : int?, ?kx : int?, ?ky : int?, ?kt : int?,
 ?kxt : int?, ?kyt : int?, ?kxy : int?, ?kx2 : int?, ?ky2 : int?,
 ?kt2 : int?, ?ku : int?, ?kv : int?, ffmpeg.filter.graph) -> unit

Arguments:

• size (of type string?, which defaults to null): set video size. (default: 320x240)
• s (of type string?, which defaults to null): set video size. (default: 320x240)
• rate (of type string?, which defaults to null): set video rate. (default: 25)
• r (of type string?, which defaults to null): set video rate. (default: 25)
• duration (of type int?, which defaults to null): set video duration. (default: -1e-06)
• d (of type int?, which defaults to null): set video duration. (default: -1e-06)
• sar (of type string?, which defaults to null): set video sample aspect ratio. (default: 1/1)
• precision (of type int?, which defaults to null): set LUT precision. (default: 10)
• xo (of type int?, which defaults to null): set X-axis offset. (default: 0)
• yo (of type int?, which defaults to null): set Y-axis offset. (default: 0)
• to (of type int?, which defaults to null): set T-axis offset. (default: 0)
• k0 (of type int?, which defaults to null): set 0-order phase. (default: 0)
• kx (of type int?, which defaults to null): set 1-order X-axis phase. (default: 0)
• ky (of type int?, which defaults to null): set 1-order Y-axis phase. (default: 0)
• kt (of type int?, which defaults to null): set 1-order T-axis phase. (default: 0)
• kxt (of type int?, which defaults to null): set X-axis*T-axis product phase. (default: 0)
• kyt (of type int?, which defaults to null): set Y-axis*T-axis product phase. (default: 0)
• kxy (of type int?, which defaults to null): set X-axis*Y-axis product phase. (default: 0)
• kx2 (of type int?, which defaults to null): set 2-order X-axis phase. (default: 0)
• ky2 (of type int?, which defaults to null): set 2-order Y-axis phase. (default: 0)
• kt2 (of type int?, which defaults to null): set 2-order T-axis phase. (default: 0)
• ku (of type int?, which defaults to null): set 0-order U-color phase. (default: 0)
• kv (of type int?, which defaults to null): set 0-order V-color phase. (default: 0)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type () -> unit): Set the inputs of the filter instance.

ffmpeg.filter.zoompan

Ffmpeg filter: Apply Zoom & Pan effect.

Type:

(?zoom : string?, ?z : string?, ?x : string?, ?y : string?, ?d : string?,
 ?s : string?, ?fps : string?, ffmpeg.filter.graph, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• zoom (of type string?, which defaults to null): set the zoom expression. (default: 1)
• z (of type string?, which defaults to null): set the zoom expression. (default: 1)
• x (of type string?, which defaults to null): set the x expression. (default: 0)
• y (of type string?, which defaults to null): set the y expression. (default: 0)
• d (of type string?, which defaults to null): set the duration expression. (default: 90)
• s (of type string?, which defaults to null): set the output image size. (default: hd720)
• fps (of type string?, which defaults to null): set the output framerate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.zoompan.create

Ffmpeg filter: Apply Zoom & Pan effect. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?zoom : string?, ?z : string?, ?x : string?, ?y : string?, ?d : string?,
 ?s : string?, ?fps : string?, ffmpeg.filter.graph) -> unit

Arguments:

• zoom (of type string?, which defaults to null): set the zoom expression. (default: 1)
• z (of type string?, which defaults to null): set the zoom expression. (default: 1)
• x (of type string?, which defaults to null): set the x expression. (default: 0)
• y (of type string?, which defaults to null): set the y expression. (default: 0)
• d (of type string?, which defaults to null): set the duration expression. (default: 90)
• s (of type string?, which defaults to null): set the output image size. (default: hd720)
• fps (of type string?, which defaults to null): set the output framerate. (default: 25)
• (unlabeled) (of type ffmpeg.filter.graph)

Methods:

• output (of type ffmpeg.filter.video): The outputs of the filter instance.
• process_command (of type (?fast : bool, string, string) -> string): Send a command to the filter instance of the running graph.
• set_input (of type (ffmpeg.filter.video) -> unit): Set the inputs of the filter instance.

video.add_text.ffmpeg.raw

Draw a text on the video of a source carrying raw FFmpeg video, in a filter graph. The text and its position are updated on each frame of the source.

Type:

(?color : int, ?cycle : bool, ?font : string?, ?metadata : string?,
 ?size : int, ?speed : int, ?x : {int}, ?y : {int},
 graph : ffmpeg.filter.graph, {string},
 source(video=ffmpeg.video.raw('d), 'e)
 .{
   on_frame : (synchronous : bool, (() -> unit)) -> 'a,
   on_metadata : (synchronous : bool, (('b) -> unit)) -> 'c
 }) -> ffmpeg.filter.video

Arguments:

• color (of type int, which defaults to 0xffffff): Text color (in 0xRRGGBB format).
• cycle (of type bool, which defaults to true): Draw a second copy of the text so that scrolling wraps around.
• font (of type string?, which defaults to null): Path to the font file.
• metadata (of type string?, which defaults to null): Metadata to read the text from.
• size (of type int, which defaults to 18): Font size.
• speed (of type int, which defaults to 70): Horizontal speed, in pixels per second (0: no scrolling).
• x (of type {int}, which defaults to 10): x offset.
• y (of type {int}, which defaults to 10): y offset.
• graph (of type ffmpeg.filter.graph): Filter graph.
• (unlabeled) (of type {string}): Text to display.
• (unlabeled) (of type source(video=ffmpeg.video.raw('d), 'e) .{ on_frame : (synchronous : bool, (() -> unit)) -> 'a, on_metadata : (synchronous : bool, (('b) -> unit)) -> 'c }): Source whose video track carries the text.

video.add_text.ffmpeg.raw.filter

Draw a text on a video pad of a filter graph with drawtext, updated by commands. The text and its position are read on each call of the returned value's on_change; on_metadata sets the text from a metadata.

Type:

(?color : int, ?cycle : bool, ?font : string?, ?metadata : string?,
 ?size : int, ?speed : int, ?x : {int}, ?y : {int},
 graph : ffmpeg.filter.graph, ?{string}, ffmpeg.filter.video) ->
ffmpeg.filter.video

Arguments:

• color (of type int, which defaults to 0xffffff): Text color (in 0xRRGGBB format).
• cycle (of type bool, which defaults to true): Draw a second copy of the text so that scrolling wraps around.
• font (of type string?, which defaults to null): Path to the font file.
• metadata (of type string?, which defaults to null): Metadata to read the text from.
• size (of type int, which defaults to 18): Font size.
• speed (of type int, which defaults to 70): Horizontal speed, in pixels per second (0: no scrolling).
• x (of type {int}, which defaults to 10): x offset.
• y (of type {int}, which defaults to 10): y offset.
• graph (of type ffmpeg.filter.graph): Filter graph.
• (unlabeled) (of type {string}, which defaults to ""): Text to display.
• (unlabeled) (of type ffmpeg.filter.video): Video pad.

Methods:

• on_change (of type () -> unit)
• on_metadata (of type ([string * string]) -> unit)