Liquidsoap scripting language reference

The Source / … categories contain all functions that return sources. The Input functions are those which build elementary sources (playing files, synthesizing sound, etc.). The Output functions are those which take a source and register it for being streamed to the outside (file, soundcard, audio server, etc.). The Visualization functions are experimental ones that let you visualize in real-time some aspects of the audio stream. The Sound Processing functions are those which basically work on the source as a continuous audio stream. They would typically be mixers of streams, audio effects or analysis. Finally, Track Processing functions are basically all others, often having a behaviour that depends on or affects the extra information that liquidsoap puts in streams: track limits and metadata.

Interaction

add_skip_command

Add a skip telnet command to a source when it does not have one by default.

Type:

(source('c).{on_wake_up : ((() -> unit)) -> 'b, skip : () -> 'a}) -> 'b

Arguments:

  • (unlabeled) (of type source('c).{on_wake_up : ((() -> unit)) -> 'b, skip : () -> 'a}): The source to attach the command to.

audioscrobbler.submit.full

Submit songs using audioscrobbler, respecting the full protocol: First signal song as now playing when starting, and then submit song when it ends.

Type:

(user : string, password : string, ?host : string, ?port : int,
 ?source : string, ?length : bool, ?delay : float, ?force : bool, source('A)) ->
source('A)

Arguments:

  • user (of type string)
  • password (of type string)
  • host (of type string, which defaults to "post.audioscrobbler.com")
  • port (of type int, which defaults to 80)
  • source (of type string, which defaults to "broadcast"): Source for tracks. Should be one of: “broadcast”, “user”, “recommendation” or “unknown”. Since liquidsoap is intended for radio broadcasting, this is the default. Sources other than user don’t need duration to be set.
  • length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
  • delay (of type float, which defaults to 10.): Submit song when there is only this delay left, in seconds.
  • force (of type bool, which defaults to false): If remaining time is null, the song will be assumed to be skipped or cut, and not submitted. Set to zero to disable this behaviour.
  • (unlabeled) (of type source('A))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

compress.multiband.interactive

Create a multiband compressor whose parameters are interactive variables.

Type:

(?id : string?, ?bands : int, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a).{gain? : never, rms? : never}, 'b)
where
  'b is a set of tracks to be muxed into a source and a set of internal tracks

Arguments:

  • id (of type string?, which defaults to null): Id of the source. Variable names are prefixed with this.
  • bands (of type int, which defaults to 5): Number of bands.
  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source and a set of internal tracks): Source to compress.

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • gain (of type () -> float):
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • rms (of type () -> float):
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

interactive.bool

Read a boolean from an interactive input.

Type:

(?description : string, ?osc : string, string, bool) -> () -> bool

Arguments:

  • description (of type string, which defaults to ""): Description of the variable.
  • osc (of type string, which defaults to ""): OSC address.
  • (unlabeled) (of type string): Name of the variable.
  • (unlabeled) (of type bool): Initial value.

Methods:

  • remove (of type () -> unit):
  • set (of type (bool) -> unit):

interactive.float

Read a float from an interactive input.

Type:

(?min : float, ?max : float, ?step : float, ?description : string,
 ?unit : string, ?osc : string, string, float) -> () -> float

Arguments:

  • min (of type float, which defaults to -inf): Minimal value.
  • max (of type float, which defaults to inf): Maximal value.
  • step (of type float, which defaults to 0.1): Typical variation of the value.
  • description (of type string, which defaults to ""): Description of the variable.
  • unit (of type string, which defaults to ""): Unit for the variable.
  • osc (of type string, which defaults to ""): OSC address.
  • (unlabeled) (of type string): Name of the variable.
  • (unlabeled) (of type float): Initial value.

Methods:

  • remove (of type () -> unit):
  • set (of type (float) -> unit):

interactive.harbor

Expose interactive variables through habor http server. Once this is called, with default parameters, you can browse http://localhost:8000/interactive to change the value of interactive variables using sliders.

Type:

(?transport : http_transport
 .{default_port : int, name : string, protocol : string}, ?port : int,
 ?uri : string) -> unit

Arguments:

  • transport (of type http_transport.{default_port : int, name : string, protocol : string}, which defaults to <unix_transport>.{default_port=80, protocol="http", name="unix"}): Http transport. Use http.transport.ssl or http.transport.secure_transport`, when available, to enable HTTPS output
  • port (of type int, which defaults to 8000): Port of the server.
  • uri (of type string, which defaults to "/interactive"): URI of the server.

interactive.int

Read an integer from an interactive input.

Type:

(?description : string, ?osc : string, string, int) -> () -> int

Arguments:

  • description (of type string, which defaults to ""): Description of the variable.
  • osc (of type string, which defaults to ""): OSC address.
  • (unlabeled) (of type string): Name of the variable.
  • (unlabeled) (of type int): Initial value.

Methods:

  • remove (of type () -> unit):
  • set (of type (int) -> unit):

interactive.load

Load the value of interactive variables from a file.

Type:

(string) -> unit

Arguments:

  • (unlabeled) (of type string): Name of the file.

interactive.persistent

Make the value of interactive variables persistent: they are loaded from the given file and stored there whenever updated. This function should be called after all interactive variables have been defined (variables not declared yet will not be loaded).

Type:

(string) -> unit

Arguments:

  • (unlabeled) (of type string): Name of the file.

interactive.save

Save the value of all interactive variables in a file.

Type:

(string) -> unit

Arguments:

  • (unlabeled) (of type string): Name of the file.

interactive.string

Read a string from an interactive input.

Type:

(?description : string, ?osc : string, string, string) -> () -> string

Arguments:

  • description (of type string, which defaults to ""): Description of the variable.
  • osc (of type string, which defaults to ""): OSC address.
  • (unlabeled) (of type string): Name of the variable.
  • (unlabeled) (of type string): Initial value.

Methods:

  • remove (of type () -> unit):
  • set (of type (string) -> unit):

interactive.unit

Register a callback when a unit interactive input is set.

Type:

(?description : string, ?osc : string, string, (() -> unit)) -> unit

Arguments:

  • description (of type string, which defaults to ""): Description of the variable.
  • osc (of type string, which defaults to ""): OSC address.
  • (unlabeled) (of type string): Name of the variable.
  • (unlabeled) (of type () -> unit): Function triggered when the value is set.

Methods:

  • remove (of type () -> unit):
  • set (of type () -> unit):

lastfm.nowplaying

Submit metadata to lastfm.fm using the audioscrobbler protocol (nowplaying mode).

Type:

(user : string, password : string, ?length : bool, [string * string]) -> unit

Arguments:

  • user (of type string)
  • password (of type string)
  • length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
  • (unlabeled) (of type [string * string])

lastfm.submit

Submit metadata to lastfm.fm using the audioscrobbler protocol.

Type:

(user : string, password : string, ?source : string, ?length : bool,
 [string * string]) -> unit

Arguments:

  • user (of type string)
  • password (of type string)
  • source (of type string, which defaults to "broadcast"): Source for tracks. Should be one of: “broadcast”, “user”, “recommendation” or “unknown”. Since liquidsoap is intended for radio broadcasting, this is the default. Sources other than user don’t need duration to be set.
  • length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
  • (unlabeled) (of type [string * string])

lastfm.submit.full

Submit songs to lastfm using audioscrobbler, respecting the full protocol: First signal song as now playing when starting, and then submit song when it ends.

Type:

(user : string, password : string, ?source : string, ?length : bool,
 ?delay : float, ?force : bool, source('A)) -> source('A)

Arguments:

  • user (of type string)
  • password (of type string)
  • source (of type string, which defaults to "broadcast"): Source for tracks. Should be one of: “broadcast”, “user”, “recommendation” or “unknown”. Since liquidsoap is intended for radio broadcasting, this is the default. Sources other than user don’t need duration to be set.
  • length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
  • delay (of type float, which defaults to 10.): Submit song when there is only this delay left, in seconds. If remaining time is less than this value, the song will be assumed to be skipped or cut, and not submitted. Set to zero to disable this behaviour.
  • force (of type bool, which defaults to false): If remaining time is null, the song will be assumed to be skipped or cut, and not submitted. Set to zero to disable this behaviour.
  • (unlabeled) (of type source('A))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

librefm.nowplaying

Submit metadata to libre.fm using the audioscrobbler protocol (nowplaying mode).

Type:

(user : string, password : string, ?length : bool, [string * string]) -> unit

Arguments:

  • user (of type string)
  • password (of type string)
  • length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
  • (unlabeled) (of type [string * string])

librefm.submit

Submit metadata to libre.fm using the audioscrobbler protocol.

Type:

(user : string, password : string, ?source : string, ?length : bool,
 [string * string]) -> unit

Arguments:

  • user (of type string)
  • password (of type string)
  • source (of type string, which defaults to "broadcast"): Source for tracks. Should be one of: “broadcast”, “user”, “recommendation” or “unknown”. Since liquidsoap is intended for radio broadcasting, this is the default. Sources other than user don’t need duration to be set.
  • length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
  • (unlabeled) (of type [string * string])

librefm.submit.full

Submit songs to librefm using audioscrobbler, respecting the full protocol: First signal song as now playing when starting, and then submit song when it ends.

Type:

(user : string, password : string, ?source : string, ?length : bool,
 ?delay : float, ?force : bool, source('A)) -> source('A)

Arguments:

  • user (of type string)
  • password (of type string)
  • source (of type string, which defaults to "broadcast"): Source for tracks. Should be one of: “broadcast”, “user”, “recommendation” or “unknown”. Since liquidsoap is intended for radio broadcasting, this is the default. Sources other than user don’t need duration to be set.
  • length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
  • delay (of type float, which defaults to 10.): Submit song when there is only this delay left, in seconds. If remaining time is less than this value, the song will be assumed to be skipped or cut, and not submitted. Set to zero to disable this behaviour.
  • force (of type bool, which defaults to false): If remaining time is null, the song will be assumed to be skipped or cut, and not submitted. Set to zero to disable this behaviour.
  • (unlabeled) (of type source('A))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Internet

harbor.http.middleware.cors

Harbor middleware to add CORS headers

Type:

(?origin : string?,
 ?origin_callback : ((
                      {
                        body : (?timeout : float) -> string,
                        data : (?timeout : float) -> string,
                        headers : [string * string],
                        http_version : string,
                        method : string,
                        path : string,
                        query : [string * string]
                      }) -> string?)?,
 ?methods : [string], ?allowed_headers : [string]?,
 ?exposed_headers : [string], ?credentials : bool, ?max_age : int?,
 ?preflight_continue : bool, ?options_status_code : int) ->
(
 {
   body : (?timeout : float) -> string,
   data : (?timeout : float) -> string,
   headers : [string * string],
   http_version : string,
   method : string,
   path : string,
   query : [string * string]
 }, (() -> string)
 .{
   content_type : ((string?) -> unit)
   .{current : () -> string?
   },
   data : (({string}) -> unit)
   .{current : () -> {string}
   },
   header : (string, string) -> unit,
   headers : (([string * string]) -> unit)
   .{current : () -> [string * string]
   },
   html : ({string}) -> unit,
   http_version : ((string) -> unit)
   .{current : () -> string
   },
   json : (?compact : bool, 'a) -> unit,
   multipart_form : (?boundary : string?,
                     [
                      {
                        attributes : [string * string],
                        contents : {string},
                        headers : ['b * 'c],
                        name : string
                      }]) -> unit,
   redirect : (?status_code : int, string) -> unit,
   send_status : ('d.{write : (string) -> unit}) -> unit,
   status_code : ((int) -> unit)
   .{current : () -> int
   },
   status_message : ((string?) -> unit)
   .{current : () -> string?
   },
   status_sent : () -> bool
 },
 ((
   {
     body : (?timeout : float) -> string,
     data : (?timeout : float) -> string,
     headers : [string * string],
     http_version : string,
     method : string,
     path : string,
     query : [string * string]
   }, (() -> string)
   .{
     content_type : ((string?) -> unit)
     .{current : () -> string?
     },
     data : (({string}) -> unit)
     .{current : () -> {string}
     },
     header : (string, string) -> unit,
     headers : (([string * string]) -> unit)
     .{current : () -> [string * string]
     },
     html : ({string}) -> unit,
     http_version : ((string) -> unit)
     .{current : () -> string
     },
     json : (?compact : bool, 'a) -> unit,
     multipart_form : (?boundary : string?,
                       [
                        {
                          attributes : [string * string],
                          contents : {string},
                          headers : ['b * 'c],
                          name : string
                        }]) -> unit,
     redirect : (?status_code : int, string) -> unit,
     send_status : ('d.{write : (string) -> unit}) -> unit,
     status_code : ((int) -> unit)
     .{current : () -> int
     },
     status_message : ((string?) -> unit)
     .{current : () -> string?
     },
     status_sent : () -> bool
   }) -> unit)) -> unit

Arguments:

  • origin (of type string?, which defaults to "*"): Configures the Access-Control-Allow-Origin CORS header
  • origin_callback (of type (( { body : (?timeout : float) -> string, data : (?timeout : float) -> string, headers : [string * string], http_version : string, method : string, path : string, query : [string * string] }) -> string?)?, which defaults to null): Origin callback for advanced uses. If passed, overrides origin argument. Takes the request as input and returns the allowed origin. Return null to skip all CORS headers.
  • methods (of type [string], which defaults to ["GET", "HEAD", "PUT", "PATCH", "POST", "DELETE"]): Configures the Access-Control-Allow-Methods CORS header.
  • allowed_headers (of type [string]?, which defaults to null): Configures the Access-Control-Allow-Headers CORS header. If not specified, defaults to reflecting the headers specified in the request’s Access-Control-Request-Headers header.
  • exposed_headers (of type [string], which defaults to []): Configures the Access-Control-Expose-Headers CORS header. If not specified, no custom headers are exposed.
  • credentials (of type bool, which defaults to false): Configures the Access-Control-Allow-Credentials CORS header. Set to true to pass the header, otherwise it is omitted.
  • max_age (of type int?, which defaults to null): Configures the Access-Control-Max-Age CORS header. Set to an integer to pass the header, otherwise it is omitted.
  • preflight_continue (of type bool, which defaults to false): Pass the CORS preflight response to the nexnhandler.
  • options_status_code (of type int, which defaults to 204): Provides a status code to use for successful OPTIONS requests, since some legacy browsers (IE11, various SmartTVs) choke on 204.

openai.chat

Query ChatGPT API.

Type:

(key : string, ?base_url : string, ?model : string, ?timeout : float?,
 [
  {
    content : string,
    name? : string,
    role : string,
    tool_call_id? : string,
    tool_calls? : [
                   {
                     function : 
                     {arguments : string, name : string
                     },
                     id : string,
                     type : string
                   }]
  }]) -> unit

Arguments:

  • key (of type string): OpenAI API key.
  • base_url (of type string, which defaults to "https://api.openai.com"): Base URL for the API query
  • model (of type string, which defaults to "gpt-3.5-turbo"): Language model.
  • timeout (of type float?, which defaults to 30.): Timeout for network operations in seconds.
  • (unlabeled) (of type [ { content : string, name? : string, role : string, tool_call_id? : string, tool_calls? : [ { function : {arguments : string, name : string }, id : string, type : string }] }]): Messages initially exchanged.

Methods:

  • choices (of type [ { finish_reason : string, index : int, message : {content : string, role : string } }]):
  • created (of type int):
  • model (of type string):
  • object (of type string):
  • usage (of type {completion_tokens : int, prompt_tokens : int, total_tokens : int}):

openai.speech

Generate speech using openai. Returns the encoded audio data.

Type:

(key : string, ?base_url : string, ?model : string, ?timeout : float?,
 voice : string, ?response_format : string, ?speed : float,
 on_data : ((string?) -> unit), string) -> unit

Arguments:

  • key (of type string): OpenAI API key.
  • base_url (of type string, which defaults to "https://api.openai.com"): Base URL for the API query
  • model (of type string, which defaults to "tts-1"): Language model.
  • timeout (of type float?, which defaults to 30.): Timeout for network operations in seconds.
  • voice (of type string): The voice to use when generating the audio. Supported voices are "alloy", "echo", "fable", "onyx", "nova", and "shimmer"
  • response_format (of type string, which defaults to "mp3"): The format to audio in. Supported formats are: "mp3", "opus", "aac", and "flac".
  • speed (of type float, which defaults to 1.): The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.
  • on_data (of type (string?) -> unit)
  • (unlabeled) (of type string): ~on_data Function executed when receiving the audio data.

server.harbor

Start an interface for the “telnet” server over http.

Type:

(?transport : http_transport
 .{default_port : int, name : string, protocol : string}, ?port : int,
 ?uri : string) -> unit

Arguments:

  • transport (of type http_transport.{default_port : int, name : string, protocol : string}, which defaults to <unix_transport>.{default_port=80, protocol="http", name="unix"}): Http transport. Use http.transport.ssl or http.transport.secure_transport`, when available, to enable HTTPS output
  • port (of type int, which defaults to 8000): Port of the server.
  • uri (of type string, which defaults to "/telnet"): URI of the server.

Metadata

file.cover.manager

Store and retrieve file covers using metadata. This returns a set of getter/setter methods that can be used to store and retrieve cover art. Typical usage is to set cover art in a on_metadata handler and retrieve it in a video.add_image operator. See video.add_cover for an implementation example.

Type:

(?id : string?, ?mime_types : [string * string], default : string) ->
() -> string

Arguments:

  • id (of type string?, which defaults to null)
  • mime_types (of type [string * string], which defaults to [("image/gif", "gif"), ("image/jpg", "jpeg"), ("image/jpeg", "jpeg"), ("image/png", "png"), ("image/webp", "webp")]): Recognized mime types and their corresponding file extensions.
  • default (of type string): Default cover file when no cover is available

Methods:

  • set (of type ([string * string]) -> unit):

source.say_metadata

Append speech-synthesized tracks reading the metadata.

Type:

(?id : string?, ?pattern : (([string * string]) -> string), source('a)) ->
source('a)

Arguments:

  • id (of type string?, which defaults to "source.say_metadata")
  • pattern (of type ([string * string]) -> string, which defaults to <fun>): Pattern to use
  • (unlabeled) (of type source('a)): The source to use

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • cancel_pending (of type () -> unit):
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • pending (of type () -> source('A)?):
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • selected (of type () -> source('A)?): Currently selected source.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • set_pending (of type (source('A)?) -> unit):
  • skip (of type (?cancel_pending : bool) -> unit):
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Source / Audio processing

accelerate

Accelerate a stream by dropping frames. This is useful for testing scripts.

Type:

(?id : string?, ?randomize : {float}, ?ratio : {float}, source('a)) ->
source('a)

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • randomize (of type {float}, which defaults to 1.): Randomization (0 means no randomization).
  • ratio (of type {float}, which defaults to 2.): A value higher than 1 means speeding up.
  • (unlabeled) (of type source('a))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

This function is experimental.

bass_boost

Add some bass to the sound.

Type:

(?frequency : {float}, ?gain : {float}, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a), 'b)
where
  'b is a set of tracks to be muxed into a source and a set of internal tracks

Arguments:

  • frequency (of type {float}, which defaults to 200.): Frequency below which sound is considered as bass.
  • gain (of type {float}, which defaults to 10.): Amount of boosting (dB).
  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source and a set of internal tracks): Source whose bass should be boosted

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

comb

Comb filter

Type:

(?id : string?, ?delay : float, ?feedback : {float}, source(audio=pcm('a),
 'b)) -> source(audio=pcm('a), 'b)
where 'b is a set of tracks to be muxed into a source

Arguments:

  • id (of type string?, which defaults to "comb"): Force the value of the track ID.
  • delay (of type float, which defaults to 0.001): Delay in seconds.
  • feedback (of type {float}, which defaults to -6.): Feedback coefficient in dB.
  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source)

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

compand

Compand the signal.

Type:

(?id : string?, ?mu : float, source(audio=source(pcm('a)), 'b)) ->
source(audio=pcm('a), 'b)
where 'b is a set of tracks to be muxed into a source

Arguments:

  • id (of type string?, which defaults to "compand"): Force the value of the track ID.
  • mu (of type float, which defaults to 1.)
  • (unlabeled) (of type source(audio=source(pcm('a)), 'b) where 'b is a set of tracks to be muxed into a source)

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

compress

Compress the signal.

Type:

(?id : string?, ?attack : {float}, ?release : {float}, ?lookahead : {float},
 ?threshold : {float}, ?track_sensitive : bool, ?knee : {float},
 ?pre_gain : {float}, ?gain : {float}, ?ratio : {float}, ?window : {float},
 ?wet : {float}, source(audio=pcm('a), 'b)) -> source(audio=pcm('a)
.{gain? : never, rms? : never}, 'b)
where 'b is a set of tracks to be muxed into a source

Arguments:

  • id (of type string?, which defaults to null): Force the value of the track ID.
  • attack (of type {float}, which defaults to 50.): Attack time (ms).
  • release (of type {float}, which defaults to 400.): Release time (ms).
  • lookahead (of type {float}, which defaults to 0.): Lookahead (ms).
  • threshold (of type {float}, which defaults to -10.): Threshold level (dB).
  • track_sensitive (of type bool, which defaults to false): Reset on every track.
  • knee (of type {float}, which defaults to 1.): Knee width (dB).
  • pre_gain (of type {float}, which defaults to 0.): Pre-amplification (dB).
  • gain (of type {float}, which defaults to 0.): Post-amplification (dB).
  • ratio (of type {float}, which defaults to 2.): Gain reduction ratio (reduction is ratio:1). Must be at least 1.
  • window (of type {float}, which defaults to 0.): RMS window length (second). 0. means peak mode.
  • wet (of type {float}, which defaults to 1.): How much of input sound to output (between 0 and 1, 0 means only original sound, 1 means only compressed sound).
  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source)

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • gain (of type () -> float):
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • rms (of type () -> float):
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

compress.exponential

Exponential compressor.

Type:

(?id : string?, ?mu : float, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a), 'b)
where 'b is a set of tracks to be muxed into a source

Arguments:

  • id (of type string?, which defaults to null): Force the value of the track ID.
  • mu (of type float, which defaults to 2.): Exponential compression factor, typically greater than 1.
  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source)

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

compress.multiband

Multiband compression. The list in argument specifies - the frequency below which we should apply compression (it is above previous band) - the attack time (ms) - the release time (ms) - the compression ratio - the threshold for compression - the gain for the band

Type:

(?limit : bool, ?wet : {float}, source(audio=pcm('a), 'b),
 [
  {
    attack : {float},
    frequency : {float},
    gain : {float},
    ratio : {float},
    release : {float},
    threshold : {float}
  }]) -> source(audio=pcm('a).{gain? : never, rms? : never}, 'b)
where
  'b is a set of tracks to be muxed into a source and a set of internal tracks

Arguments:

  • limit (of type bool, which defaults to true): Also apply limiting to bands.
  • wet (of type {float}, which defaults to 1.)
  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source and a set of internal tracks): Parameters for compression bands.
  • (unlabeled) (of type [ { attack : {float}, frequency : {float}, gain : {float}, ratio : {float}, release : {float}, threshold : {float} }]): Source on which multiband compression should be applied.

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • gain (of type () -> float):
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • rms (of type () -> float):
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

dry_wet

Mix between dry and wet sources. Useful for testing effects. Typically:

c = interactive.float("wetness", min=0., max=1., 1.)
s = dry_wet(c, s, effect(s))

and vary c to hear the difference between the source without and with the effect.

Type:

(?power : bool, {float}, source('a), source('a)) -> source('a)
where 'a is a set of internal tracks

Arguments:

  • power (of type bool, which defaults to false): If true use constant power mixing.
  • (unlabeled) (of type {float}): Wetness coefficient, from 0 (fully dry) to 1 (fully wet).
  • (unlabeled) (of type source('a) where 'a is a set of internal tracks): Dry source.
  • (unlabeled) (of type source('a) where 'a is a set of internal tracks): Wet source.

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

file.autocue

Compute autocue data

Type:

(?lufs_target : float?, ?cue_in_threshold : float?,
 ?cue_out_threshold : float?, ?cross_threshold : float?,
 ?max_overlap : float?, ?ratio : float?, ?timeout : float?, string) -> 
{
  amplify : float,
  cross_duration : float,
  cue_in : float?,
  cue_out : float?,
  fade_in : float,
  fade_out : float}?

Arguments:

  • lufs_target (of type float?, which defaults to null): Loudness target in LUFS
  • cue_in_threshold (of type float?, which defaults to null): Cue in threshold
  • cue_out_threshold (of type float?, which defaults to null): Cue out threshold
  • cross_threshold (of type float?, which defaults to null): Crossfade start threshold
  • max_overlap (of type float?, which defaults to null): Maximum allowed overlap/crossfade in seconds
  • ratio (of type float?, which defaults to null): Decoding ratio. A value of 50. means try to decode the file 50x faster than real time, if possible. Use this setting to lower CPU peaks when computing autocue data.
  • timeout (of type float?, which defaults to null)
  • (unlabeled) (of type string)

file.autocue.metadata

Return the file’s autocue values as metadata suitable for metadata override.

Type:

(?lufs_target : float?, ?cue_in_threshold : float?,
 ?cue_out_threshold : float?, ?cross_threshold : float?,
 ?max_overlap : float?, ?ratio : float?, string) -> [string * string]

Arguments:

  • lufs_target (of type float?, which defaults to null): Loudness target in LUFS
  • cue_in_threshold (of type float?, which defaults to null): Cue in threshold
  • cue_out_threshold (of type float?, which defaults to null): Cue out threshold
  • cross_threshold (of type float?, which defaults to null): Crossfade start threshold
  • max_overlap (of type float?, which defaults to null): Maximum allowed overlap/crossfade in seconds
  • ratio (of type float?, which defaults to null): Decoding ratio. A value of 50. means try to decode the file 50x faster than real time, if possible. Use this setting to lower CPU peaks when computing autocue data.
  • (unlabeled) (of type string)

filter.iir.eq.low_high

A bandpass filter obtained by chaining a low-pass and a high-pass filter.

Type:

(?id : string?, low : {float}, high : {float}, ?q : float, source('a)) ->
source('a)

Arguments:

  • id (of type string?, which defaults to null)
  • low (of type {float}): Lower frequency of the bandpass filter.
  • high (of type {float}): Higher frequency of the bandpass filter.
  • q (of type float, which defaults to 1.): Q factor.
  • (unlabeled) (of type source('a)): Force the value of the source ID.

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

helium

Increases the pitch, making voices sound like on helium.

Type:

(source(audio=pcm('a), 'b)) -> source(audio=pcm('a), 'b)

Arguments:

  • (unlabeled) (of type source(audio=pcm('a), 'b)): The input source.

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ladspa.amp_mono

Mono Amplifier by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, ?gain : {float}, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a), 'b)

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • gain (of type {float}, which defaults to 1.): Gain (0 <= gain).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ladspa.amp_stereo

Stereo Amplifier by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, ?gain : {float}, source(audio=pcm('a), 'b)) ->
source(audio=pcm(stereo), 'b)

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • gain (of type {float}, which defaults to 1.): Gain (0 <= gain).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ladspa.delay_5s

Simple Delay Line by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, ?delay : {float}, ?dry_wet_balance : {float},
 source(audio=pcm('a), 'b)) -> source(audio=pcm('a), 'b)

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • delay (of type {float}, which defaults to 1.): Delay (Seconds) (0 <= delay <= 5).
  • dry_wet_balance (of type {float}, which defaults to 0.5): Dry/Wet Balance (0 <= dry_wet_balance <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ladspa.hpf

Simple High Pass Filter by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, ?cutoff_frequency : {float}, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a), 'b)

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • cutoff_frequency (of type {float}, which defaults to 440.): Cutoff Frequency (Hz) (0 <= cutoff_frequency <= 22050).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ladspa.lpf

Simple Low Pass Filter by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, ?cutoff_frequency : {float}, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a), 'b)

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • cutoff_frequency (of type {float}, which defaults to 440.): Cutoff Frequency (Hz) (0 <= cutoff_frequency <= 22050).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ladspa.sine_faaa

Sine Oscillator (Freq:audio, Amp:audio) by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, source(audio=pcm('a), 'b)) -> source(audio=pcm(mono), 'b)

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ladspa.sine_faac

Sine Oscillator (Freq:audio, Amp:control) by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, ?amplitude : {float}, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a), 'b)

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • amplitude (of type {float}, which defaults to 1.): Amplitude (0 <= amplitude).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ladspa.sine_fcaa

Sine Oscillator (Freq:control, Amp:audio) by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, ?frequency : {float}, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a), 'b)

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • frequency (of type {float}, which defaults to 440.): Frequency (Hz) (0 <= frequency <= 22050).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

limit

A limiter. This is a compress with tweaked parameters.

Type:

(?id : string?, ?attack : {float}, ?release : {float}, ?ratio : {float},
 ?threshold : {float}, ?pre_gain : {float}, ?gain : {float},
 source(audio=pcm('a), 'b)) -> source(audio=pcm('a)
.{gain? : never, rms? : never}, 'b)
where 'b is a set of tracks to be muxed into a source

Arguments:

  • id (of type string?, which defaults to null)
  • attack (of type {float}, which defaults to 50.)
  • release (of type {float}, which defaults to 200.)
  • ratio (of type {float}, which defaults to 20.)
  • threshold (of type {float}, which defaults to -2.)
  • pre_gain (of type {float}, which defaults to 0.)
  • gain (of type {float}, which defaults to 0.)
  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source)

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • gain (of type () -> float):
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • rms (of type () -> float):
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

mic_filter

Remove low frequencies often produced by microphones.

Type:

(?frequency : float, source(audio=pcm('a), 'b)) -> source(audio=pcm('a), 'b)

Arguments:

  • frequency (of type float, which defaults to 200.): Frequency under which sound should be lowered.
  • (unlabeled) (of type source(audio=pcm('a), 'b)): The input source.

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

mix

Mixing table controllable via source methods and optional server/telnet commands.

Type:

(?id : string?, ?register_server_commands : bool,
 [source(audio=pcm('a), 'b)]) -> source(audio=pcm('a), 'b)
where
  'b is a set of tracks to be muxed into a source and a set of internal tracks

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • register_server_commands (of type bool, which defaults to true): Register corresponding server commands
  • (unlabeled) (of type [source(audio=pcm('a), 'b)] where 'b is a set of tracks to be muxed into a source and a set of internal tracks)

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • inputs (of type [ { selected : (() -> bool) .{set : (bool) -> unit }, single : (() -> bool) .{set : (bool) -> unit }, source : source(audio=pcm('B), 'A), volume : (() -> float) .{set : (float) -> unit } }] where 'A is a set of tracks to be muxed into a source and a set of internal tracks):
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

nrj

Compress and normalize, producing a more uniform and “full” sound.

Type:

(source(audio=pcm('a), 'b)) -> source(audio=pcm('a)
.{gain? : never, rms? : never}, 'b)
where 'b is a set of tracks to be muxed into a source

Arguments:

  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source): The input source.

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • gain (of type () -> float):
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • rms (of type () -> float):
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

sky

Multiband-compression.

Type:

(source(audio=pcm('a), 'b)) -> source(audio=pcm('a)
.{gain? : never, rms? : never}, 'b)
where
  'b is a set of tracks to be muxed into a source and a set of internal tracks

Arguments:

  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source and a set of internal tracks): The input source.

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Source / FFmpeg filter

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

ffmpeg.filter.acrossfade

Ffmpeg filter: Cross fade two input audio streams.

Type:

(?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.audio) ->
ffmpeg.filter.audio

Arguments:

  • 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))
  • 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))
  • 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))
  • 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))
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)
  • (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.acrossfade.create

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

Type:

(?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:

  • 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))
  • 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))
  • 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))
  • 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))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?, ?knee : float?, ?ratio : float?, ?makeup : float?,
 ?range : float?, ?slew : float?, ?mode : int?, ?tftype : 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 attack duration. (default: 20.)
  • release (of type float?, which defaults to null): set release duration. (default: 200.)
  • knee (of type float?, which defaults to null): set knee factor. (default: 1.)
  • 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: 0.)
  • slew (of type float?, which defaults to null): set slew factor. (default: 1.)
  • mode (of type int?, which defaults to null): set mode. (default: 0, possible values: -1 (listen), 0 (cut), 1 (boost))
  • tftype (of type int?, which defaults to null): set target filter type. (default: 0, possible values: 0 (bell), 1 (lowshelf), 2 (highshelf))
  • (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?, ?knee : float?, ?ratio : float?, ?makeup : float?,
 ?range : float?, ?slew : float?, ?mode : int?, ?tftype : 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 attack duration. (default: 20.)
  • release (of type float?, which defaults to null): set release duration. (default: 200.)
  • knee (of type float?, which defaults to null): set knee factor. (default: 1.)
  • 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: 0.)
  • slew (of type float?, which defaults to null): set slew factor. (default: 1.)
  • mode (of type int?, which defaults to null): set mode. (default: 0, possible values: -1 (listen), 0 (cut), 1 (boost))
  • tftype (of type int?, which defaults to null): set target filter type. (default: 0, possible values: 0 (bell), 1 (lowshelf), 2 (highshelf))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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: -1)
  • d (of type int?, which defaults to null): set audio duration. (default: -1)
  • 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: -1)
  • d (of type int?, which defaults to null): set audio duration. (default: -1)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?, 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))
  • 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))
  • (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?, 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))
  • 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))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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))
  • 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))
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

ffmpeg.filter.afifo

Ffmpeg filter: Buffer input frames and send them when they are requested.

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.afifo.create

Ffmpeg filter: Buffer input frames and send them when they are requested.. 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

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

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))
  • 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))
  • (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. 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:

(?dry : float?, ?wet : float?, ?length : float?, ?gtype : int?,
 ?irgain : float?, ?irfmt : int?, ?maxir : float?, ?response : bool?,
 ?channel : int?, ?size : string?, ?rate : string?, ?minp : int?,
 ?maxp : int?, ?nbirs : int?, ?ir : int?, ?precision : 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))
  • 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))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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), 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))
  • 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), 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))
  • (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), 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))
  • 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), 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))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

ffmpeg.filter.aformat

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

Type:

(?sample_fmts : string?, ?f : string?, ?sample_rates : string?, ?r : string?,
 ?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 string?, which defaults to null): A ‘|’-separated list of sample rates.
  • r (of type string?, 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 : string?, ?r : string?,
 ?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 string?, which defaults to null): A ‘|’-separated list of sample rates.
  • r (of type string?, 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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))
  • m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact))
  • flags (of type int?, which defaults to null): set flags. (default: 1, possible values: 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))
  • f (of type int?, which defaults to null): set flags. (default: 1, possible values: 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))
  • 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))
  • m (of type int?, which defaults to null): set mode. (default: 0, possible values: 0 (full), 1 (compact))
  • flags (of type int?, which defaults to null): set flags. (default: 1, possible values: 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))
  • f (of type int?, which defaults to null): set flags. (default: 1, possible values: 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))
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

ffmpeg.filter.aloop

Ffmpeg filter: Loop audio samples.

Type:

(?loop : int?, ?size : int?, ?start : 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)
  • (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?, 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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?,
 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)
  • (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?,
 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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?, 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)
  • (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?, ffmpeg.filter.graph) -> unit

Arguments:

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

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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: 2000)
  • p (of type int?, which defaults to null): set patch duration. (default: 2000)
  • research (of type int?, which defaults to null): set research duration. (default: 6000)
  • r (of type int?, which defaults to null): set research duration. (default: 6000)
  • 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: 2000)
  • p (of type int?, which defaults to null): set patch duration. (default: 2000)
  • research (of type int?, which defaults to null): set research duration. (default: 6000)
  • r (of type int?, which defaults to null): set research duration. (default: 6000)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?, 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))
  • (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?, 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))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?, 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))
  • (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?, 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))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?, 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)
  • (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?, 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

ffmpeg.filter.anullsrc

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

Type:

(?channel_layout : string?, ?cl : string?, ?sample_rate : string?,
 ?r : string?, ?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 string?, which defaults to null): set sample rate. (default: 44100)
  • r (of type string?, 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: -1)
  • d (of type int?, which defaults to null): set the audio duration. (default: -1)
  • (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 : string?,
 ?r : string?, ?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 string?, which defaults to null): set sample rate. (default: 44100)
  • r (of type string?, 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: -1)
  • d (of type int?, which defaults to null): set the audio duration. (default: -1)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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: -1)
  • whole_dur (of type int?, which defaults to null): set minimum target duration in the audio stream. (default: -1)
  • (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: -1)
  • whole_dur (of type int?, which defaults to null): set minimum target duration in the audio stream. (default: -1)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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: 2000000)
  • d (of type int?, which defaults to null): set minimum mono or out-of-phase duration in seconds. (default: 2000000)
  • (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: 2000000)
  • d (of type int?, which defaults to null): set minimum mono or out-of-phase duration in seconds. (default: 2000000)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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: 2000000)
  • 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: 2000000)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

ffmpeg.filter.aresample

Ffmpeg filter: Resample audio data.

Type:

(?sample_rate : int?, ?ich : int?, ?in_channel_count : int?, ?och : int?,
 ?out_channel_count : int?, ?uch : int?, ?used_channel_count : 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?,
 ?icl : string?, ?in_channel_layout : string?, ?ocl : string?,
 ?out_channel_layout : 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
  • ich (of type int?, which defaults to null): set input channel count (Deprecated, use ichl). (default: 0)
  • in_channel_count (of type int?, which defaults to null): set input channel count (Deprecated, use in_chlayout). (default: 0)
  • och (of type int?, which defaults to null): set output channel count (Deprecated, use ochl). (default: 0)
  • out_channel_count (of type int?, which defaults to null): set output channel count (Deprecated, use out_chlayout). (default: 0)
  • uch (of type int?, which defaults to null): set used channel count. (default: 0)
  • used_channel_count (of type int?, which defaults to null): set used channel count. (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
  • icl (of type string?, which defaults to null): set input channel layout (Deprecated, use ichl)
  • in_channel_layout (of type string?, which defaults to null): set input channel layout (Deprecated, use in_chlayout)
  • ocl (of type string?, which defaults to null): set output channel layout (Deprecated, use ochl)
  • out_channel_layout (of type string?, which defaults to null): set output channel layout (Deprecated, use out_chlayout)
  • clev (of type float?, which defaults to null): set center mix level. (default: 0.707106781187)
  • center_mix_level (of type float?, which defaults to null): set center mix level. (default: 0.707106781187)
  • slev (of type float?, which defaults to null): set surround mix level. (default: 0.707106781187)
  • surround_mix_level (of type float?, which defaults to null): set surround mix Level. (default: 0.707106781187)
  • 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))
  • swr_flags (of type int?, which defaults to null): set flags. (default: 0, possible values: 1 (res))
  • 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.40282346639e+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?, ?ich : int?, ?in_channel_count : int?, ?och : int?,
 ?out_channel_count : int?, ?uch : int?, ?used_channel_count : 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?,
 ?icl : string?, ?in_channel_layout : string?, ?ocl : string?,
 ?out_channel_layout : 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
  • ich (of type int?, which defaults to null): set input channel count (Deprecated, use ichl). (default: 0)
  • in_channel_count (of type int?, which defaults to null): set input channel count (Deprecated, use in_chlayout). (default: 0)
  • och (of type int?, which defaults to null): set output channel count (Deprecated, use ochl). (default: 0)
  • out_channel_count (of type int?, which defaults to null): set output channel count (Deprecated, use out_chlayout). (default: 0)
  • uch (of type int?, which defaults to null): set used channel count. (default: 0)
  • used_channel_count (of type int?, which defaults to null): set used channel count. (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
  • icl (of type string?, which defaults to null): set input channel layout (Deprecated, use ichl)
  • in_channel_layout (of type string?, which defaults to null): set input channel layout (Deprecated, use in_chlayout)
  • ocl (of type string?, which defaults to null): set output channel layout (Deprecated, use ochl)
  • out_channel_layout (of type string?, which defaults to null): set output channel layout (Deprecated, use out_chlayout)
  • clev (of type float?, which defaults to null): set center mix level. (default: 0.707106781187)
  • center_mix_level (of type float?, which defaults to null): set center mix level. (default: 0.707106781187)
  • slev (of type float?, which defaults to null): set surround mix level. (default: 0.707106781187)
  • surround_mix_level (of type float?, which defaults to null): set surround mix Level. (default: 0.707106781187)
  • 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))
  • swr_flags (of type int?, which defaults to null): set flags. (default: 0, possible values: 1 (res))
  • 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.40282346639e+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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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), 17 (DYNAMIC_HDR_PLUS), 18 (REGIONS_OF_INTEREST), 22 (DETECTION_BOUNDING_BOXES), 20 (SEI_UNREGISTERED))
  • (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), 17 (DYNAMIC_HDR_PLUS), 18 (REGIONS_OF_INTEREST), 22 (DETECTION_BOUNDING_BOXES), 20 (SEI_UNREGISTERED))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

ffmpeg.filter.aspectralstats

Ffmpeg filter: Show frequency domain statistics about audio frames.

Type:

(?win_size : int?, ?win_func : int?, ?overlap : float?, 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))
  • 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.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?, 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))
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

ffmpeg.filter.asr

Ffmpeg filter: Automatic Speech Recognition.

Type:

(?rate : int?, ?hmm : string?, ?dict : string?, ?lm : string?,
 ?lmctl : string?, ?lmname : string?, ?logfn : string?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

  • rate (of type int?, which defaults to null): set sampling rate. (default: 16000)
  • hmm (of type string?, which defaults to null): set directory containing acoustic model files
  • dict (of type string?, which defaults to null): set pronunciation dictionary
  • lm (of type string?, which defaults to null): set language model file
  • lmctl (of type string?, which defaults to null): set language model set
  • lmname (of type string?, which defaults to null): set which language model to use
  • logfn (of type string?, which defaults to null): set output for log messages. (default: /dev/null)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.asr.create

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

Type:

(?rate : int?, ?hmm : string?, ?dict : string?, ?lm : string?,
 ?lmctl : string?, ?lmname : string?, ?logfn : string?, ffmpeg.filter.graph) ->
unit

Arguments:

  • rate (of type int?, which defaults to null): set sampling rate. (default: 16000)
  • hmm (of type string?, which defaults to null): set directory containing acoustic model files
  • dict (of type string?, which defaults to null): set pronunciation dictionary
  • lm (of type string?, which defaults to null): set language model file
  • lmctl (of type string?, which defaults to null): set language model set
  • lmname (of type string?, which defaults to null): set which language model to use
  • logfn (of type string?, which defaults to null): set output for log messages. (default: /dev/null)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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), 1 (DC_offset), 2 (Min_level), 4 (Max_level), 8 (Min_difference), 16 (Max_difference), 32 (Mean_difference), 64 (RMS_difference), 128 (Peak_level), 256 (RMS_level), 512 (RMS_peak), 1024 (RMS_trough), 2048 (Crest_factor), 4096 (Flat_factor), 8192 (Peak_count), 16384 (Bit_depth), 32768 (Dynamic_range), 65536 (Zero_crossings), 131072 (Zero_crossings_rate), 4194304 (Noise_floor), 8388608 (Noise_floor_count), 16777216 (Entropy), 262144 (Number_of_samples), 524288 (Number_of_NaNs), 1048576 (Number_of_Infs), 2097152 (Number_of_denormals))
  • measure_overall (of type int?, which defaults to null): Select the parameters which are measured overall. (default: 4294967295, possible values: 0 (none), 4294967295 (all), 1 (DC_offset), 2 (Min_level), 4 (Max_level), 8 (Min_difference), 16 (Max_difference), 32 (Mean_difference), 64 (RMS_difference), 128 (Peak_level), 256 (RMS_level), 512 (RMS_peak), 1024 (RMS_trough), 2048 (Crest_factor), 4096 (Flat_factor), 8192 (Peak_count), 16384 (Bit_depth), 32768 (Dynamic_range), 65536 (Zero_crossings), 131072 (Zero_crossings_rate), 4194304 (Noise_floor), 8388608 (Noise_floor_count), 16777216 (Entropy), 262144 (Number_of_samples), 524288 (Number_of_NaNs), 1048576 (Number_of_Infs), 2097152 (Number_of_denormals))
  • (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), 1 (DC_offset), 2 (Min_level), 4 (Max_level), 8 (Min_difference), 16 (Max_difference), 32 (Mean_difference), 64 (RMS_difference), 128 (Peak_level), 256 (RMS_level), 512 (RMS_peak), 1024 (RMS_trough), 2048 (Crest_factor), 4096 (Flat_factor), 8192 (Peak_count), 16384 (Bit_depth), 32768 (Dynamic_range), 65536 (Zero_crossings), 131072 (Zero_crossings_rate), 4194304 (Noise_floor), 8388608 (Noise_floor_count), 16777216 (Entropy), 262144 (Number_of_samples), 524288 (Number_of_NaNs), 1048576 (Number_of_Infs), 2097152 (Number_of_denormals))
  • measure_overall (of type int?, which defaults to null): Select the parameters which are measured overall. (default: 4294967295, possible values: 0 (none), 4294967295 (all), 1 (DC_offset), 2 (Min_level), 4 (Max_level), 8 (Min_difference), 16 (Max_difference), 32 (Mean_difference), 64 (RMS_difference), 128 (Peak_level), 256 (RMS_level), 512 (RMS_peak), 1024 (RMS_trough), 2048 (Crest_factor), 4096 (Flat_factor), 8192 (Peak_count), 16384 (Bit_depth), 32768 (Dynamic_range), 65536 (Zero_crossings), 131072 (Zero_crossings_rate), 4194304 (Noise_floor), 8388608 (Noise_floor_count), 16777216 (Entropy), 262144 (Number_of_samples), 524288 (Number_of_NaNs), 1048576 (Number_of_Infs), 2097152 (Number_of_denormals))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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: 9223372036854775807)
  • starti (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854775807)
  • end (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854775807)
  • endi (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854775807)
  • 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: 9223372036854775807)
  • starti (of type int?, which defaults to null): Timestamp of the first frame that should be passed. (default: 9223372036854775807)
  • end (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854775807)
  • endi (of type int?, which defaults to null): Timestamp of the first frame that should be dropped again. (default: 9223372036854775807)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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))
  • 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))
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.avgblur_opencl

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_opencl.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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.avgblur_vulkan

Ffmpeg filter: Apply avgblur mask to input video

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 radius. (default: 3)
  • planes (of type int?, which defaults to null): Set planes to filter (bitmask). (default: 15)
  • sizeY (of type int?, which defaults to null): Set vertical radius. (default: 3)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.avgblur_vulkan.create

Ffmpeg filter: Apply avgblur mask to input video. 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 radius. (default: 3)
  • planes (of type int?, which defaults to null): Set planes to filter (bitmask). (default: 15)
  • sizeY (of type int?, which defaults to null): Set vertical radius. (default: 3)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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 segment size. (default: 256)
  • algo (of type int?, which defaults to null): set algorithm. (default: 0, possible values: 0 (slow), 1 (fast))
  • (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 segment size. (default: 256)
  • algo (of type int?, which defaults to null): set algorithm. (default: 0, possible values: 0 (slow), 1 (fast))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

ffmpeg.filter.azmq

Ffmpeg filter: Receive commands through ZMQ and broker them to filters.

Type:

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

Arguments:

  • bind_address (of type string?, which defaults to null): set bind address. (default: tcp://*:5555)
  • b (of type string?, which defaults to null): set bind address. (default: tcp://*:5555)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.azmq.create

Ffmpeg filter: Receive commands through ZMQ and broker them to filters.. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

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

Arguments:

  • bind_address (of type string?, which defaults to null): set bind address. (default: tcp://*:5555)
  • b (of type string?, which defaults to null): set bind address. (default: tcp://*:5555)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.bitstream.aac_adtstoasc

FFmpeg aac_adtstoasc bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.av1_frame_merge

FFmpeg av1_frame_merge bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.av1_frame_split

FFmpeg av1_frame_split bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.av1_metadata

FFmpeg av1_metadata bitstream filter. See ffmpeg documentation for more details.

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)) ->
source(video=ffmpeg.copy, 'a)

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.chomp.audio

FFmpeg chomp.audio bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.chomp.video

FFmpeg chomp.video bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.dca_core

FFmpeg dca_core bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.dump_extra.audio

FFmpeg dump_extra.audio bitstream filter. See ffmpeg documentation for more details.

Type:

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

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.dump_extra.video

FFmpeg dump_extra.video bitstream filter. See ffmpeg documentation for more details.

Type:

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

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.dv_error_marker

FFmpeg dv_error_marker bitstream filter. See ffmpeg documentation for more details.

Type:

(?id : string?, ?color : string?, ?sta : int?, source(video=ffmpeg.copy, 'a)) ->
source(video=ffmpeg.copy, 'a)

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))
  • (unlabeled) (of type source(video=ffmpeg.copy, 'a))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.eac3_core

FFmpeg eac3_core bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.extract_extradata

FFmpeg extract_extradata bitstream filter. See ffmpeg documentation for more details.

Type:

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

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.filter_units

FFmpeg filter_units bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

  • id (of type string?, which defaults to null): Force the value of the source ID.
  • 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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.h264_metadata

FFmpeg h264_metadata bitstream filter. See ffmpeg documentation for more details.

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)) ->
source(video=ffmpeg.copy, 'a)

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))
  • 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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.h264_mp4toannexb

FFmpeg h264_mp4toannexb bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.h264_redundant_pps

FFmpeg h264_redundant_pps bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.hapqa_extract

FFmpeg hapqa_extract bitstream filter. See ffmpeg documentation for more details.

Type:

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

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.hevc_metadata

FFmpeg hevc_metadata bitstream filter. See ffmpeg documentation for more details.

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?, ?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?, source(video=ffmpeg.copy, 'a)) ->
source(video=ffmpeg.copy, 'a)

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)
  • 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)
  • (unlabeled) (of type source(video=ffmpeg.copy, 'a))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.hevc_mp4toannexb

FFmpeg hevc_mp4toannexb bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.imxdump

FFmpeg imxdump bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.mjpeg2jpeg

FFmpeg mjpeg2jpeg bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.mjpegadump

FFmpeg mjpegadump bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.mov2textsub.audio

FFmpeg mov2textsub.audio bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.mov2textsub.video

FFmpeg mov2textsub.video bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.mp3decomp

FFmpeg mp3decomp bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.mpeg2_metadata

FFmpeg mpeg2_metadata bitstream filter. See ffmpeg documentation for more details.

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)) -> source(video=ffmpeg.copy, 'a)

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.mpeg4_unpack_bframes

FFmpeg mpeg4_unpack_bframes bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.noise.audio

FFmpeg noise.audio bitstream filter. See ffmpeg documentation for more details.

Type:

(?id : string?, ?amount : string?, ?drop : string?, ?dropamount : int?,
 source(audio=ffmpeg.copy, 'a)) -> source(audio=ffmpeg.copy, 'a)

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.noise.video

FFmpeg noise.video bitstream filter. See ffmpeg documentation for more details.

Type:

(?id : string?, ?amount : string?, ?drop : string?, ?dropamount : int?,
 source(video=ffmpeg.copy, 'a)) -> source(video=ffmpeg.copy, 'a)

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.null.audio

FFmpeg null.audio bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.null.video

FFmpeg null.video bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.opus_metadata

FFmpeg opus_metadata bitstream filter. See ffmpeg documentation for more details.

Type:

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

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.pcm_rechunk

FFmpeg pcm_rechunk bitstream filter. See ffmpeg documentation for more details.

Type:

(?id : string?, ?frame_rate : string?, ?n : int?, ?nb_out_samples : int?,
 ?p : bool?, ?pad : bool?, ?r : string?, source(audio=ffmpeg.copy, 'a)) ->
source(audio=ffmpeg.copy, 'a)

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.prores_metadata

FFmpeg prores_metadata bitstream filter. See ffmpeg documentation for more details.

Type:

(?id : string?, ?color_primaries : int?, ?color_trc : int?,
 ?colorspace : int?, source(video=ffmpeg.copy, 'a)) ->
source(video=ffmpeg.copy, 'a)

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.remove_extra.audio

FFmpeg remove_extra.audio bitstream filter. See ffmpeg documentation for more details.

Type:

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

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.remove_extra.video

FFmpeg remove_extra.video bitstream filter. See ffmpeg documentation for more details.

Type:

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

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.setts.audio

FFmpeg setts.audio bitstream filter. See ffmpeg documentation for more details.

Type:

(?id : string?, ?dts : string?, ?duration : string?, ?pts : string?,
 ?time_base : string?, ?ts : string?, source(audio=ffmpeg.copy, 'a)) ->
source(audio=ffmpeg.copy, 'a)

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)
  • 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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.setts.video

FFmpeg setts.video bitstream filter. See ffmpeg documentation for more details.

Type:

(?id : string?, ?dts : string?, ?duration : string?, ?pts : string?,
 ?time_base : string?, ?ts : string?, source(video=ffmpeg.copy, 'a)) ->
source(video=ffmpeg.copy, 'a)

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)
  • 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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.text2movsub.audio

FFmpeg text2movsub.audio bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.text2movsub.video

FFmpeg text2movsub.video bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.trace_headers

FFmpeg trace_headers bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.truehd_core

FFmpeg truehd_core bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.vp9_metadata

FFmpeg vp9_metadata bitstream filter. See ffmpeg documentation for more details.

Type:

(?id : string?, ?color_range : int?, ?color_space : int?,
 source(video=ffmpeg.copy, 'a)) -> source(video=ffmpeg.copy, 'a)

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))

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.vp9_raw_reorder

FFmpeg vp9_raw_reorder bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.vp9_superframe

FFmpeg vp9_superframe bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.bitstream.vp9_superframe_split

FFmpeg vp9_superframe_split bitstream filter. See ffmpeg documentation for more details.

Type:

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

Arguments:

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

Methods:

  • buffered (of type () -> [string * float]): Length of buffered data.
  • 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.
  • id (of type () -> string): Identifier of the source.
  • 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?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • 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.
  • skip (of type () -> unit): Skip to the next track.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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?,
 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)
  • (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?,
 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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?, 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)
  • (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?, 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.blend_vulkan

Ffmpeg filter: Blend two video frames in Vulkan

Type:

(?c0_mode : int?, ?c1_mode : int?, ?c2_mode : int?, ?c3_mode : int?,
 ?all_mode : int?, ?c0_opacity : float?, ?c1_opacity : float?,
 ?c2_opacity : float?, ?c3_opacity : float?, ?all_opacity : float?,
 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: 0 (normal), 13 (multiply))
  • c1_mode (of type int?, which defaults to null): set component #1 blend mode. (default: 0, possible values: 0 (normal), 13 (multiply))
  • c2_mode (of type int?, which defaults to null): set component #2 blend mode. (default: 0, possible values: 0 (normal), 13 (multiply))
  • c3_mode (of type int?, which defaults to null): set component #3 blend mode. (default: 0, possible values: 0 (normal), 13 (multiply))
  • all_mode (of type int?, which defaults to null): set blend mode for all components. (default: -1, possible values: 0 (normal), 13 (multiply))
  • 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)
  • (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.blend_vulkan.create

Ffmpeg filter: Blend two video frames in Vulkan. 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_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: 0 (normal), 13 (multiply))
  • c1_mode (of type int?, which defaults to null): set component #1 blend mode. (default: 0, possible values: 0 (normal), 13 (multiply))
  • c2_mode (of type int?, which defaults to null): set component #2 blend mode. (default: 0, possible values: 0 (normal), 13 (multiply))
  • c3_mode (of type int?, which defaults to null): set component #3 blend mode. (default: 0, possible values: 0 (normal), 13 (multiply))
  • all_mode (of type int?, which defaults to null): set blend mode for all components. (default: -1, possible values: 0 (normal), 13 (multiply))
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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.117647058824)
  • low (of type float?, which defaults to null): set low threshold. (default: 0.0588235294118)
  • 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.117647058824)
  • low (of type float?, which defaults to null): set low threshold. (default: 0.0588235294118)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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 log2(size) of local patch. (default: 4)
  • 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 log2(size) of local patch. (default: 4)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.boxblur_opencl

Ffmpeg filter: Apply boxblur filter to input video

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_opencl.create

Ffmpeg filter: Apply boxblur filter to 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_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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.bs2b

Ffmpeg filter: Bauer stereo-to-binaural filter.

Type:

(?profile : int?, ?fcut : int?, ?feed : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

  • profile (of type int?, which defaults to null): Apply a pre-defined crossfeed level. (default: 2949820, possible values: 2949820 (default), 3932860 (cmoy), 6226570 (jmeier))
  • fcut (of type int?, which defaults to null): Set cut frequency (in Hz). (default: 0)
  • feed (of type int?, which defaults to null): Set feed level (in Hz). (default: 0)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

ffmpeg.filter.bs2b.create

Ffmpeg filter: Bauer stereo-to-binaural filter.. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

(?profile : int?, ?fcut : int?, ?feed : int?, ffmpeg.filter.graph) -> unit

Arguments:

  • profile (of type int?, which defaults to null): Apply a pre-defined crossfeed level. (default: 2949820, possible values: 2949820 (default), 3932860 (cmoy), 6226570 (jmeier))
  • fcut (of type int?, which defaults to null): Set cut frequency (in Hz). (default: 0)
  • feed (of type int?, which defaults to null): Set feed level (in Hz). (default: 0)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.audio): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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.61803398875)
  • ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.61803398875)
  • 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.61803398875)
  • ratio (of type float?, which defaults to null): set fill ratio for filling initial grid randomly. (default: 0.61803398875)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

ffmpeg.filter.chromaber_vulkan

Ffmpeg filter: Offset chroma of input video (chromatic aberration)

Type:

(?dist_x : float?, ?dist_y : float?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

  • dist_x (of type float?, which defaults to null): Set horizontal distortion amount. (default: 0.)
  • dist_y (of type float?, which defaults to null): Set vertical distortion amount. (default: 0.)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.chromaber_vulkan.create

Ffmpeg filter: Offset chroma of input video (chromatic aberration). Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

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

Arguments:

  • dist_x (of type float?, which defaults to null): Set horizontal distortion amount. (default: 0.)
  • dist_y (of type float?, which defaults to null): Set vertical distortion amount. (default: 0.)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.chromakey_cuda

Ffmpeg filter: GPU accelerated chromakey filter

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_cuda.create

Ffmpeg filter: GPU accelerated chromakey filter. 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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 size. (default: 5)
  • sizeh (of type int?, which defaults to null): set vertical 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 size. (default: 5)
  • sizeh (of type int?, which defaults to null): set vertical 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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))
  • 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))
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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))
  • 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))
  • mvt (of type int?, which defaults to null): set motion vectors type. (default: 0, possible values: 1 (fp), 2 (bp))
  • 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))
  • 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))
  • 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))
  • 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))
  • mvt (of type int?, which defaults to null): set motion vectors type. (default: 0, possible values: 1 (fp), 2 (bp))
  • 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))
  • 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))
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.colorkey_opencl

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_opencl.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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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?,
 ?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))
  • 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))
  • 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))
  • 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))
  • 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))
  • (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?,
 ?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))
  • 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))
  • 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))
  • 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))
  • 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))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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: -1)
  • d (of type int?, which defaults to null): set video duration. (default: -1)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type () -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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]): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.convolution_opencl

Ffmpeg filter: Apply convolution mask to input video

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?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

  • 0m (of type string?, which defaults to null): set matrix for 2nd 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 1nd plane. (default: 1.)
  • 1rdiv (of type float?, which defaults to null): set rdiv for 2nd plane. (default: 1.)
  • 2rdiv (of type float?, which defaults to null): set rdiv for 3rd plane. (default: 1.)
  • 3rdiv (of type float?, which defaults to null): set rdiv for 4th plane. (default: 1.)
  • 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.)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.convolution_opencl.create

Ffmpeg filter: Apply convolution mask to input video. 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?, ffmpeg.filter.graph) ->
unit

Arguments:

  • 0m (of type string?, which defaults to null): set matrix for 2nd 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 1nd plane. (default: 1.)
  • 1rdiv (of type float?, which defaults to null): set rdiv for 2nd plane. (default: 1.)
  • 2rdiv (of type float?, which defaults to null): set rdiv for 3rd plane. (default: 1.)
  • 3rdiv (of type float?, which defaults to null): set rdiv for 4th plane. (default: 1.)
  • 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.)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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?, 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)
  • (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?, 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.cropdetect

Ffmpeg filter: Auto-detect crop size.

Type:

(?limit : float?, ?round : int?, ?reset : int?, ?skip : int?,
 ?reset_count : int?, ?max_outliers : 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.0941176470588)
  • 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)
  • (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?, ffmpeg.filter.graph) -> unit

Arguments:

  • limit (of type float?, which defaults to null): Threshold below which the pixel is considered black. (default: 0.0941176470588)
  • 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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?, 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
  • (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?, 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
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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.28318530718)
  • d (of type float?, which defaults to null): set direction. (default: 6.28318530718)
  • 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.28318530718)
  • d (of type float?, which defaults to null): set direction. (default: 6.28318530718)
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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?, 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)
  • (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?, 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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?, 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)
  • (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?, 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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))
  • 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))
  • 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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.deinterlace_qsv

Ffmpeg filter: QuickSync video deinterlacing

Type:

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

Arguments:

  • mode (of type int?, which defaults to null): set deinterlace mode. (default: 2, possible values: 1 (bob), 2 (advanced))
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.deinterlace_qsv.create

Ffmpeg filter: QuickSync video 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?, ffmpeg.filter.graph) -> unit

Arguments:

  • mode (of type int?, which defaults to null): set deinterlace mode. (default: 2, possible values: 1 (bob), 2 (advanced))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.deinterlace_vaapi

Ffmpeg filter: Deinterlacing of VAAPI surfaces

Type:

(?mode : int?, ?rate : int?, ?auto : int?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

  • mode (of type int?, which defaults to null): Deinterlacing mode. (default: 0, possible values: 0 (default), 1 (bob), 2 (weave), 3 (motion_adaptive), 4 (motion_compensated))
  • rate (of type int?, which defaults to null): Generate output at frame rate or field rate. (default: 1, possible values: 1 (frame), 2 (field))
  • auto (of type int?, which defaults to null): Only deinterlace fields, passing frames through unchanged. (default: 0)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.deinterlace_vaapi.create

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

Type:

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

Arguments:

  • mode (of type int?, which defaults to null): Deinterlacing mode. (default: 0, possible values: 0 (default), 1 (bob), 2 (weave), 3 (motion_adaptive), 4 (motion_compensated))
  • rate (of type int?, which defaults to null): Generate output at frame rate or field rate. (default: 1, possible values: 1 (frame), 2 (field))
  • auto (of type int?, which defaults to null): Only deinterlace fields, passing frames through unchanged. (default: 0)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.denoise_vaapi

Ffmpeg filter: VAAPI VPP for de-noise

Type:

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

Arguments:

  • denoise (of type int?, which defaults to null): denoise level. (default: 0)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.denoise_vaapi.create

Ffmpeg filter: VAAPI VPP for de-noise. Use this operator to initiate the filter independently of its inputs, to be able to send commands to the filter instance.

Type:

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

Arguments:

  • denoise (of type int?, which defaults to null): denoise level. (default: 0)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

ffmpeg.filter.derain

Ffmpeg filter: Apply derain filter to the input.

Type:

(?filter_type : int?, ?dnn_backend : int?, ?model : string?,
 ?input : string?, ?output : string?, ffmpeg.filter.graph,
 ffmpeg.filter.video) -> ffmpeg.filter.video

Arguments:

  • filter_type (of type int?, which defaults to null): filter type(derain/dehaze). (default: 0, possible values: 0 (derain), 1 (dehaze))
  • dnn_backend (of type int?, which defaults to null): DNN backend. (default: 0, possible values: 0 (native))
  • model (of type string?, which defaults to null): path to model file
  • input (of type string?, which defaults to null): input name of the model. (default: x)
  • output (of type string?, which defaults to null): output name of the model. (default: y)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.video)

ffmpeg.filter.derain.create

Ffmpeg filter: Apply derain filter 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:

(?filter_type : int?, ?dnn_backend : int?, ?model : string?,
 ?input : string?, ?output : string?, ffmpeg.filter.graph) -> unit

Arguments:

  • filter_type (of type int?, which defaults to null): filter type(derain/dehaze). (default: 0, possible values: 0 (derain), 1 (dehaze))
  • dnn_backend (of type int?, which defaults to null): DNN backend. (default: 0, possible values: 0 (native))
  • model (of type string?, which defaults to null): path to model file
  • input (of type string?, which defaults to null): input name of the model. (default: x)
  • output (of type string?, which defaults to null): output name of the model. (default: y)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • output (of type ffmpeg.filter.video): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it is fast.
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): Filter output(s)
  • process_command (of type (?fast : bool, string, string) -> string): process_command(?fast, "command", "argument") sends the given command to this filter. Set fast to true to only execute the command when it