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.

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

Type:

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

Arguments:

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

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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

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

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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

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

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Harbor middleware to add CORS headers

Type:

(?origin : string?,
 ?origin_callback : ((
                      {
                        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) ->
(
 {
   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 : ('d) -> unit,
   multipart_form : (?boundary : string?,
                     [
                      {
                        attributes : [string * string],
                        contents : {string},
                        headers : ['b * 'c],
                        name : string
                      }]) -> unit,
   redirect : (?status_code : int, string) -> unit,
   send_status : ('a.{write : (string) -> unit}) -> unit,
   status_code : ((int) -> unit)
   .{current : () -> int
   },
   status_message : ((string?) -> unit)
   .{current : () -> string?
   },
   status_sent : () -> bool
 },
 ((
   {
     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 : ('d) -> unit,
     multipart_form : (?boundary : string?,
                       [
                        {
                          attributes : [string * string],
                          contents : {string},
                          headers : ['b * 'c],
                          name : string
                        }]) -> unit,
     redirect : (?status_code : int, string) -> unit,
     send_status : ('a.{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 (( { 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.

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.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

This function is experimental.

Add some bass to the sound.

Type:

(?frequency : {float}, ?gain : {float}, source(audio=pcm('a),
 ?video=canvas('b), 'c)) -> source(audio=pcm('a), ?video=canvas('b))
where 'c is any media type (pcm, etc...)

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), ?video=canvas('b), 'c) where 'c is any media type (pcm, etc...)): Source whose bass should be boosted

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.
  • selected (of type () -> source(audio=pcm('B), ?video=canvas('A))?): Currently selected source.

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), ?video=canvas('b)),
 [
  {
    attack : {float},
    frequency : {float},
    gain : {float},
    ratio : {float},
    release : {float},
    threshold : {float}
  }]) -> source(audio=pcm('a).{gain? : never, rms? : never},
?video=canvas('b))

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), ?video=canvas('b))): 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:

  • rms (of type () -> float):
  • gain (of type () -> float):
  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Aliasing by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?aliasing_level : {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.
  • aliasing_level (of type {float}, which defaults to 0.): Aliasing level (0 <= aliasing_level <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Allpass delay line, cubic spline interpolation by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {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.
  • decay_time (of type {float}): Decay Time (s) (0 <= decay_time).
  • delay_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Allpass delay line, linear interpolation by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {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.
  • decay_time (of type {float}): Decay Time (s) (0 <= decay_time).
  • delay_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Allpass delay line, noninterpolating by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {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.
  • decay_time (of type {float}): Decay Time (s) (0 <= decay_time).
  • delay_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Simple amplifier by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?amps_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.
  • amps_gain (of type {float}, which defaults to 0.): Amps gain (dB) (-70 <= amps_gain <= 70).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

AM pitchshifter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?buffer_size : {int}, ?pitch_shift : {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.
  • buffer_size (of type {int}, which defaults to 4): Buffer size (1 <= buffer_size <= 7).
  • pitch_shift (of type {float}, which defaults to 1.): Pitch shift (0.25 <= pitch_shift <= 4).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Artificial latency by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?delay : {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 2500.): Delay (ms) (0 <= delay <= 10000).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Auto phaser by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?attack_time : {float}, ?decay_time : {float},
 ?feedback : {float}, ?modulation_depth : {float}, ?spread : {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.
  • attack_time (of type {float}, which defaults to 0.25): Attack time (s) (0 <= attack_time <= 1).
  • decay_time (of type {float}, which defaults to 0.25): Decay time (s) (0 <= decay_time <= 1).
  • feedback (of type {float}, which defaults to 0.): Feedback (-1 <= feedback <= 1).
  • modulation_depth (of type {float}, which defaults to 0.25): Modulation depth (0 <= modulation_depth <= 1).
  • spread (of type {float}, which defaults to 1.): Spread (octaves) (0 <= spread <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Glame Bandpass Analog Filter by Alexander Ehlert <mag(at)glame.de>.

Type:

(?id : string?, ?bandwidth : {float}, ?center_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.
  • bandwidth (of type {float}, which defaults to 295.831787109): Bandwidth (Hz) (4.41 <= bandwidth <= 19845).
  • center_frequency (of type {float}, which defaults to 36.1194992065): Center Frequency (Hz) (4.41 <= center_frequency <= 19845).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Glame Bandpass Filter by Alexander Ehlert <mag(at)glame.de>.

Type:

(?id : string?, ?bandwidth : {float}, ?center_frequency : {float},
 ?stages : {int}, 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.
  • bandwidth (of type {float}, which defaults to 295.831787109): Bandwidth (Hz) (4.41 <= bandwidth <= 19845).
  • center_frequency (of type {float}, which defaults to 295.831787109): Center Frequency (Hz) (4.41 <= center_frequency <= 19845).
  • stages (of type {int}, which defaults to 1): Stages(2 poles per stage) (1 <= stages <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Bode frequency shifter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?frequency_shift : {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.
  • frequency_shift (of type {float}, which defaults to 0.): Frequency shift (0 <= frequency_shift <= 5000).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

GLAME Butterworth Highpass by Alexander Ehlert <mag(at)glame.de>.

Type:

(?id : string?, ?cutoff_frequency : {float}, ?resonance : {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 36.1194992065): Cutoff Frequency (Hz) (4.41 <= cutoff_frequency <= 19845).
  • resonance (of type {float}, which defaults to 0.754999995232): Resonance (0.1 <= resonance <= 1.41).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

GLAME Butterworth Lowpass by Alexander Ehlert <mag(at)glame.de>.

Type:

(?id : string?, ?cutoff_frequency : {float}, ?resonance : {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 36.1194992065): Cutoff Frequency (Hz) (4.41 <= cutoff_frequency <= 19845).
  • resonance (of type {float}, which defaults to 0.754999995232): Resonance (0.1 <= resonance <= 1.41).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Glame Butterworth X-over Filter by Alexander Ehlert <mag(at)glame.de>.

Type:

(?id : string?, ?cutoff_frequency : {float}, ?resonance : {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.
  • cutoff_frequency (of type {float}, which defaults to 36.1194992065): Cutoff Frequency (Hz) (4.41 <= cutoff_frequency <= 19845).
  • resonance (of type {float}, which defaults to 0.754999995232): Resonance (0.1 <= resonance <= 1.41).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Chebyshev distortion by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?distortion : {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.
  • distortion (of type {float}, which defaults to 0.): Distortion (0 <= distortion <= 3).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Comb Filter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?band_separation : {float}, ?feedback : {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.
  • band_separation (of type {float}, which defaults to 172.): Band separation (Hz) (16 <= band_separation <= 640).
  • feedback (of type {float}, which defaults to 0.): Feedback (-0.99 <= feedback <= 0.99).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Comb delay line, cubic spline interpolation by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {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.
  • decay_time (of type {float}): Decay Time (s) (0 <= decay_time).
  • delay_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Comb delay line, linear interpolation by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {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.
  • decay_time (of type {float}): Decay Time (s) (0 <= decay_time).
  • delay_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Comb delay line, noninterpolating by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {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.
  • decay_time (of type {float}): Decay Time (s) (0 <= decay_time).
  • delay_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Comb Splitter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?band_separation : {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.
  • band_separation (of type {float}, which defaults to 172.): Band separation (Hz) (16 <= band_separation <= 640).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Constant Signal Generator by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?signal_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.
  • signal_amplitude (of type {float}, which defaults to 0.): Signal amplitude (-1 <= signal_amplitude <= 1.1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Crossover distortion by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?crossover_amplitude : {float}, ?smoothing : {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.
  • crossover_amplitude (of type {float}, which defaults to 0.): Crossover amplitude (0 <= crossover_amplitude <= 0.1).
  • smoothing (of type {float}, which defaults to 1.): Smoothing (0 <= smoothing <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

DC Offset Remover by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, 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.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Exponential signal decay by Andy Wingo .

Type:

(?id : string?, decay_time : {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.
  • decay_time (of type {float}): Decay Time (s) (0 <= decay_time).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Decimator by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?bit_depth : {float}, ?sample_rate : {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.
  • bit_depth (of type {float}, which defaults to 24.): Bit depth (1 <= bit_depth <= 24).
  • sample_rate (of type {float}, which defaults to 44100.): Sample rate (Hz) (44.1 <= sample_rate <= 44100).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Declipper by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, 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.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Simple delay line, cubic spline interpolation by Andy Wingo .

Type:

(?id : string?, delay_time : {float}, max_delay : {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_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Simple delay line, linear interpolation by Andy Wingo .

Type:

(?id : string?, delay_time : {float}, max_delay : {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_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Simple delay line, noninterpolating by Andy Wingo .

Type:

(?id : string?, delay_time : {float}, max_delay : {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_time (of type {float}): Delay Time (s) (0 <= delay_time).
  • max_delay (of type {float}): Max Delay (s) (0 <= max_delay).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Delayorama by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?amplitude_change : {float}, ?amplitude_random : {float},
 ?delay_change : {float}, ?delay_random : {float}, ?delay_range : {float},
 ?dry_wet_mix : {float}, ?feedback : {float}, ?first_delay : {float},
 ?input_gain : {float}, ?number_of_taps : {int}, ?random_seed : {int},
 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_change (of type {float}, which defaults to 1.): Amplitude change (0.2 <= amplitude_change <= 5).
  • amplitude_random (of type {float}, which defaults to 0.): Amplitude random (%) (0 <= amplitude_random <= 100).
  • delay_change (of type {float}, which defaults to 1.): Delay change (0.2 <= delay_change <= 5).
  • delay_random (of type {float}, which defaults to 0.): Delay random (%) (0 <= delay_random <= 100).
  • delay_range (of type {float}, which defaults to 6.): Delay range (s) (0.0001 <= delay_range <= 6).
  • dry_wet_mix (of type {float}, which defaults to 1.): Dry/wet mix (0 <= dry_wet_mix <= 1).
  • feedback (of type {float}, which defaults to 0.): Feedback (%) (0 <= feedback <= 100).
  • first_delay (of type {float}, which defaults to 0.): First delay (s) (0 <= first_delay <= 5).
  • input_gain (of type {float}, which defaults to 0.): Input gain (dB) (-96 <= input_gain <= 24).
  • number_of_taps (of type {int}, which defaults to 2): Number of taps (2 <= number_of_taps <= 128).
  • random_seed (of type {int}, which defaults to 0): Random seed (0 <= random_seed <= 1000).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Diode Processor by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?mode : {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.
  • mode (of type {float}, which defaults to 0.): Mode (0 for none, 1 for half wave, 2 for full wave) (0 <= mode <= 3).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Audio Divider (Suboctave Generator) by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?denominator : {int}, 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.
  • denominator (of type {int}, which defaults to 1): Denominator (1 <= denominator <= 8).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

DJ EQ by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?hi_gain : {float}, ?lo_gain : {float}, ?mid_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.
  • hi_gain (of type {float}, which defaults to 0.): Hi gain (dB) (-70 <= hi_gain <= 6).
  • lo_gain (of type {float}, which defaults to 0.): Lo gain (dB) (-70 <= lo_gain <= 6).
  • mid_gain (of type {float}, which defaults to 0.): Mid gain (dB) (-70 <= mid_gain <= 6).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

DJ EQ (mono) by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?hi_gain : {float}, ?lo_gain : {float}, ?mid_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.
  • hi_gain (of type {float}, which defaults to 0.): Hi gain (dB) (-70 <= hi_gain <= 6).
  • lo_gain (of type {float}, which defaults to 0.): Lo gain (dB) (-70 <= lo_gain <= 6).
  • mid_gain (of type {float}, which defaults to 0.): Mid gain (dB) (-70 <= mid_gain <= 6).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

DJ flanger by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?feedback : {float}, ?lfo_depth : {float},
 ?lfo_period : {float}, lfo_sync : {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.
  • feedback (of type {float}, which defaults to 0.): Feedback (%) (-100 <= feedback <= 100).
  • lfo_depth (of type {float}, which defaults to 4.): LFO depth (ms) (1 <= lfo_depth <= 5).
  • lfo_period (of type {float}, which defaults to 1.): LFO period (s) (0.1 <= lfo_period <= 32).
  • lfo_sync (of type {float}): LFO sync.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Dyson compressor by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?compression_ratio : {float},
 ?fast_compression_ratio : {float}, ?peak_limit : {float},
 ?release_time : {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.
  • compression_ratio (of type {float}, which defaults to 0.5): Compression ratio (0 <= compression_ratio <= 1).
  • fast_compression_ratio (of type {float}, which defaults to 0.5): Fast compression ratio (0 <= fast_compression_ratio <= 1).
  • peak_limit (of type {float}, which defaults to 0.): Peak limit (dB) (-30 <= peak_limit <= 0).
  • release_time (of type {float}, which defaults to 0.25): Release time (s) (0 <= release_time <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Fractionally Addressed Delay Line by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?delay : {float}, ?feedback : {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.1 <= delay <= 10).
  • feedback (of type {float}, which defaults to 0.): Feedback (dB) (-70 <= feedback <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Fast Lookahead limiter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?input_gain : {float}, ?limit : {float},
 ?release_time : {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.
  • input_gain (of type {float}, which defaults to 0.): Input gain (dB) (-20 <= input_gain <= 20).
  • limit (of type {float}, which defaults to 0.): Limit (dB) (-20 <= limit <= 0).
  • release_time (of type {float}, which defaults to 0.507499992847): Release time (s) (0.01 <= release_time <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Flanger by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?delay_base : {float}, ?feedback : {float},
 ?lfo_frequency : {float}, ?max_slowdown : {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_base (of type {float}, which defaults to 6.32499980927): Delay base (ms) (0.1 <= delay_base <= 25).
  • feedback (of type {float}, which defaults to 0.): Feedback (-1 <= feedback <= 1).
  • lfo_frequency (of type {float}, which defaults to 0.334370166063): LFO frequency (Hz) (0.05 <= lfo_frequency <= 100).
  • max_slowdown (of type {float}, which defaults to 2.5): Max slowdown (ms) (0 <= max_slowdown <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

FM Oscillator by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?waveform : {int}, 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.
  • waveform (of type {int}, which defaults to 1): Waveform (1=sin, 2=tri, 3=squ, 4=saw) (1 <= waveform <= 4).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Foldover distortion by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?drive : {float}, ?skew : {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.
  • drive (of type {float}, which defaults to 0.): Drive (0 <= drive <= 1).
  • skew (of type {float}, which defaults to 0.): Skew (0 <= skew <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

4 x 4 pole allpass by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?feedback_1 : {float}, ?feedback_2 : {float},
 ?feedback_3 : {float}, ?feedback_4 : {float}, ?frequency_1 : {float},
 ?frequency_2 : {float}, ?frequency_3 : {float}, ?frequency_4 : {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.
  • feedback_1 (of type {float}, which defaults to 0.): Feedback 1 (-1 <= feedback_1 <= 1).
  • feedback_2 (of type {float}, which defaults to 0.): Feedback 2 (-1 <= feedback_2 <= 1).
  • feedback_3 (of type {float}, which defaults to 0.): Feedback 3 (-1 <= feedback_3 <= 1).
  • feedback_4 (of type {float}, which defaults to 0.): Feedback 4 (-1 <= feedback_4 <= 1).
  • frequency_1 (of type {float}, which defaults to 5000.75): Frequency 1 (1 <= frequency_1 <= 20000).
  • frequency_2 (of type {float}, which defaults to 10000.5): Frequency 2 (1 <= frequency_2 <= 20000).
  • frequency_3 (of type {float}, which defaults to 15000.25): Frequency 3 (1 <= frequency_3 <= 20000).
  • frequency_4 (of type {float}, which defaults to 20000.): Frequency 4 (1 <= frequency_4 <= 20000).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Fast overdrive by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?drive_level : {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.
  • drive_level (of type {float}, which defaults to 1.): Drive level (1 <= drive_level <= 3).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Frequency tracker by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?tracking_speed : {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.
  • tracking_speed (of type {float}, which defaults to 0.5): Tracking speed (0 <= tracking_speed <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Gate by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?attack : {float}, ?decay : {float},
 ?hf_key_filter : {float}, ?hold : {float}, ?lf_key_filter : {float},
 ?output_select : {int}, ?range : {float}, ?threshold : {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.
  • attack (of type {float}, which defaults to 250.007507324): Attack (ms) (0.01 <= attack <= 1000).
  • decay (of type {float}, which defaults to 2001.): Decay (ms) (2 <= decay <= 4000).
  • hf_key_filter (of type {float}, which defaults to 21609.): HF key filter (Hz) (220.5 <= hf_key_filter <= 21609).
  • hold (of type {float}, which defaults to 1500.5): Hold (ms) (2 <= hold <= 2000).
  • lf_key_filter (of type {float}, which defaults to 30.8699989319): LF key filter (Hz) (30.87 <= lf_key_filter <= 4410).
  • output_select (of type {int}, which defaults to 0): Output select (-1 = key listen, 0 = gate, 1 = bypass) (-1 <= output_select <= 1).
  • range (of type {float}, which defaults to -90.): Range (dB) (-90 <= range <= 0).
  • threshold (of type {float}, which defaults to -70.): Threshold (dB) (-70 <= threshold <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Giant flange by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?delay_1_range : {float}, ?delay_2_range : {float},
 double_delay : {float}, ?dry_wet_level : {float}, ?feedback : {float},
 ?lfo_frequency_1 : {float}, ?lfo_frequency_2 : {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_1_range (of type {float}, which defaults to 2.625): Delay 1 range (s) (0 <= delay_1_range <= 10.5).
  • delay_2_range (of type {float}, which defaults to 0.): Delay 2 range (s) (0 <= delay_2_range <= 10.5).
  • double_delay (of type {float}): Double delay.
  • dry_wet_level (of type {float}, which defaults to 0.): Dry/Wet level (0 <= dry_wet_level <= 1).
  • feedback (of type {float}, which defaults to 0.): Feedback (-100 <= feedback <= 100).
  • lfo_frequency_1 (of type {float}, which defaults to 1.): LFO frequency 1 (Hz) (0 <= lfo_frequency_1 <= 30).
  • lfo_frequency_2 (of type {float}, which defaults to 1.): LFO frequency 2 (Hz) (0 <= lfo_frequency_2 <= 30).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Gong model by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?inner_damping : {float}, ?inner_size_1 : {float},
 ?inner_size_2 : {float}, ?inner_size_3 : {float}, ?inner_size_4 : {float},
 ?inner_stiffness_1 : {float}, ?inner_stiffness_1__ : {float},
 ?inner_stiffness_2 : {float}, ?inner_stiffness_2__ : {float},
 ?inner_stiffness_3 : {float}, ?inner_stiffness_3__ : {float},
 ?inner_stiffness_4 : {float}, ?inner_stiffness_4__ : {float},
 ?mic_position : {float}, ?outer_damping : {float}, ?outer_size_1 : {float},
 ?outer_size_2 : {float}, ?outer_size_3 : {float}, ?outer_size_4 : {float},
 ?outer_stiffness_1 : {float}, ?outer_stiffness_1__ : {float},
 ?outer_stiffness_2 : {float}, ?outer_stiffness_2__ : {float},
 ?outer_stiffness_3 : {float}, ?outer_stiffness_3__ : {float},
 ?outer_stiffness_4 : {float}, ?outer_stiffness_4__ : {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.
  • inner_damping (of type {float}, which defaults to 0.5): Inner damping (0 <= inner_damping <= 1).
  • inner_size_1 (of type {float}, which defaults to 0.5): Inner size 1 (0 <= inner_size_1 <= 1).
  • inner_size_2 (of type {float}, which defaults to 0.5): Inner size 2 (0 <= inner_size_2 <= 1).
  • inner_size_3 (of type {float}, which defaults to 0.5): Inner size 3 (0 <= inner_size_3 <= 1).
  • inner_size_4 (of type {float}, which defaults to 0.5): Inner size 4 (0 <= inner_size_4 <= 1).
  • inner_stiffness_1 (of type {float}, which defaults to 0.5): Inner stiffness 1 + (0 <= inner_stiffness_1 <= 1).
  • inner_stiffness_1__ (of type {float}, which defaults to 0.5): Inner stiffness 1 - (0 <= inner_stiffness_1__ <= 1).
  • inner_stiffness_2 (of type {float}, which defaults to 0.5): Inner stiffness 2 + (0 <= inner_stiffness_2 <= 1).
  • inner_stiffness_2__ (of type {float}, which defaults to 0.5): Inner stiffness 2 - (0 <= inner_stiffness_2__ <= 1).
  • inner_stiffness_3 (of type {float}, which defaults to 0.5): Inner stiffness 3 + (0 <= inner_stiffness_3 <= 1).
  • inner_stiffness_3__ (of type {float}, which defaults to 0.5): Inner stiffness 3 - (0 <= inner_stiffness_3__ <= 1).
  • inner_stiffness_4 (of type {float}, which defaults to 0.5): Inner stiffness 4 + (0 <= inner_stiffness_4 <= 1).
  • inner_stiffness_4__ (of type {float}, which defaults to 0.5): Inner stiffness 4 - (0 <= inner_stiffness_4__ <= 1).
  • mic_position (of type {float}, which defaults to 0.25): Mic position (0 <= mic_position <= 1).
  • outer_damping (of type {float}, which defaults to 0.5): Outer damping (0 <= outer_damping <= 1).
  • outer_size_1 (of type {float}, which defaults to 0.5): Outer size 1 (0 <= outer_size_1 <= 1).
  • outer_size_2 (of type {float}, which defaults to 0.5): Outer size 2 (0 <= outer_size_2 <= 1).
  • outer_size_3 (of type {float}, which defaults to 0.5): Outer size 3 (0 <= outer_size_3 <= 1).
  • outer_size_4 (of type {float}, which defaults to 0.5): Outer size 4 (0 <= outer_size_4 <= 1).
  • outer_stiffness_1 (of type {float}, which defaults to 0.5): Outer stiffness 1 + (0 <= outer_stiffness_1 <= 1).
  • outer_stiffness_1__ (of type {float}, which defaults to 0.5): Outer stiffness 1 - (0 <= outer_stiffness_1__ <= 1).
  • outer_stiffness_2 (of type {float}, which defaults to 0.5): Outer stiffness 2 + (0 <= outer_stiffness_2 <= 1).
  • outer_stiffness_2__ (of type {float}, which defaults to 0.5): Outer stiffness 2 - (0 <= outer_stiffness_2__ <= 1).
  • outer_stiffness_3 (of type {float}, which defaults to 0.5): Outer stiffness 3 + (0 <= outer_stiffness_3 <= 1).
  • outer_stiffness_3__ (of type {float}, which defaults to 0.5): Outer stiffness 3 - (0 <= outer_stiffness_3__ <= 1).
  • outer_stiffness_4 (of type {float}, which defaults to 0.5): Outer stiffness 4 + (0 <= outer_stiffness_4 <= 1).
  • outer_stiffness_4__ (of type {float}, which defaults to 0.5): Outer stiffness 4 - (0 <= outer_stiffness_4__ <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Gong beater by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?impulse_gain : {float}, ?strike_duration : {float},
 ?strike_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.
  • impulse_gain (of type {float}, which defaults to -70.): Impulse gain (dB) (-70 <= impulse_gain <= 0).
  • strike_duration (of type {float}, which defaults to 0.100500002503): Strike duration (s) (0.001 <= strike_duration <= 0.2).
  • strike_gain (of type {float}, which defaults to 0.): Strike gain (dB) (-70 <= strike_gain <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

GSM simulator by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?dry_wet_mix : {float}, ?error_rate : {float},
 ?number_of_passes : {int}, 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.
  • dry_wet_mix (of type {float}, which defaults to 1.): Dry/wet mix (0 <= dry_wet_mix <= 1).
  • error_rate (of type {float}, which defaults to 0.): Error rate (bits/block) (0 <= error_rate <= 30).
  • number_of_passes (of type {int}, which defaults to 1): Number of passes (0 <= number_of_passes <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

GVerb by Juhana Sadeharju <kouhia at nic.funet.fi>, LADSPAification by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?damping : {float}, ?dry_signal_level : {float},
 ?early_reflection_level : {float}, ?input_bandwidth : {float},
 ?reverb_time : {float}, ?roomsize : {float}, ?tail_level : {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.
  • damping (of type {float}, which defaults to 0.5): Damping (0 <= damping <= 1).
  • dry_signal_level (of type {float}, which defaults to -70.): Dry signal level (dB) (-70 <= dry_signal_level <= 0).
  • early_reflection_level (of type {float}, which defaults to 0.): Early reflection level (dB) (-70 <= early_reflection_level <= 0).
  • input_bandwidth (of type {float}, which defaults to 0.75): Input bandwidth (0 <= input_bandwidth <= 1).
  • reverb_time (of type {float}, which defaults to 7.57499980927): Reverb time (s) (0.1 <= reverb_time <= 30).
  • roomsize (of type {float}, which defaults to 75.75): Roomsize (m) (1 <= roomsize <= 300).
  • tail_level (of type {float}, which defaults to -17.5): Tail level (dB) (-70 <= tail_level <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Hard Limiter by Marcus Andersson.

Type:

(?id : string?, ?db_limit : {float}, ?residue_level : {float},
 ?wet_level : {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.
  • db_limit (of type {float}, which defaults to 0.): dB limit (-50 <= db_limit <= 0).
  • residue_level (of type {float}, which defaults to 0.): Residue level (0 <= residue_level <= 1).
  • wet_level (of type {float}, which defaults to 1.): Wet level (0 <= wet_level <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Harmonic generator by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?_10th_harmonic_magnitude : {float},
 ?_2nd_harmonic_magnitude : {float}, ?_3rd_harmonic_magnitude : {float},
 ?_4th_harmonic_magnitude : {float}, ?_5th_harmonic_magnitude : {float},
 ?_6th_harmonic_magnitude : {float}, ?_7th_harmonic_magnitude : {float},
 ?_8th_harmonic_magnitude : {float}, ?_9th_harmonic_magnitude : {float},
 ?fundamental_magnitude : {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.
  • _10th_harmonic_magnitude (of type {float}, which defaults to 0.): 10th harmonic magnitude (-1 <= _10th_harmonic_magnitude <= 1).
  • _2nd_harmonic_magnitude (of type {float}, which defaults to 0.): 2nd harmonic magnitude (-1 <= _2nd_harmonic_magnitude <= 1).
  • _3rd_harmonic_magnitude (of type {float}, which defaults to 0.): 3rd harmonic magnitude (-1 <= _3rd_harmonic_magnitude <= 1).
  • _4th_harmonic_magnitude (of type {float}, which defaults to 0.): 4th harmonic magnitude (-1 <= _4th_harmonic_magnitude <= 1).
  • _5th_harmonic_magnitude (of type {float}, which defaults to 0.): 5th harmonic magnitude (-1 <= _5th_harmonic_magnitude <= 1).
  • _6th_harmonic_magnitude (of type {float}, which defaults to 0.): 6th harmonic magnitude (-1 <= _6th_harmonic_magnitude <= 1).
  • _7th_harmonic_magnitude (of type {float}, which defaults to 0.): 7th harmonic magnitude (-1 <= _7th_harmonic_magnitude <= 1).
  • _8th_harmonic_magnitude (of type {float}, which defaults to 0.): 8th harmonic magnitude (-1 <= _8th_harmonic_magnitude <= 1).
  • _9th_harmonic_magnitude (of type {float}, which defaults to 0.): 9th harmonic magnitude (-1 <= _9th_harmonic_magnitude <= 1).
  • fundamental_magnitude (of type {float}, which defaults to 1.): Fundamental magnitude (-1 <= fundamental_magnitude <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Hermes Filter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?band_1_gain : {float}, ?band_2_gain : {float},
 ?band_3_gain : {float}, ?delay1_feedback : {float},
 ?delay1_length : {float}, ?delay1_wetness : {float},
 ?delay2_feedback : {float}, ?delay2_length : {float},
 ?delay2_wetness : {float}, ?delay3_feedback : {float},
 ?delay3_length : {float}, ?delay3_wetness : {float}, ?dist1_drive : {float},
 ?dist2_drive : {float}, ?dist3_drive : {float}, ?filt1_freq : {float},
 ?filt1_lfo1_level : {float}, ?filt1_lfo2_level : {float},
 ?filt1_q : {float}, ?filt1_resonance : {float}, ?filt1_type : {int},
 ?filt2_freq : {float}, ?filt2_lfo1_level : {float},
 ?filt2_lfo2_level : {float}, ?filt2_q : {float}, ?filt2_resonance : {float},
 ?filt2_type : {int}, ?filt3_freq : {float}, ?filt3_lfo1_level : {float},
 ?filt3_lfo2_level : {float}, ?filt3_q : {float}, ?filt3_resonance : {float},
 ?filt3_type : {int}, ?input_gain : {float}, ?lfo1_freq : {float},
 ?lfo1_wave : {int}, ?lfo2_freq : {float}, ?lfo2_wave : {int},
 ?osc1_freq : {float}, ?osc1_gain : {float}, ?osc1_wave : {int},
 ?osc2_freq : {float}, ?osc2_gain : {float}, ?osc2_wave : {int},
 ?ringmod_1_depth : {float}, ?ringmod_2_depth : {float},
 ?ringmod_3_depth : {float}, ?rm1_gain : {float}, ?rm2_gain : {float},
 ?rm3_gain : {float}, ?xover_lower_freq : {float},
 ?xover_upper_freq : {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.
  • band_1_gain (of type {float}, which defaults to 0.): Band 1 gain (dB) (-70 <= band_1_gain <= 20).
  • band_2_gain (of type {float}, which defaults to 0.): Band 2 gain (dB) (-70 <= band_2_gain <= 20).
  • band_3_gain (of type {float}, which defaults to 0.): Band 3 gain (dB) (-70 <= band_3_gain <= 20).
  • delay1_feedback (of type {float}, which defaults to 0.): Delay1 feedback (0 <= delay1_feedback <= 1).
  • delay1_length (of type {float}, which defaults to 0.): Delay1 length (s) (0 <= delay1_length <= 2).
  • delay1_wetness (of type {float}, which defaults to 0.): Delay1 wetness (0 <= delay1_wetness <= 1).
  • delay2_feedback (of type {float}, which defaults to 0.): Delay2 feedback (0 <= delay2_feedback <= 1).
  • delay2_length (of type {float}, which defaults to 0.): Delay2 length (s) (0 <= delay2_length <= 2).
  • delay2_wetness (of type {float}, which defaults to 0.): Delay2 wetness (0 <= delay2_wetness <= 1).
  • delay3_feedback (of type {float}, which defaults to 0.): Delay3 feedback (0 <= delay3_feedback <= 1).
  • delay3_length (of type {float}, which defaults to 0.): Delay3 length (s) (0 <= delay3_length <= 2).
  • delay3_wetness (of type {float}, which defaults to 0.): Delay3 wetness (0 <= delay3_wetness <= 1).
  • dist1_drive (of type {float}, which defaults to 0.): Dist1 drive (0 <= dist1_drive <= 3).
  • dist2_drive (of type {float}, which defaults to 0.): Dist2 drive (0 <= dist2_drive <= 3).
  • dist3_drive (of type {float}, which defaults to 0.): Dist3 drive (0 <= dist3_drive <= 3).
  • filt1_freq (of type {float}, which defaults to 440.): Filt1 freq (0 <= filt1_freq <= 8000).
  • filt1_lfo1_level (of type {float}, which defaults to 0.): Filt1 LFO1 level (-500 <= filt1_lfo1_level <= 500).
  • filt1_lfo2_level (of type {float}, which defaults to 0.): Filt1 LFO2 level (-500 <= filt1_lfo2_level <= 500).
  • filt1_q (of type {float}, which defaults to 0.): Filt1 q (0 <= filt1_q <= 1).
  • filt1_resonance (of type {float}, which defaults to 0.): Filt1 resonance (0 <= filt1_resonance <= 1).
  • filt1_type (of type {int}, which defaults to 0): Filt1 type (0=none, 1=LP, 2=HP, 3=BP, 4=BR, 5=AP) (0 <= filt1_type <= 5).
  • filt2_freq (of type {float}, which defaults to 440.): Filt2 freq (0 <= filt2_freq <= 8000).
  • filt2_lfo1_level (of type {float}, which defaults to 0.): Filt2 LFO1 level (-500 <= filt2_lfo1_level <= 500).
  • filt2_lfo2_level (of type {float}, which defaults to 0.): Filt2 LFO2 level (-500 <= filt2_lfo2_level <= 500).
  • filt2_q (of type {float}, which defaults to 0.): Filt2 q (0 <= filt2_q <= 1).
  • filt2_resonance (of type {float}, which defaults to 0.): Filt2 resonance (0 <= filt2_resonance <= 1).
  • filt2_type (of type {int}, which defaults to 0): Filt2 type (0=none, 1=LP, 2=HP, 3=BP, 4=BR, 5=AP) (0 <= filt2_type <= 5).
  • filt3_freq (of type {float}, which defaults to 440.): Filt3 freq (0 <= filt3_freq <= 8000).
  • filt3_lfo1_level (of type {float}, which defaults to 0.): Filt3 LFO1 level (-500 <= filt3_lfo1_level <= 500).
  • filt3_lfo2_level (of type {float}, which defaults to 0.): Filt3 LFO2 level (-500 <= filt3_lfo2_level <= 500).
  • filt3_q (of type {float}, which defaults to 0.): Filt3 q (0 <= filt3_q <= 1).
  • filt3_resonance (of type {float}, which defaults to 0.): Filt3 resonance (0 <= filt3_resonance <= 1).
  • filt3_type (of type {int}, which defaults to 0): Filt3 type (0=none, 1=LP, 2=HP, 3=BP, 4=BR, 5=AP) (0 <= filt3_type <= 5).
  • input_gain (of type {float}, which defaults to 0.): Input gain (dB) (-70 <= input_gain <= 20).
  • lfo1_freq (of type {float}, which defaults to 250.): LFO1 freq (Hz) (0 <= lfo1_freq <= 1000).
  • lfo1_wave (of type {int}, which defaults to 0): LFO1 wave (0 = sin, 1 = tri, 2 = saw, 3 = squ, 4 = s&h) (0 <= lfo1_wave <= 4).
  • lfo2_freq (of type {float}, which defaults to 250.): LFO2 freq (Hz) (0 <= lfo2_freq <= 1000).
  • lfo2_wave (of type {int}, which defaults to 0): LFO2 wave (0 = sin, 1 = tri, 2 = saw, 3 = squ, 4 = s&h) (0 <= lfo2_wave <= 4).
  • osc1_freq (of type {float}, which defaults to 440.): Osc1 freq (Hz) (0 <= osc1_freq <= 4000).
  • osc1_gain (of type {float}, which defaults to -70.): Osc1 gain (dB) (-70 <= osc1_gain <= 20).
  • osc1_wave (of type {int}, which defaults to 0): Osc1 wave (0 = sin, 1 = tri, 2 = saw, 3 = squ, 4 = noise) (0 <= osc1_wave <= 4).
  • osc2_freq (of type {float}, which defaults to 440.): Osc2 freq (Hz) (0 <= osc2_freq <= 4000).
  • osc2_gain (of type {float}, which defaults to -70.): Osc2 gain (dB) (-70 <= osc2_gain <= 20).
  • osc2_wave (of type {int}, which defaults to 0): Osc2 wave (0 = sin, 1 = tri, 2 = saw, 3 = squ, 4 = noise) (0 <= osc2_wave <= 4).
  • ringmod_1_depth (of type {float}, which defaults to 0.): Ringmod 1 depth (0=none, 1=AM, 2=RM) (0 <= ringmod_1_depth <= 2).
  • ringmod_2_depth (of type {float}, which defaults to 0.): Ringmod 2 depth (0=none, 1=AM, 2=RM) (0 <= ringmod_2_depth <= 2).
  • ringmod_3_depth (of type {float}, which defaults to 0.): Ringmod 3 depth (0=none, 1=AM, 2=RM) (0 <= ringmod_3_depth <= 2).
  • rm1_gain (of type {float}, which defaults to -70.): RM1 gain (dB) (-70 <= rm1_gain <= 20).
  • rm2_gain (of type {float}, which defaults to -70.): RM2 gain (dB) (-70 <= rm2_gain <= 20).
  • rm3_gain (of type {float}, which defaults to -70.): RM3 gain (dB) (-70 <= rm3_gain <= 20).
  • xover_lower_freq (of type {float}, which defaults to 1537.5): Xover lower freq (50 <= xover_lower_freq <= 6000).
  • xover_upper_freq (of type {float}, which defaults to 7750.): Xover upper freq (1000 <= xover_upper_freq <= 10000).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Glame Highpass Filter by Alexander Ehlert <mag(at)glame.de>.

Type:

(?id : string?, ?cutoff_frequency : {float}, ?stages : {int},
 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 36.1194992065): Cutoff Frequency (4.41 <= cutoff_frequency <= 19845).
  • stages (of type {int}, which defaults to 1): Stages(2 poles per stage) (1 <= stages <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Hilbert transformer by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, 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.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Impulse convolver by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?gain : {float}, ?high_latency_mode : {int},
 ?impulse_id : {int}, 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 0.): Gain (dB) (-90 <= gain <= 24).
  • high_latency_mode (of type {int}, which defaults to 0): High latency mode (0 <= high_latency_mode <= 1).
  • impulse_id (of type {int}, which defaults to 1): Impulse ID (1 <= impulse_id <= 21).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Inverter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, 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.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Karaoke by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?vocal_volume : {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.
  • vocal_volume (of type {float}, which defaults to 0.): Vocal volume (dB) (-70 <= vocal_volume <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

L/C/R Delay by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?c_delay : {float}, ?c_level : {float},
 ?dry_wet_level : {float}, ?feedback : {float}, ?high_damp : {float},
 ?l_delay : {float}, ?l_level : {float}, ?low_damp : {float},
 ?r_delay : {float}, ?r_level : {float}, ?spread : {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.
  • c_delay (of type {float}, which defaults to 675.): C delay (ms) (0 <= c_delay <= 2700).
  • c_level (of type {float}, which defaults to 25.): C level (0 <= c_level <= 50).
  • dry_wet_level (of type {float}, which defaults to 0.): Dry/Wet level (0 <= dry_wet_level <= 1).
  • feedback (of type {float}, which defaults to 0.): Feedback (-100 <= feedback <= 100).
  • high_damp (of type {float}, which defaults to 50.): High damp (%) (0 <= high_damp <= 100).
  • l_delay (of type {float}, which defaults to 675.): L delay (ms) (0 <= l_delay <= 2700).
  • l_level (of type {float}, which defaults to 25.): L level (0 <= l_level <= 50).
  • low_damp (of type {float}, which defaults to 50.): Low damp (%) (0 <= low_damp <= 100).
  • r_delay (of type {float}, which defaults to 675.): R delay (ms) (0 <= r_delay <= 2700).
  • r_level (of type {float}, which defaults to 25.): R level (0 <= r_level <= 50).
  • spread (of type {float}, which defaults to 25.): Spread (0 <= spread <= 50).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

LFO Phaser by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?feedback : {float}, ?lfo_depth : {float},
 ?lfo_rate : {float}, ?spread : {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.
  • feedback (of type {float}, which defaults to 0.): Feedback (-1 <= feedback <= 1).
  • lfo_depth (of type {float}, which defaults to 0.25): LFO depth (0 <= lfo_depth <= 1).
  • lfo_rate (of type {float}, which defaults to 25.): LFO rate (Hz) (0 <= lfo_rate <= 100).
  • spread (of type {float}, which defaults to 1.): Spread (octaves) (0 <= spread <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Glame Lowpass Filter by Alexander Ehlert <mag(at)glame.de>.

Type:

(?id : string?, ?cutoff_frequency : {float}, ?stages : {int},
 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 2422.96972656): Cutoff Frequency (4.41 <= cutoff_frequency <= 19845).
  • stages (of type {int}, which defaults to 1): Stages(2 poles per stage) (1 <= stages <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

LS Filter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?cutoff_frequency : {float}, ?filter_type : {int},
 ?resonance : {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 1394.56445312): Cutoff frequency (Hz) (88.2 <= cutoff_frequency <= 22050).
  • filter_type (of type {int}, which defaults to 0): Filter type (0=LP, 1=BP, 2=HP) (0 <= filter_type <= 2).
  • resonance (of type {float}, which defaults to 0.): Resonance (0 <= resonance <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Matrix: MS to Stereo by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?width : {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.
  • width (of type {float}, which defaults to 1.): Width (0 <= width <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Matrix Spatialiser by Joern Nettingsmeier <nettings(at)folkwang-hochschule.de>.

Type:

(?id : string?, ?width : {int}, 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.
  • width (of type {int}, which defaults to 0): Width (-512 <= width <= 512).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Matrix: Stereo to MS by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, 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.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Multiband EQ by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?_10000hz_gain : {float}, ?_100hz_gain : {float},
 ?_1250hz_gain : {float}, ?_156hz_gain : {float}, ?_1750hz_gain : {float},
 ?_20000hz_gain : {float}, ?_220hz_gain : {float}, ?_2500hz_gain : {float},
 ?_311hz_gain : {float}, ?_3500hz_gain : {float}, ?_440hz_gain : {float},
 ?_5000hz_gain : {float}, ?_50hz_gain : {float}, ?_622hz_gain : {float},
 ?_880hz_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.
  • _10000hz_gain (of type {float}, which defaults to 0.): 10000Hz gain (-70 <= _10000hz_gain <= 30).
  • _100hz_gain (of type {float}, which defaults to 0.): 100Hz gain (-70 <= _100hz_gain <= 30).
  • _1250hz_gain (of type {float}, which defaults to 0.): 1250Hz gain (-70 <= _1250hz_gain <= 30).
  • _156hz_gain (of type {float}, which defaults to 0.): 156Hz gain (-70 <= _156hz_gain <= 30).
  • _1750hz_gain (of type {float}, which defaults to 0.): 1750Hz gain (-70 <= _1750hz_gain <= 30).
  • _20000hz_gain (of type {float}, which defaults to 0.): 20000Hz gain (-70 <= _20000hz_gain <= 30).
  • _220hz_gain (of type {float}, which defaults to 0.): 220Hz gain (-70 <= _220hz_gain <= 30).
  • _2500hz_gain (of type {float}, which defaults to 0.): 2500Hz gain (-70 <= _2500hz_gain <= 30).
  • _311hz_gain (of type {float}, which defaults to 0.): 311Hz gain (-70 <= _311hz_gain <= 30).
  • _3500hz_gain (of type {float}, which defaults to 0.): 3500Hz gain (-70 <= _3500hz_gain <= 30).
  • _440hz_gain (of type {float}, which defaults to 0.): 440Hz gain (-70 <= _440hz_gain <= 30).
  • _5000hz_gain (of type {float}, which defaults to 0.): 5000Hz gain (-70 <= _5000hz_gain <= 30).
  • _50hz_gain (of type {float}, which defaults to 0.): 50Hz gain (low shelving) (-70 <= _50hz_gain <= 30).
  • _622hz_gain (of type {float}, which defaults to 0.): 622Hz gain (-70 <= _622hz_gain <= 30).
  • _880hz_gain (of type {float}, which defaults to 0.): 880Hz gain (-70 <= _880hz_gain <= 30).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Modulatable delay by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?base_delay : {float}, 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.
  • base_delay (of type {float}, which defaults to 1.): Base delay (s) (0 <= base_delay <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Multivoice Chorus by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?delay_base : {float}, ?detune : {float},
 ?lfo_frequency : {float}, ?number_of_voices : {int},
 ?output_attenuation : {float}, ?voice_separation : {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_base (of type {float}, which defaults to 10.): Delay base (ms) (10 <= delay_base <= 40).
  • detune (of type {float}, which defaults to 1.): Detune (%) (0 <= detune <= 5).
  • lfo_frequency (of type {float}, which defaults to 9.): LFO frequency (Hz) (2 <= lfo_frequency <= 30).
  • number_of_voices (of type {int}, which defaults to 1): Number of voices (1 <= number_of_voices <= 8).
  • output_attenuation (of type {float}, which defaults to 0.): Output attenuation (dB) (-20 <= output_attenuation <= 0).
  • voice_separation (of type {float}, which defaults to 0.5): Voice separation (ms) (0 <= voice_separation <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Mag’s Notch Filter by Alexander Ehlert <mag(at)glame.de>.

Type:

(?id : string?, ?bandwidth : {float}, ?center_frequency : {float},
 ?stages : {int}, 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.
  • bandwidth (of type {float}, which defaults to 295.831787109): Bandwidth (Hz) (4.41 <= bandwidth <= 19845).
  • center_frequency (of type {float}, which defaults to 295.831787109): Center Frequency (Hz) (4.41 <= center_frequency <= 19845).
  • stages (of type {int}, which defaults to 1): Stages(2 poles per stage) (1 <= stages <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Pitch Scaler by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?pitch_co_efficient : {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.
  • pitch_co_efficient (of type {float}, which defaults to 1.): Pitch co-efficient (0.5 <= pitch_co_efficient <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Higher Quality Pitch Scaler by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?pitch_co_efficient : {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.
  • pitch_co_efficient (of type {float}, which defaults to 1.): Pitch co-efficient (0.5 <= pitch_co_efficient <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Plate reverb by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?damping : {float}, ?dry_wet_mix : {float},
 ?reverb_time : {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.
  • damping (of type {float}, which defaults to 0.25): Damping (0 <= damping <= 1).
  • dry_wet_mix (of type {float}, which defaults to 0.25): Dry/wet mix (0 <= dry_wet_mix <= 1).
  • reverb_time (of type {float}, which defaults to 4.25500011444): Reverb time (0.01 <= reverb_time <= 8.5).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Pointer cast distortion by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?dry_wet_mix : {float}, ?effect_cutoff_freq : {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.
  • dry_wet_mix (of type {float}, which defaults to 0.): Dry/wet mix (0 <= dry_wet_mix <= 1).
  • effect_cutoff_freq (of type {float}, which defaults to 32.6376495361): Effect cutoff freq (Hz) (4.41 <= effect_cutoff_freq <= 13230).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Rate shifter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?rate : {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.
  • rate (of type {float}, which defaults to 1.): Rate (-4 <= rate <= 4).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Retro Flanger by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?average_stall : {float}, ?flange_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.
  • average_stall (of type {float}, which defaults to 2.5): Average stall (ms) (0 <= average_stall <= 10).
  • flange_frequency (of type {float}, which defaults to 1.): Flange frequency (Hz) (0.5 <= flange_frequency <= 8).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Reverse Delay (5s max) by Jesse Chappell .

Type:

(?id : string?, ?crossfade_samples : {int}, ?delay_time : {float},
 ?dry_level : {float}, ?feedback : {float}, ?wet_level : {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.
  • crossfade_samples (of type {int}, which defaults to 1250): Crossfade samples (0 <= crossfade_samples <= 5000).
  • delay_time (of type {float}, which defaults to 0.): Delay Time (s) (0 <= delay_time <= 5).
  • dry_level (of type {float}, which defaults to 0.): Dry Level (dB) (-70 <= dry_level <= 0).
  • feedback (of type {float}, which defaults to 0.): Feedback (0 <= feedback <= 1).
  • wet_level (of type {float}, which defaults to 0.): Wet Level (dB) (-70 <= wet_level <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Ringmod with LFO by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?frequency : {float}, ?modulation_depth : {float},
 ?sawtooth_level : {float}, ?sine_level : {float}, ?square_level : {float},
 ?triangle_level : {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) (1 <= frequency <= 1000).
  • modulation_depth (of type {float}, which defaults to 0.): Modulation depth (0=none, 1=AM, 2=RM) (0 <= modulation_depth <= 2).
  • sawtooth_level (of type {float}, which defaults to 0.): Sawtooth level (-1 <= sawtooth_level <= 1).
  • sine_level (of type {float}, which defaults to 1.): Sine level (-1 <= sine_level <= 1).
  • square_level (of type {float}, which defaults to 0.): Square level (-1 <= square_level <= 1).
  • triangle_level (of type {float}, which defaults to 0.): Triangle level (-1 <= triangle_level <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Ringmod with two inputs by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?modulation_depth : {float}, 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.
  • modulation_depth (of type {float}, which defaults to 0.): Modulation depth (0=none, 1=AM, 2=RM) (0 <= modulation_depth <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Barry’s Satan Maximiser by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?decay_time : {float}, ?knee_point : {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.
  • decay_time (of type {float}, which defaults to 30.): Decay time (samples) (2 <= decay_time <= 30).
  • knee_point (of type {float}, which defaults to 0.): Knee point (dB) (-90 <= knee_point <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

SC1 by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?attack_time : {float}, ?knee_radius : {float},
 ?makeup_gain : {float}, ?ratio : {float}, ?release_time : {float},
 ?threshold_level : {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.
  • attack_time (of type {float}, which defaults to 101.5): Attack time (ms) (2 <= attack_time <= 400).
  • knee_radius (of type {float}, which defaults to 3.25): Knee radius (dB) (1 <= knee_radius <= 10).
  • makeup_gain (of type {float}, which defaults to 0.): Makeup gain (dB) (0 <= makeup_gain <= 24).
  • ratio (of type {float}, which defaults to 1.): Ratio (1:n) (1 <= ratio <= 10).
  • release_time (of type {float}, which defaults to 401.): Release time (ms) (2 <= release_time <= 800).
  • threshold_level (of type {float}, which defaults to 0.): Threshold level (dB) (-30 <= threshold_level <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

SC2 by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?attack_time : {float}, ?knee_radius : {float},
 ?makeup_gain : {float}, ?ratio : {float}, ?release_time : {float},
 ?threshold_level : {float}, 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.
  • attack_time (of type {float}, which defaults to 101.5): Attack time (ms) (2 <= attack_time <= 400).
  • knee_radius (of type {float}, which defaults to 3.25): Knee radius (dB) (1 <= knee_radius <= 10).
  • makeup_gain (of type {float}, which defaults to 0.): Makeup gain (dB) (0 <= makeup_gain <= 24).
  • ratio (of type {float}, which defaults to 1.): Ratio (1:n) (1 <= ratio <= 10).
  • release_time (of type {float}, which defaults to 401.): Release time (ms) (2 <= release_time <= 800).
  • threshold_level (of type {float}, which defaults to 0.): Threshold level (dB) (-30 <= threshold_level <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

SC4 by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?attack_time : {float}, ?knee_radius : {float},
 ?makeup_gain : {float}, ?ratio : {float}, ?release_time : {float},
 ?rms_peak : {float}, ?threshold_level : {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.
  • attack_time (of type {float}, which defaults to 101.125): Attack time (ms) (1.5 <= attack_time <= 400).
  • knee_radius (of type {float}, which defaults to 3.25): Knee radius (dB) (1 <= knee_radius <= 10).
  • makeup_gain (of type {float}, which defaults to 0.): Makeup gain (dB) (0 <= makeup_gain <= 24).
  • ratio (of type {float}, which defaults to 1.): Ratio (1:n) (1 <= ratio <= 20).
  • release_time (of type {float}, which defaults to 401.): Release time (ms) (2 <= release_time <= 800).
  • rms_peak (of type {float}, which defaults to 0.): RMS/peak (0 <= rms_peak <= 1).
  • threshold_level (of type {float}, which defaults to 0.): Threshold level (dB) (-30 <= threshold_level <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

SC4 mono by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?attack_time : {float}, ?knee_radius : {float},
 ?makeup_gain : {float}, ?ratio : {float}, ?release_time : {float},
 ?rms_peak : {float}, ?threshold_level : {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.
  • attack_time (of type {float}, which defaults to 101.125): Attack time (ms) (1.5 <= attack_time <= 400).
  • knee_radius (of type {float}, which defaults to 3.25): Knee radius (dB) (1 <= knee_radius <= 10).
  • makeup_gain (of type {float}, which defaults to 0.): Makeup gain (dB) (0 <= makeup_gain <= 24).
  • ratio (of type {float}, which defaults to 1.): Ratio (1:n) (1 <= ratio <= 20).
  • release_time (of type {float}, which defaults to 401.): Release time (ms) (2 <= release_time <= 800).
  • rms_peak (of type {float}, which defaults to 0.): RMS/peak (0 <= rms_peak <= 1).
  • threshold_level (of type {float}, which defaults to 0.): Threshold level (dB) (-30 <= threshold_level <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

SE4 by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?attack_time : {float}, ?attenuation : {float},
 ?knee_radius : {float}, ?ratio : {float}, ?release_time : {float},
 ?rms_peak : {float}, ?threshold_level : {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.
  • attack_time (of type {float}, which defaults to 101.125): Attack time (ms) (1.5 <= attack_time <= 400).
  • attenuation (of type {float}, which defaults to 0.): Attenuation (dB) (-24 <= attenuation <= 0).
  • knee_radius (of type {float}, which defaults to 3.25): Knee radius (dB) (1 <= knee_radius <= 10).
  • ratio (of type {float}, which defaults to 1.): Ratio (1:n) (1 <= ratio <= 20).
  • release_time (of type {float}, which defaults to 401.): Release time (ms) (2 <= release_time <= 800).
  • rms_peak (of type {float}, which defaults to 0.): RMS/peak (0 <= rms_peak <= 1).
  • threshold_level (of type {float}, which defaults to 0.): Threshold level (dB) (-30 <= threshold_level <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Wave shaper by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?waveshape : {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.
  • waveshape (of type {float}, which defaults to 0.): Waveshape (-10 <= waveshape <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Signal sifter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?sift_size : {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.
  • sift_size (of type {float}, which defaults to 1.): Sift size (1 <= sift_size <= 1000).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Single band parametric by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?bandwidth : {float}, ?frequency : {float}, ?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.
  • bandwidth (of type {float}, which defaults to 1.): Bandwidth (octaves) (0 <= bandwidth <= 4).
  • frequency (of type {float}, which defaults to 440.): Frequency (Hz) (0 <= frequency <= 17640).
  • gain (of type {float}, which defaults to 0.): Gain (dB) (-70 <= gain <= 30).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Sinus wavewrapper by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?wrap_degree : {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.
  • wrap_degree (of type {float}, which defaults to 0.): Wrap degree (0 <= wrap_degree <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Smooth Decimator by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?resample_rate : {float}, ?smoothing : {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.
  • resample_rate (of type {float}, which defaults to 44100.): Resample rate (0 <= resample_rate <= 44100).
  • smoothing (of type {float}, which defaults to 1.): Smoothing (0 <= smoothing <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Mono to Stereo splitter by Frank Neumann <franky(at)users.sourceforge.net>.

Type:

(?id : string?, 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.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

State Variable Filter by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?filter_freq : {float}, ?filter_q : {float},
 ?filter_resonance : {float}, ?filter_type : {int}, 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.
  • filter_freq (of type {float}, which defaults to 440.): Filter freq (0 <= filter_freq <= 6000).
  • filter_q (of type {float}, which defaults to 0.25): Filter Q (0 <= filter_q <= 1).
  • filter_resonance (of type {float}, which defaults to 0.): Filter resonance (0 <= filter_resonance <= 1).
  • filter_type (of type {int}, which defaults to 0): Filter type (0=none, 1=LP, 2=HP, 3=BP, 4=BR, 5=AP) (0 <= filter_type <= 5).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP AutoPanner by Tom Szilagyi.

Type:

(?id : string?, ?depth : {float}, ?frequency : {float}, ?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.
  • depth (of type {float}, which defaults to 0.): Depth [%] (0 <= depth <= 100).
  • frequency (of type {float}, which defaults to 0.): Frequency [Hz] (0 <= frequency <= 20).
  • gain (of type {float}, which defaults to 0.): Gain [dB] (-70 <= gain <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Chorus/Flanger by Tom Szilagyi.

Type:

(?id : string?, ?contour : {float}, ?delay : {float}, ?depth : {float},
 ?dry_level : {float}, ?frequency : {float}, ?l_r_phase_shift : {float},
 ?wet_level : {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.
  • contour (of type {float}, which defaults to 100.): Contour [Hz] (20 <= contour <= 20000).
  • delay (of type {float}, which defaults to 25.): Delay [ms] (0 <= delay <= 100).
  • depth (of type {float}, which defaults to 75.): Depth [%] (0 <= depth <= 100).
  • dry_level (of type {float}, which defaults to 0.): Dry Level [dB] (-90 <= dry_level <= 20).
  • frequency (of type {float}, which defaults to 1.25): Frequency [Hz] (0 <= frequency <= 5).
  • l_r_phase_shift (of type {float}, which defaults to 90.): L/R Phase Shift [deg] (0 <= l_r_phase_shift <= 180).
  • wet_level (of type {float}, which defaults to 0.): Wet Level [dB] (-90 <= wet_level <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP DeEsser by Tom Szilagyi.

Type:

(?id : string?, ?frequency : {float}, ?monitor : {int},
 ?sidechain_filter : {int}, ?threshold_level : {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 5500.): Frequency [Hz] (2000 <= frequency <= 16000).
  • monitor (of type {int}, which defaults to 0): Monitor (0 <= monitor <= 1).
  • sidechain_filter (of type {int}, which defaults to 0): Sidechain Filter (0 <= sidechain_filter <= 1).
  • threshold_level (of type {float}, which defaults to 0.): Threshold Level [dB] (-50 <= threshold_level <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Fractal Doubler by Tom Szilagyi.

Type:

(?id : string?, ?dry_left_position : {float}, ?dry_level : {float},
 ?dry_right_position : {float}, ?pitch_tracking : {float},
 ?time_tracking : {float}, ?wet_left_position : {float},
 ?wet_level : {float}, ?wet_right_position : {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.
  • dry_left_position (of type {float}, which defaults to 0.): Dry Left Position (0 <= dry_left_position <= 1).
  • dry_level (of type {float}, which defaults to 0.): Dry Level [dB] (-90 <= dry_level <= 20).
  • dry_right_position (of type {float}, which defaults to 1.): Dry Right Position (0 <= dry_right_position <= 1).
  • pitch_tracking (of type {float}, which defaults to 0.5): Pitch Tracking (0 <= pitch_tracking <= 1).
  • time_tracking (of type {float}, which defaults to 0.5): Time Tracking (0 <= time_tracking <= 1).
  • wet_left_position (of type {float}, which defaults to 0.): Wet Left Position (0 <= wet_left_position <= 1).
  • wet_level (of type {float}, which defaults to 0.): Wet Level [dB] (-90 <= wet_level <= 20).
  • wet_right_position (of type {float}, which defaults to 1.): Wet Right Position (0 <= wet_right_position <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Dynamics (M) by Tom Szilagyi.

Type:

(?id : string?, ?attack : {float}, ?function : {int}, ?makeup_gain : {float},
 ?offset_gain : {float}, ?release : {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.
  • attack (of type {float}, which defaults to 128.): Attack [ms] (4 <= attack <= 500).
  • function (of type {int}, which defaults to 0): Function (0 <= function <= 14).
  • makeup_gain (of type {float}, which defaults to 0.): Makeup Gain [dB] (-20 <= makeup_gain <= 20).
  • offset_gain (of type {float}, which defaults to 0.): Offset Gain [dB] (-20 <= offset_gain <= 20).
  • release (of type {float}, which defaults to 502.): Release [ms] (4 <= release <= 1000).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Dynamics (St) by Tom Szilagyi.

Type:

(?id : string?, ?attack : {float}, ?function : {int}, ?makeup_gain : {float},
 ?offset_gain : {float}, ?release : {float}, ?stereo_mode : {int},
 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.
  • attack (of type {float}, which defaults to 128.): Attack [ms] (4 <= attack <= 500).
  • function (of type {int}, which defaults to 0): Function (0 <= function <= 14).
  • makeup_gain (of type {float}, which defaults to 0.): Makeup Gain [dB] (-20 <= makeup_gain <= 20).
  • offset_gain (of type {float}, which defaults to 0.): Offset Gain [dB] (-20 <= offset_gain <= 20).
  • release (of type {float}, which defaults to 502.): Release [ms] (4 <= release <= 1000).
  • stereo_mode (of type {int}, which defaults to 0): Stereo Mode (0 <= stereo_mode <= 2).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Equalizer by Tom Szilagyi.

Type:

(?id : string?, ?band_1_freq : {float}, ?band_1_gain : {float},
 ?band_2_freq : {float}, ?band_2_gain : {float}, ?band_3_freq : {float},
 ?band_3_gain : {float}, ?band_4_freq : {float}, ?band_4_gain : {float},
 ?band_5_freq : {float}, ?band_5_gain : {float}, ?band_6_freq : {float},
 ?band_6_gain : {float}, ?band_7_freq : {float}, ?band_7_gain : {float},
 ?band_8_freq : {float}, ?band_8_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.
  • band_1_freq (of type {float}, which defaults to 100.): Band 1 Freq [Hz] (40 <= band_1_freq <= 280).
  • band_1_gain (of type {float}, which defaults to 0.): Band 1 Gain [dB] (-50 <= band_1_gain <= 20).
  • band_2_freq (of type {float}, which defaults to 200.): Band 2 Freq [Hz] (100 <= band_2_freq <= 500).
  • band_2_gain (of type {float}, which defaults to 0.): Band 2 Gain [dB] (-50 <= band_2_gain <= 20).
  • band_3_freq (of type {float}, which defaults to 400.): Band 3 Freq [Hz] (200 <= band_3_freq <= 1000).
  • band_3_gain (of type {float}, which defaults to 0.): Band 3 Gain [dB] (-50 <= band_3_gain <= 20).
  • band_4_freq (of type {float}, which defaults to 1000.): Band 4 Freq [Hz] (400 <= band_4_freq <= 2800).
  • band_4_gain (of type {float}, which defaults to 0.): Band 4 Gain [dB] (-50 <= band_4_gain <= 20).
  • band_5_freq (of type {float}, which defaults to 3000.): Band 5 Freq [Hz] (1000 <= band_5_freq <= 5000).
  • band_5_gain (of type {float}, which defaults to 0.): Band 5 Gain [dB] (-50 <= band_5_gain <= 20).
  • band_6_freq (of type {float}, which defaults to 6000.): Band 6 Freq [Hz] (3000 <= band_6_freq <= 9000).
  • band_6_gain (of type {float}, which defaults to 0.): Band 6 Gain [dB] (-50 <= band_6_gain <= 20).
  • band_7_freq (of type {float}, which defaults to 12000.): Band 7 Freq [Hz] (6000 <= band_7_freq <= 18000).
  • band_7_gain (of type {float}, which defaults to 0.): Band 7 Gain [dB] (-50 <= band_7_gain <= 20).
  • band_8_freq (of type {float}, which defaults to 15000.): Band 8 Freq [Hz] (10000 <= band_8_freq <= 20000).
  • band_8_gain (of type {float}, which defaults to 0.): Band 8 Gain [dB] (-50 <= band_8_gain <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Equalizer/BW by Tom Szilagyi.

Type:

(?id : string?, ?band_1_bandwidth : {float}, ?band_1_freq : {float},
 ?band_1_gain : {float}, ?band_2_bandwidth : {float}, ?band_2_freq : {float},
 ?band_2_gain : {float}, ?band_3_bandwidth : {float}, ?band_3_freq : {float},
 ?band_3_gain : {float}, ?band_4_bandwidth : {float}, ?band_4_freq : {float},
 ?band_4_gain : {float}, ?band_5_bandwidth : {float}, ?band_5_freq : {float},
 ?band_5_gain : {float}, ?band_6_bandwidth : {float}, ?band_6_freq : {float},
 ?band_6_gain : {float}, ?band_7_bandwidth : {float}, ?band_7_freq : {float},
 ?band_7_gain : {float}, ?band_8_bandwidth : {float}, ?band_8_freq : {float},
 ?band_8_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.
  • band_1_bandwidth (of type {float}, which defaults to 1.): Band 1 Bandwidth [octaves] (0.1 <= band_1_bandwidth <= 5).
  • band_1_freq (of type {float}, which defaults to 100.): Band 1 Freq [Hz] (40 <= band_1_freq <= 280).
  • band_1_gain (of type {float}, which defaults to 0.): Band 1 Gain [dB] (-50 <= band_1_gain <= 20).
  • band_2_bandwidth (of type {float}, which defaults to 1.): Band 2 Bandwidth [octaves] (0.1 <= band_2_bandwidth <= 5).
  • band_2_freq (of type {float}, which defaults to 200.): Band 2 Freq [Hz] (100 <= band_2_freq <= 500).
  • band_2_gain (of type {float}, which defaults to 0.): Band 2 Gain [dB] (-50 <= band_2_gain <= 20).
  • band_3_bandwidth (of type {float}, which defaults to 1.): Band 3 Bandwidth [octaves] (0.1 <= band_3_bandwidth <= 5).
  • band_3_freq (of type {float}, which defaults to 400.): Band 3 Freq [Hz] (200 <= band_3_freq <= 1000).
  • band_3_gain (of type {float}, which defaults to 0.): Band 3 Gain [dB] (-50 <= band_3_gain <= 20).
  • band_4_bandwidth (of type {float}, which defaults to 1.): Band 4 Bandwidth [octaves] (0.1 <= band_4_bandwidth <= 5).
  • band_4_freq (of type {float}, which defaults to 1000.): Band 4 Freq [Hz] (400 <= band_4_freq <= 2800).
  • band_4_gain (of type {float}, which defaults to 0.): Band 4 Gain [dB] (-50 <= band_4_gain <= 20).
  • band_5_bandwidth (of type {float}, which defaults to 1.): Band 5 Bandwidth [octaves] (0.1 <= band_5_bandwidth <= 5).
  • band_5_freq (of type {float}, which defaults to 3000.): Band 5 Freq [Hz] (1000 <= band_5_freq <= 5000).
  • band_5_gain (of type {float}, which defaults to 0.): Band 5 Gain [dB] (-50 <= band_5_gain <= 20).
  • band_6_bandwidth (of type {float}, which defaults to 1.): Band 6 Bandwidth [octaves] (0.1 <= band_6_bandwidth <= 5).
  • band_6_freq (of type {float}, which defaults to 6000.): Band 6 Freq [Hz] (3000 <= band_6_freq <= 9000).
  • band_6_gain (of type {float}, which defaults to 0.): Band 6 Gain [dB] (-50 <= band_6_gain <= 20).
  • band_7_bandwidth (of type {float}, which defaults to 1.): Band 7 Bandwidth [octaves] (0.1 <= band_7_bandwidth <= 5).
  • band_7_freq (of type {float}, which defaults to 12000.): Band 7 Freq [Hz] (6000 <= band_7_freq <= 18000).
  • band_7_gain (of type {float}, which defaults to 0.): Band 7 Gain [dB] (-50 <= band_7_gain <= 20).
  • band_8_bandwidth (of type {float}, which defaults to 1.): Band 8 Bandwidth [octaves] (0.1 <= band_8_bandwidth <= 5).
  • band_8_freq (of type {float}, which defaults to 15000.): Band 8 Freq [Hz] (10000 <= band_8_freq <= 20000).
  • band_8_gain (of type {float}, which defaults to 0.): Band 8 Gain [dB] (-50 <= band_8_gain <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Scaling Limiter by Tom Szilagyi.

Type:

(?id : string?, ?limit_level : {float}, ?output_volume : {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.
  • limit_level (of type {float}, which defaults to 0.): Limit Level [dB] (-30 <= limit_level <= 20).
  • output_volume (of type {float}, which defaults to 0.): Output Volume [dB] (-30 <= output_volume <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Pink/Fractal Noise by Tom Szilagyi.

Type:

(?id : string?, ?fractal_dimension : {float}, ?noise_level : {float},
 ?signal_level : {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.
  • fractal_dimension (of type {float}, which defaults to 0.5): Fractal Dimension (0 <= fractal_dimension <= 1).
  • noise_level (of type {float}, which defaults to -90.): Noise Level [dB] (-90 <= noise_level <= 20).
  • signal_level (of type {float}, which defaults to 0.): Signal Level [dB] (-90 <= signal_level <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Pitch Shifter by Tom Szilagyi.

Type:

(?id : string?, ?dry_level : {float}, ?rate_shift : {float},
 ?semitone_shift : {float}, ?wet_level : {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.
  • dry_level (of type {float}, which defaults to -90.): Dry Level [dB] (-90 <= dry_level <= 20).
  • rate_shift (of type {float}, which defaults to 0.): Rate Shift [%] (-50 <= rate_shift <= 100).
  • semitone_shift (of type {float}, which defaults to 0.): Semitone Shift (-12 <= semitone_shift <= 12).
  • wet_level (of type {float}, which defaults to 0.): Wet Level [dB] (-90 <= wet_level <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Reflector by Tom Szilagyi.

Type:

(?id : string?, ?dry_level : {float}, ?fragment_length : {float},
 ?wet_level : {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.
  • dry_level (of type {float}, which defaults to -90.): Dry Level [dB] (-90 <= dry_level <= 20).
  • fragment_length (of type {float}, which defaults to 415.): Fragment Length [ms] (20 <= fragment_length <= 1600).
  • wet_level (of type {float}, which defaults to 0.): Wet Level [dB] (-90 <= wet_level <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Reverberator by Tom Szilagyi.

Type:

(?id : string?, ?allpass_filters : {bool}, ?bandpass_filter : {bool},
 ?comb_filters : {bool}, ?decay : {float}, ?dry_level : {float},
 ?enhanced_stereo : {bool}, ?reverb_type : {int}, ?wet_level : {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.
  • allpass_filters (of type {bool}, which defaults to true): Allpass Filters.
  • bandpass_filter (of type {bool}, which defaults to true): Bandpass Filter.
  • comb_filters (of type {bool}, which defaults to true): Comb Filters.
  • decay (of type {float}, which defaults to 2500.): Decay [ms] (0 <= decay <= 10000).
  • dry_level (of type {float}, which defaults to 0.): Dry Level [dB] (-70 <= dry_level <= 10).
  • enhanced_stereo (of type {bool}, which defaults to true): Enhanced Stereo.
  • reverb_type (of type {int}, which defaults to 0): Reverb Type (0 <= reverb_type <= 42).
  • wet_level (of type {float}, which defaults to 0.): Wet Level [dB] (-70 <= wet_level <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Rotary Speaker by Tom Szilagyi.

Type:

(?id : string?, ?horn_frequency : {float}, ?mic_distance : {float},
 ?rotor_frequency : {float}, ?rotor_horn_mix : {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.
  • horn_frequency (of type {float}, which defaults to 0.): Horn Frequency [Hz] (0 <= horn_frequency <= 30).
  • mic_distance (of type {float}, which defaults to 25.): Mic Distance [%] (0 <= mic_distance <= 100).
  • rotor_frequency (of type {float}, which defaults to 0.): Rotor Frequency [Hz] (0 <= rotor_frequency <= 30).
  • rotor_horn_mix (of type {float}, which defaults to 0.5): Rotor/Horn Mix (0 <= rotor_horn_mix <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Sigmoid Booster by Tom Szilagyi.

Type:

(?id : string?, ?post_gain : {float}, ?pre_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.
  • post_gain (of type {float}, which defaults to 0.): Post Gain [dB] (-90 <= post_gain <= 20).
  • pre_gain (of type {float}, which defaults to 0.): Pre Gain [dB] (-90 <= pre_gain <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Stereo Echo by Tom Szilagyi.

Type:

(?id : string?, ?cross_mode : {bool}, ?dry_level : {float},
 ?haas_effect : {bool}, ?l_delay : {float}, ?l_echo_level : {float},
 ?l_feedback : {float}, ?r_echo_level : {float}, ?r_haas_delay : {float},
 ?r_haas_feedback : {float}, ?swap_outputs : {bool}, 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.
  • cross_mode (of type {bool}, which defaults to false): Cross Mode.
  • dry_level (of type {float}, which defaults to 0.): Dry Level [dB] (-70 <= dry_level <= 10).
  • haas_effect (of type {bool}, which defaults to false): Haas Effect.
  • l_delay (of type {float}, which defaults to 100.): L Delay [ms] (0 <= l_delay <= 2000).
  • l_echo_level (of type {float}, which defaults to 0.): L Echo Level [dB] (-70 <= l_echo_level <= 10).
  • l_feedback (of type {float}, which defaults to 0.): L Feedback [%] (0 <= l_feedback <= 100).
  • r_echo_level (of type {float}, which defaults to 0.): R Echo Level [dB] (-70 <= r_echo_level <= 10).
  • r_haas_delay (of type {float}, which defaults to 100.): R/Haas Delay [ms] (0 <= r_haas_delay <= 2000).
  • r_haas_feedback (of type {float}, which defaults to 0.): R/Haas Feedback [%] (0 <= r_haas_feedback <= 100).
  • swap_outputs (of type {bool}, which defaults to false): Swap Outputs.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Tremolo by Tom Szilagyi.

Type:

(?id : string?, ?depth : {float}, ?frequency : {float}, ?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.
  • depth (of type {float}, which defaults to 0.): Depth [%] (0 <= depth <= 100).
  • frequency (of type {float}, which defaults to 0.): Frequency [Hz] (0 <= frequency <= 20).
  • gain (of type {float}, which defaults to 0.): Gain [dB] (-70 <= gain <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP TubeWarmth by Tom Szilagyi.

Type:

(?id : string?, ?drive : {float}, ?tape_tube_blend : {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.
  • drive (of type {float}, which defaults to 2.57500004768): Drive (0.1 <= drive <= 10).
  • tape_tube_blend (of type {float}, which defaults to 10.): Tape–Tube Blend (-10 <= tape_tube_blend <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

TAP Vibrato by Tom Szilagyi.

Type:

(?id : string?, ?depth : {float}, ?dry_level : {float}, ?frequency : {float},
 ?wet_level : {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.
  • depth (of type {float}, which defaults to 0.): Depth [%] (0 <= depth <= 20).
  • dry_level (of type {float}, which defaults to -90.): Dry Level [dB] (-90 <= dry_level <= 20).
  • frequency (of type {float}, which defaults to 0.): Frequency [Hz] (0 <= frequency <= 30).
  • wet_level (of type {float}, which defaults to 0.): Wet Level [dB] (-90 <= wet_level <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Tape Delay Simulation by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?dry_level : {float}, ?tap_1_distance : {float},
 ?tap_1_level : {float}, ?tap_2_distance : {float}, ?tap_2_level : {float},
 ?tap_3_distance : {float}, ?tap_3_level : {float},
 ?tap_4_distance : {float}, ?tap_4_level : {float}, ?tape_speed : {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.
  • dry_level (of type {float}, which defaults to -90.): Dry level (dB) (-90 <= dry_level <= 0).
  • tap_1_distance (of type {float}, which defaults to 0.): Tap 1 distance (inches) (0 <= tap_1_distance <= 4).
  • tap_1_level (of type {float}, which defaults to 0.): Tap 1 level (dB) (-90 <= tap_1_level <= 0).
  • tap_2_distance (of type {float}, which defaults to 1.): Tap 2 distance (inches) (0 <= tap_2_distance <= 4).
  • tap_2_level (of type {float}, which defaults to -90.): Tap 2 level (dB) (-90 <= tap_2_level <= 0).
  • tap_3_distance (of type {float}, which defaults to 2.): Tap 3 distance (inches) (0 <= tap_3_distance <= 4).
  • tap_3_level (of type {float}, which defaults to -90.): Tap 3 level (dB) (-90 <= tap_3_level <= 0).
  • tap_4_distance (of type {float}, which defaults to 3.): Tap 4 distance (inches) (0 <= tap_4_distance <= 4).
  • tap_4_level (of type {float}, which defaults to -90.): Tap 4 level (dB) (-90 <= tap_4_level <= 0).
  • tape_speed (of type {float}, which defaults to 1.): Tape speed (inches/sec, 1=normal) (0 <= tape_speed <= 10).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Transient mangler by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?attack_speed : {float}, ?sustain_time : {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.
  • attack_speed (of type {float}, which defaults to 0.): Attack speed (-1 <= attack_speed <= 1).
  • sustain_time (of type {float}, which defaults to 0.): Sustain time (-1 <= sustain_time <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Triple band parametric with shelves by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?band_1_bandwidth : {float}, ?band_1_frequency : {float},
 ?band_1_gain : {float}, ?band_2_bandwidth : {float},
 ?band_2_frequency : {float}, ?band_2_gain : {float},
 ?band_3_bandwidth : {float}, ?band_3_frequency : {float},
 ?band_3_gain : {float}, ?high_shelving_frequency : {float},
 ?high_shelving_gain : {float}, ?high_shelving_slope : {float},
 ?low_shelving_frequency : {float}, ?low_shelving_gain : {float},
 ?low_shelving_slope : {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.
  • band_1_bandwidth (of type {float}, which defaults to 1.): Band 1 bandwidth (octaves) (0 <= band_1_bandwidth <= 4).
  • band_1_frequency (of type {float}, which defaults to 36.8967056274): Band 1 frequency (Hz) (4.41 <= band_1_frequency <= 21609).
  • band_1_gain (of type {float}, which defaults to 0.): Band 1 gain (dB) (-70 <= band_1_gain <= 30).
  • band_2_bandwidth (of type {float}, which defaults to 1.): Band 2 bandwidth (octaves) (0 <= band_2_bandwidth <= 4).
  • band_2_frequency (of type {float}, which defaults to 308.699981689): Band 2 frequency (Hz) (4.41 <= band_2_frequency <= 21609).
  • band_2_gain (of type {float}, which defaults to 0.): Band 2 gain (dB) (-70 <= band_2_gain <= 30).
  • band_3_bandwidth (of type {float}, which defaults to 1.): Band 3 bandwidth (octaves) (0 <= band_3_bandwidth <= 4).
  • band_3_frequency (of type {float}, which defaults to 2582.76953125): Band 3 frequency (Hz) (4.41 <= band_3_frequency <= 21609).
  • band_3_gain (of type {float}, which defaults to 0.): Band 3 gain (dB) (-70 <= band_3_gain <= 30).
  • high_shelving_frequency (of type {float}, which defaults to 21609.): High-shelving frequency (Hz) (4.41 <= high_shelving_frequency <= 21609).
  • high_shelving_gain (of type {float}, which defaults to 0.): High-shelving gain (dB) (-70 <= high_shelving_gain <= 30).
  • high_shelving_slope (of type {float}, which defaults to 0.5): High-shelving slope (0 <= high_shelving_slope <= 1).
  • low_shelving_frequency (of type {float}, which defaults to 4.40999984741): Low-shelving frequency (Hz) (4.41 <= low_shelving_frequency <= 21609).
  • low_shelving_gain (of type {float}, which defaults to 0.): Low-shelving gain (dB) (-70 <= low_shelving_gain <= 30).
  • low_shelving_slope (of type {float}, which defaults to 0.5): Low-shelving slope (0 <= low_shelving_slope <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Valve saturation by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?distortion_character : {float}, ?distortion_level : {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.
  • distortion_character (of type {float}, which defaults to 0.): Distortion character (0 <= distortion_character <= 1).
  • distortion_level (of type {float}, which defaults to 0.): Distortion level (0 <= distortion_level <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Valve rectifier by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?distortion : {float}, ?sag_level : {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.
  • distortion (of type {float}, which defaults to 0.): Distortion (0 <= distortion <= 1).
  • sag_level (of type {float}, which defaults to 0.): Sag level (0 <= sag_level <= 1).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Vocoder by Achim Settelmeier <settel-linux(at)sirlab.de> (adapted by Josh Green and Hexasoft).

Type:

(?id : string?, band_10_level : {float}, band_11_level : {float},
 band_12_level : {float}, band_13_level : {float}, band_14_level : {float},
 band_15_level : {float}, band_16_level : {float}, band_1_level : {float},
 band_2_level : {float}, band_3_level : {float}, band_4_level : {float},
 band_5_level : {float}, band_6_level : {float}, band_7_level : {float},
 band_8_level : {float}, band_9_level : {float}, left_right : {int},
 number_of_bands : {int}, 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.
  • band_10_level (of type {float}): Band 10 Level (0 <= band_10_level <= 1).
  • band_11_level (of type {float}): Band 11 Level (0 <= band_11_level <= 1).
  • band_12_level (of type {float}): Band 12 Level (0 <= band_12_level <= 1).
  • band_13_level (of type {float}): Band 13 Level (0 <= band_13_level <= 1).
  • band_14_level (of type {float}): Band 14 Level (0 <= band_14_level <= 1).
  • band_15_level (of type {float}): Band 15 Level (0 <= band_15_level <= 1).
  • band_16_level (of type {float}): Band 16 Level (0 <= band_16_level <= 1).
  • band_1_level (of type {float}): Band 1 Level (0 <= band_1_level <= 1).
  • band_2_level (of type {float}): Band 2 Level (0 <= band_2_level <= 1).
  • band_3_level (of type {float}): Band 3 Level (0 <= band_3_level <= 1).
  • band_4_level (of type {float}): Band 4 Level (0 <= band_4_level <= 1).
  • band_5_level (of type {float}): Band 5 Level (0 <= band_5_level <= 1).
  • band_6_level (of type {float}): Band 6 Level (0 <= band_6_level <= 1).
  • band_7_level (of type {float}): Band 7 Level (0 <= band_7_level <= 1).
  • band_8_level (of type {float}): Band 8 Level (0 <= band_8_level <= 1).
  • band_9_level (of type {float}): Band 9 Level (0 <= band_9_level <= 1).
  • left_right (of type {int}): Left/Right (-100 <= left_right <= 100).
  • number_of_bands (of type {int}): Number of bands (1 <= number_of_bands <= 16).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

VyNil (Vinyl Effect) by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, ?crackle : {float}, ?rpm : {float},
 ?surface_warping : {float}, ?wear : {float}, ?year : {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.
  • crackle (of type {float}, which defaults to 0.): Crackle (0 <= crackle <= 1).
  • rpm (of type {float}, which defaults to 33.): RPM (33 <= rpm <= 78).
  • surface_warping (of type {float}, which defaults to 0.): Surface warping (0 <= surface_warping <= 1).
  • wear (of type {float}, which defaults to 0.): Wear (0 <= wear <= 1).
  • year (of type {float}, which defaults to 1990.): Year (1900 <= year <= 1990).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Wave Terrain Oscillator by Steve Harris <steve(at)plugin.org.uk>.

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:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamAutoSat by Damien Zammit.

Type:

(?id : string?, 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.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZaMaximX2 by Damien Zammit.

Type:

(?id : string?, ?output_ceiling : {float}, ?release : {float},
 ?threshold : {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.
  • output_ceiling (of type {float}, which defaults to 0.): Output Ceiling (-30 <= output_ceiling <= 0).
  • release (of type {float}, which defaults to 3.16227769852): Release (1 <= release <= 100).
  • threshold (of type {float}, which defaults to 0.): Threshold (-30 <= threshold <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamComp by Damien Zammit.

Type:

(?id : string?, ?attack : {float}, ?knee : {float}, ?makeup : {float},
 ?ratio : {float}, ?release : {float}, ?sidechain : {bool}, ?slew : {float},
 ?threshold : {float}, 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.
  • attack (of type {float}, which defaults to 25.0750007629): Attack (0.1 <= attack <= 100).
  • knee (of type {float}, which defaults to 0.): Knee (0 <= knee <= 8).
  • makeup (of type {float}, which defaults to 0.): Makeup (0 <= makeup <= 30).
  • ratio (of type {float}, which defaults to 2.11474251747): Ratio (1 <= ratio <= 20).
  • release (of type {float}, which defaults to 125.75): Release (1 <= release <= 500).
  • sidechain (of type {bool}, which defaults to false): Sidechain (sidechain).
  • slew (of type {float}, which defaults to 1.): Slew (1 <= slew <= 150).
  • threshold (of type {float}, which defaults to 0.): Threshold (-80 <= threshold <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamDelay by Damien Zammit.

Type:

(?id : string?, ?divisor : {int}, ?dry_wet : {float}, ?feedback : {float},
 ?invert : {bool}, ?lpf : {float}, ?output_gain : {float},
 ?sync_bpm : {bool}, ?time : {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.
  • divisor (of type {int}, which defaults to 3): Divisor (1 <= divisor <= 5).
  • dry_wet (of type {float}, which defaults to 0.5): Dry/Wet (0 <= dry_wet <= 1).
  • feedback (of type {float}, which defaults to 0.): Feedback (0 <= feedback <= 1).
  • invert (of type {bool}, which defaults to false): Invert (invert).
  • lpf (of type {float}, which defaults to 5015.): LPF (20 <= lpf <= 20000).
  • output_gain (of type {float}, which defaults to 0.): Output Gain (-60 <= output_gain <= 0).
  • sync_bpm (of type {bool}, which defaults to false): Sync BPM (sync_bpm).
  • time (of type {float}, which defaults to 2000.75): Time (1 <= time <= 8000).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamDynamicEQ by Damien Zammit.

Type:

(?id : string?, ?attack : {float}, ?boost___cut : {bool},
 ?detect_frequency : {float}, ?high_shelf : {bool}, ?knee : {float},
 ?low_shelf : {bool}, ?max_boost_cut : {float}, ?peak : {bool},
 ?ratio : {float}, ?release : {float}, ?sidechain : {bool}, ?slew : {float},
 ?target_frequency : {float}, ?target_width : {float}, ?threshold : {float},
 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.
  • attack (of type {float}, which defaults to 25.0750007629): Attack (0.1 <= attack <= 100).
  • boost___cut (of type {bool}, which defaults to false): Boost / Cut (boost___cut).
  • detect_frequency (of type {float}, which defaults to 106.365921021): Detect Frequency (20 <= detect_frequency <= 16000).
  • high_shelf (of type {bool}, which defaults to false): High Shelf (high_shelf).
  • knee (of type {float}, which defaults to 0.): Knee (0 <= knee <= 8).
  • low_shelf (of type {bool}, which defaults to false): Low Shelf (low_shelf).
  • max_boost_cut (of type {float}, which defaults to 10.): Max Boost/Cut (0 <= max_boost_cut <= 10).
  • peak (of type {bool}, which defaults to false): Peak (peak).
  • ratio (of type {float}, which defaults to 1.49534881115): Ratio (1 <= ratio <= 5).
  • release (of type {float}, which defaults to 125.75): Release (1 <= release <= 500).
  • sidechain (of type {bool}, which defaults to false): Sidechain (sidechain).
  • slew (of type {float}, which defaults to 1.): Slew (1 <= slew <= 150).
  • target_frequency (of type {float}, which defaults to 106.365921021): Target Frequency (20 <= target_frequency <= 16000).
  • target_width (of type {float}, which defaults to 1.): Target width (1 <= target_width <= 5).
  • threshold (of type {float}, which defaults to 0.): Threshold (-80 <= threshold <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamEQ2 by Damien Zammit.

Type:

(?id : string?, ?bandwidth_1 : {float}, ?bandwidth_2 : {float},
 ?boost_cut_1 : {float}, ?boost_cut_2 : {float}, ?boost_cut_h : {float},
 ?boost_cut_l : {float}, ?frequency_1 : {float}, ?frequency_2 : {float},
 ?frequency_h : {float}, ?frequency_l : {float}, ?master_gain : {float},
 ?peaks_on : {bool}, 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.
  • bandwidth_1 (of type {float}, which defaults to 1.): Bandwidth 1 (0.1 <= bandwidth_1 <= 6).
  • bandwidth_2 (of type {float}, which defaults to 1.): Bandwidth 2 (0.1 <= bandwidth_2 <= 6).
  • boost_cut_1 (of type {float}, which defaults to 0.): Boost/Cut 1 (-50 <= boost_cut_1 <= 20).
  • boost_cut_2 (of type {float}, which defaults to 0.): Boost/Cut 2 (-50 <= boost_cut_2 <= 20).
  • boost_cut_h (of type {float}, which defaults to 0.): Boost/Cut H (-50 <= boost_cut_h <= 20).
  • boost_cut_l (of type {float}, which defaults to 0.): Boost/Cut L (-50 <= boost_cut_l <= 20).
  • frequency_1 (of type {float}, which defaults to 102.873733521): Frequency 1 (20 <= frequency_1 <= 14000).
  • frequency_2 (of type {float}, which defaults to 102.873733521): Frequency 2 (20 <= frequency_2 <= 14000).
  • frequency_h (of type {float}, which defaults to 529.150268555): Frequency H (20 <= frequency_h <= 14000).
  • frequency_l (of type {float}, which defaults to 102.873733521): Frequency L (20 <= frequency_l <= 14000).
  • master_gain (of type {float}, which defaults to 0.): Master Gain (-12 <= master_gain <= 12).
  • peaks_on (of type {bool}, which defaults to false): Peaks ON (peaks_on).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamGate by Damien Zammit.

Type:

(?id : string?, ?attack : {float}, ?makeup : {float},
 ?max_gate_close : {float}, ?mode_open_shut : {bool}, ?release : {float},
 ?sidechain : {bool}, ?threshold : {float}, 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.
  • attack (of type {float}, which defaults to 125.074996948): Attack (0.1 <= attack <= 500).
  • makeup (of type {float}, which defaults to 0.): Makeup (-30 <= makeup <= 30).
  • max_gate_close (of type {float}, which defaults to -50.): Max gate close (-50 <= max_gate_close <= 0).
  • mode_open_shut (of type {bool}, which defaults to false): Mode open/shut (mode_open_shut).
  • release (of type {float}, which defaults to 100.): Release (0.1 <= release <= 500).
  • sidechain (of type {bool}, which defaults to false): Sidechain (sidechain).
  • threshold (of type {float}, which defaults to -60.): Threshold (-60 <= threshold <= 0).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamGEQ31 by Damien Zammit.

Type:

(?id : string?, ?_10032hz : {float}, ?_100hz : {float}, ?_1257hz : {float},
 ?_12662hz : {float}, ?_126hz : {float}, ?_1584hz : {float},
 ?_158hz : {float}, ?_16081hz : {float}, ?_1997hz : {float},
 ?_200hz : {float}, ?_20801hz : {float}, ?_2514hz : {float},
 ?_251hz : {float}, ?_3165hz : {float}, ?_316hz : {float}, ?_32hz : {float},
 ?_3986hz : {float}, ?_398hz : {float}, ?_40hz : {float}, ?_5017hz : {float},
 ?_501hz : {float}, ?_50hz : {float}, ?_6318hz : {float}, ?_631hz : {float},
 ?_63hz : {float}, ?_794hz : {float}, ?_7963hz : {float}, ?_79hz : {float},
 ?_999hz : {float}, ?master_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.
  • _10032hz (of type {float}, which defaults to 0.): 10032Hz (-12 <= _10032hz <= 12).
  • _100hz (of type {float}, which defaults to 0.): 100Hz (-12 <= _100hz <= 12).
  • _1257hz (of type {float}, which defaults to 0.): 1257Hz (-12 <= _1257hz <= 12).
  • _12662hz (of type {float}, which defaults to 0.): 12662Hz (-12 <= _12662hz <= 12).
  • _126hz (of type {float}, which defaults to 0.): 126Hz (-12 <= _126hz <= 12).
  • _1584hz (of type {float}, which defaults to 0.): 1584Hz (-12 <= _1584hz <= 12).
  • _158hz (of type {float}, which defaults to 0.): 158Hz (-12 <= _158hz <= 12).
  • _16081hz (of type {float}, which defaults to 0.): 16081Hz (-12 <= _16081hz <= 12).
  • _1997hz (of type {float}, which defaults to 0.): 1997Hz (-12 <= _1997hz <= 12).
  • _200hz (of type {float}, which defaults to 0.): 200Hz (-12 <= _200hz <= 12).
  • _20801hz (of type {float}, which defaults to 0.): 20801Hz (-12 <= _20801hz <= 12).
  • _2514hz (of type {float}, which defaults to 0.): 2514Hz (-12 <= _2514hz <= 12).
  • _251hz (of type {float}, which defaults to 0.): 251Hz (-12 <= _251hz <= 12).
  • _3165hz (of type {float}, which defaults to 0.): 3165Hz (-12 <= _3165hz <= 12).
  • _316hz (of type {float}, which defaults to 0.): 316Hz (-12 <= _316hz <= 12).
  • _32hz (of type {float}, which defaults to 0.): 32Hz (-12 <= _32hz <= 12).
  • _3986hz (of type {float}, which defaults to 0.): 3986Hz (-12 <= _3986hz <= 12).
  • _398hz (of type {float}, which defaults to 0.): 398Hz (-12 <= _398hz <= 12).
  • _40hz (of type {float}, which defaults to 0.): 40Hz (-12 <= _40hz <= 12).
  • _5017hz (of type {float}, which defaults to 0.): 5017Hz (-12 <= _5017hz <= 12).
  • _501hz (of type {float}, which defaults to 0.): 501Hz (-12 <= _501hz <= 12).
  • _50hz (of type {float}, which defaults to 0.): 50Hz (-12 <= _50hz <= 12).
  • _6318hz (of type {float}, which defaults to 0.): 6318Hz (-12 <= _6318hz <= 12).
  • _631hz (of type {float}, which defaults to 0.): 631Hz (-12 <= _631hz <= 12).
  • _63hz (of type {float}, which defaults to 0.): 63Hz (-12 <= _63hz <= 12).
  • _794hz (of type {float}, which defaults to 0.): 794Hz (-12 <= _794hz <= 12).
  • _7963hz (of type {float}, which defaults to 0.): 7963Hz (-12 <= _7963hz <= 12).
  • _79hz (of type {float}, which defaults to 0.): 79Hz (-12 <= _79hz <= 12).
  • _999hz (of type {float}, which defaults to 0.): 999Hz (-12 <= _999hz <= 12).
  • master_gain (of type {float}, which defaults to 0.): Master Gain (-30 <= master_gain <= 30).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamGrains by Damien Zammit.

Type:

(?id : string?, ?freeze : {bool}, ?grain_speed : {float}, ?grains : {int},
 ?loop_time : {float}, ?output_gain : {float}, ?play_speed : {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.
  • freeze (of type {bool}, which defaults to false): Freeze (freeze).
  • grain_speed (of type {float}, which defaults to 1.): Grain Speed (0.1 <= grain_speed <= 20).
  • grains (of type {int}, which defaults to 1): Grains (1 <= grains <= 100).
  • loop_time (of type {float}, which defaults to 253.75): Loop time (5 <= loop_time <= 1000).
  • output_gain (of type {float}, which defaults to 0.): Output Gain (-60 <= output_gain <= 0).
  • play_speed (of type {float}, which defaults to 1.): Play Speed (0.1 <= play_speed <= 20).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamPhono by Damien Zammit.

Type:

(?id : string?, ?phono_filter_type : {int},
 ?reproduction_production : {bool}, 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.
  • phono_filter_type (of type {int}, which defaults to 3): Phono Filter Type (0 <= phono_filter_type <= 4).
  • reproduction_production (of type {bool}, which defaults to false): Reproduction/Production (reproduction_production).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZamTube by Damien Zammit.

Type:

(?id : string?, ?bass : {float}, ?input_level : {float},
 ?insane_boost : {bool}, ?mids : {float}, ?tone_stack_model : {int},
 ?treble : {float}, ?tube_drive : {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.
  • bass (of type {float}, which defaults to 5.): Bass (0 <= bass <= 10).
  • input_level (of type {float}, which defaults to 0.): Input level (-30 <= input_level <= 30).
  • insane_boost (of type {bool}, which defaults to false): Insane Boost (insane_boost).
  • mids (of type {float}, which defaults to 5.): Mids (0 <= mids <= 10).
  • tone_stack_model (of type {int}, which defaults to 0): Tone Stack Model (0 <= tone_stack_model <= 24).
  • treble (of type {float}, which defaults to 5.): Treble (0 <= treble <= 10).
  • tube_drive (of type {float}, which defaults to 0.10000000149): Tube Drive (0.1 <= tube_drive <= 11).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZaMultiComp by Damien Zammit.

Type:

(?id : string?, ?attack1 : {float}, ?attack2 : {float}, ?attack3 : {float},
 ?crossover_freq_1 : {float}, ?crossover_freq_2 : {float}, ?knee1 : {float},
 ?knee2 : {float}, ?knee3 : {float}, ?listen_1 : {bool}, ?listen_2 : {bool},
 ?listen_3 : {bool}, ?makeup_1 : {float}, ?makeup_2 : {float},
 ?makeup_3 : {float}, ?master_trim : {float}, ?ratio1 : {float},
 ?ratio2 : {float}, ?ratio3 : {float}, ?release1 : {float},
 ?release2 : {float}, ?release3 : {float}, ?threshold_1 : {float},
 ?threshold_2 : {float}, ?threshold_3 : {float}, ?zamcomp_1_on : {bool},
 ?zamcomp_2_on : {bool}, ?zamcomp_3_on : {bool}, 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.
  • attack1 (of type {float}, which defaults to 25.0750007629): Attack1 (0.1 <= attack1 <= 100).
  • attack2 (of type {float}, which defaults to 25.0750007629): Attack2 (0.1 <= attack2 <= 100).
  • attack3 (of type {float}, which defaults to 25.0750007629): Attack3 (0.1 <= attack3 <= 100).
  • crossover_freq_1 (of type {float}, which defaults to 57.850151062): Crossover freq 1 (20 <= crossover_freq_1 <= 1400).
  • crossover_freq_2 (of type {float}, which defaults to 1400.): Crossover freq 2 (1400 <= crossover_freq_2 <= 14000).
  • knee1 (of type {float}, which defaults to 0.): Knee1 (0 <= knee1 <= 8).
  • knee2 (of type {float}, which defaults to 0.): Knee2 (0 <= knee2 <= 8).
  • knee3 (of type {float}, which defaults to 0.): Knee3 (0 <= knee3 <= 8).
  • listen_1 (of type {bool}, which defaults to false): Listen 1 (listen_1).
  • listen_2 (of type {bool}, which defaults to false): Listen 2 (listen_2).
  • listen_3 (of type {bool}, which defaults to false): Listen 3 (listen_3).
  • makeup_1 (of type {float}, which defaults to 0.): Makeup 1 (0 <= makeup_1 <= 30).
  • makeup_2 (of type {float}, which defaults to 0.): Makeup 2 (0 <= makeup_2 <= 30).
  • makeup_3 (of type {float}, which defaults to 0.): Makeup 3 (0 <= makeup_3 <= 30).
  • master_trim (of type {float}, which defaults to 0.): Master Trim (-12 <= master_trim <= 12).
  • ratio1 (of type {float}, which defaults to 2.11474251747): Ratio1 (1 <= ratio1 <= 20).
  • ratio2 (of type {float}, which defaults to 2.11474251747): Ratio2 (1 <= ratio2 <= 20).
  • ratio3 (of type {float}, which defaults to 2.11474251747): Ratio3 (1 <= ratio3 <= 20).
  • release1 (of type {float}, which defaults to 125.75): Release1 (1 <= release1 <= 500).
  • release2 (of type {float}, which defaults to 125.75): Release2 (1 <= release2 <= 500).
  • release3 (of type {float}, which defaults to 125.75): Release3 (1 <= release3 <= 500).
  • threshold_1 (of type {float}, which defaults to -15.): Threshold 1 (-60 <= threshold_1 <= 0).
  • threshold_2 (of type {float}, which defaults to -15.): Threshold 2 (-60 <= threshold_2 <= 0).
  • threshold_3 (of type {float}, which defaults to -15.): Threshold 3 (-60 <= threshold_3 <= 0).
  • zamcomp_1_on (of type {bool}, which defaults to false): ZamComp 1 ON (zamcomp_1_on).
  • zamcomp_2_on (of type {bool}, which defaults to false): ZamComp 2 ON (zamcomp_2_on).
  • zamcomp_3_on (of type {bool}, which defaults to false): ZamComp 3 ON (zamcomp_3_on).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

ZaMultiCompX2 by Damien Zammit.

Type:

(?id : string?, ?attack1 : {float}, ?attack2 : {float}, ?attack3 : {float},
 ?crossover_freq_1 : {float}, ?crossover_freq_2 : {float},
 ?detection : {bool}, ?knee1 : {float}, ?knee2 : {float}, ?knee3 : {float},
 ?listen_1 : {bool}, ?listen_2 : {bool}, ?listen_3 : {bool},
 ?makeup_1 : {float}, ?makeup_2 : {float}, ?makeup_3 : {float},
 ?master_trim : {float}, ?ratio1 : {float}, ?ratio2 : {float},
 ?ratio3 : {float}, ?release1 : {float}, ?release2 : {float},
 ?release3 : {float}, ?threshold_1 : {float}, ?threshold_2 : {float},
 ?threshold_3 : {float}, ?zamcomp_1_on : {bool}, ?zamcomp_2_on : {bool},
 ?zamcomp_3_on : {bool}, 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.
  • attack1 (of type {float}, which defaults to 25.0750007629): Attack1 (0.1 <= attack1 <= 100).
  • attack2 (of type {float}, which defaults to 25.0750007629): Attack2 (0.1 <= attack2 <= 100).
  • attack3 (of type {float}, which defaults to 25.0750007629): Attack3 (0.1 <= attack3 <= 100).
  • crossover_freq_1 (of type {float}, which defaults to 57.850151062): Crossover freq 1 (20 <= crossover_freq_1 <= 1400).
  • crossover_freq_2 (of type {float}, which defaults to 1400.): Crossover freq 2 (1400 <= crossover_freq_2 <= 14000).
  • detection (of type {bool}, which defaults to true): Detection (MAX/avg) (detection).
  • knee1 (of type {float}, which defaults to 0.): Knee1 (0 <= knee1 <= 8).
  • knee2 (of type {float}, which defaults to 0.): Knee2 (0 <= knee2 <= 8).
  • knee3 (of type {float}, which defaults to 0.): Knee3 (0 <= knee3 <= 8).
  • listen_1 (of type {bool}, which defaults to false): Listen 1 (listen_1).
  • listen_2 (of type {bool}, which defaults to false): Listen 2 (listen_2).
  • listen_3 (of type {bool}, which defaults to false): Listen 3 (listen_3).
  • makeup_1 (of type {float}, which defaults to 0.): Makeup 1 (0 <= makeup_1 <= 30).
  • makeup_2 (of type {float}, which defaults to 0.): Makeup 2 (0 <= makeup_2 <= 30).
  • makeup_3 (of type {float}, which defaults to 0.): Makeup 3 (0 <= makeup_3 <= 30).
  • master_trim (of type {float}, which defaults to 0.): Master Trim (-12 <= master_trim <= 12).
  • ratio1 (of type {float}, which defaults to 2.11474251747): Ratio1 (1 <= ratio1 <= 20).
  • ratio2 (of type {float}, which defaults to 2.11474251747): Ratio2 (1 <= ratio2 <= 20).
  • ratio3 (of type {float}, which defaults to 2.11474251747): Ratio3 (1 <= ratio3 <= 20).
  • release1 (of type {float}, which defaults to 125.75): Release1 (1 <= release1 <= 500).
  • release2 (of type {float}, which defaults to 125.75): Release2 (1 <= release2 <= 500).
  • release3 (of type {float}, which defaults to 125.75): Release3 (1 <= release3 <= 500).
  • threshold_1 (of type {float}, which defaults to -15.): Threshold 1 (-60 <= threshold_1 <= 0).
  • threshold_2 (of type {float}, which defaults to -15.): Threshold 2 (-60 <= threshold_2 <= 0).
  • threshold_3 (of type {float}, which defaults to -15.): Threshold 3 (-60 <= threshold_3 <= 0).
  • zamcomp_1_on (of type {bool}, which defaults to false): ZamComp 1 ON (zamcomp_1_on).
  • zamcomp_2_on (of type {bool}, which defaults to false): ZamComp 2 ON (zamcomp_2_on).
  • zamcomp_3_on (of type {bool}, which defaults to false): ZamComp 3 ON (zamcomp_3_on).
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

z-1 by Steve Harris <steve(at)plugin.org.uk>.

Type:

(?id : string?, 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.
  • (unlabeled) (of type source(audio=pcm('a), 'b))

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

A limiter. This is a compress with tweaked parameters.

Type:

(?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 any media type (pcm, etc...)

Arguments:

  • 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 any media type (pcm, etc...))

Methods:

  • rms (of type () -> float):
  • gain (of type () -> float):
  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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

Type:

(?id : string?, ?register_server_commands : bool,
 [source(audio=pcm('a), ?video=canvas('b), 'c)]) -> source(audio=pcm('a),
?video=canvas('b)) where 'c is any media type (pcm, etc...)

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), ?video=canvas('b), 'c)] where 'c is any media type (pcm, etc...))

Methods:

  • inputs (of type [ { selected : () -> bool, set_selected : (bool) -> unit, set_single : (bool) -> unit, set_volume : (float) -> unit, single : () -> bool, source : source(audio=pcm('C), ?video=canvas('B), 'A), volume : () -> float }] where 'A is any media type (pcm, etc...)):
  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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 any media type (pcm, etc...)

Arguments:

  • (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is any media type (pcm, etc...)): The input source.

Methods:

  • rms (of type () -> float):
  • gain (of type () -> float):
  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

Multiband-compression.

Type:

(source(audio=pcm('a), ?video=canvas('b), 'c)) -> source(audio=pcm('a),
?video=canvas('b)) where 'c is any media type (pcm, etc...)

Arguments:

  • (unlabeled) (of type source(audio=pcm('a), ?video=canvas('b), 'c) where 'c is any media type (pcm, etc...)): The input source.

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.
  • selected (of type () -> source(audio=pcm('B), ?video=canvas('A))?): Currently selected source.

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

Type:

(?rate : string?, ?r : string?, ?size : string?, ?s : string?,
 ?colors : string?, 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)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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: 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 (nofade))
  • c1 (of type int?, which defaults to null): set fade curve type for 1st stream. (default: 0, possible values: 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 (nofade))
  • curve2 (of type int?, which defaults to null): set fade curve type for 2nd stream. (default: 0, possible values: 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 (nofade))
  • c2 (of type int?, which defaults to null): set fade curve type for 2nd stream. (default: 0, possible values: 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 (nofade))
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)
  • (unlabeled) (of type ffmpeg.filter.audio)

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: 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 (nofade))
  • c1 (of type int?, which defaults to null): set fade curve type for 1st stream. (default: 0, possible values: 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 (nofade))
  • curve2 (of type int?, which defaults to null): set fade curve type for 2nd stream. (default: 0, possible values: 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 (nofade))
  • c2 (of type int?, which defaults to null): set fade curve type for 2nd stream. (default: 0, possible values: 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 (nofade))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?, 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 order. (default: 1, possible values: 0 (2nd), 1 (4th), 2 (8th))
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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?, 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 order. (default: 1, possible values: 0 (2nd), 1 (4th), 2 (8th))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

Ffmpeg filter: Remove impulsive noise from input audio.

Type:

(?w : float?, ?o : float?, ?a : float?, ?t : float?, ?b : float?, ?m : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

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

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:

(?w : float?, ?o : float?, ?a : float?, ?t : float?, ?b : float?, ?m : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

Ffmpeg filter: Remove clipping from input audio.

Type:

(?w : float?, ?o : float?, ?a : float?, ?t : float?, ?n : int?, ?m : int?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

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

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:

(?w : float?, ?o : float?, ?a : float?, ?t : float?, ?n : int?, ?m : int?,
 ffmpeg.filter.graph) -> unit

Arguments:

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type () -> unit): Set the filter’s input(s)

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: 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 (nofade))
  • c (of type int?, which defaults to null): set fade curve type. (default: 0, possible values: 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 (nofade))
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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: 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 (nofade))
  • c (of type int?, which defaults to null): set fade curve type. (default: 0, possible values: 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 (nofade))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

Ffmpeg filter: Denoise audio samples using FFT.

Type:

(?nr : float?, ?nf : float?, ?nt : int?, ?bn : string?, ?rf : float?,
 ?tn : bool?, ?tr : bool?, ?om : int?, ffmpeg.filter.graph,
 ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

  • nr (of type float?, which defaults to null): set the noise reduction. (default: 12.)
  • nf (of type float?, which defaults to null): set the noise floor. (default: -50.)
  • nt (of type int?, which defaults to null): set the noise type. (default: 0, possible values: 0 (w), 1 (v), 2 (s), 3 (c))
  • bn (of type string?, which defaults to null): set the custom bands noise
  • rf (of type float?, which defaults to null): set the residual floor. (default: -38.)
  • tn (of type bool?, which defaults to null): track noise. (default: false)
  • tr (of type bool?, which defaults to null): track residual. (default: false)
  • om (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (n))
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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:

(?nr : float?, ?nf : float?, ?nt : int?, ?bn : string?, ?rf : float?,
 ?tn : bool?, ?tr : bool?, ?om : int?, ffmpeg.filter.graph) -> unit

Arguments:

  • nr (of type float?, which defaults to null): set the noise reduction. (default: 12.)
  • nf (of type float?, which defaults to null): set the noise floor. (default: -50.)
  • nt (of type int?, which defaults to null): set the noise type. (default: 0, possible values: 0 (w), 1 (v), 2 (s), 3 (c))
  • bn (of type string?, which defaults to null): set the custom bands noise
  • rf (of type float?, which defaults to null): set the residual floor. (default: -38.)
  • tn (of type bool?, which defaults to null): track noise. (default: false)
  • tr (of type bool?, which defaults to null): track residual. (default: false)
  • om (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (n))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type () -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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), 8 (pts), 16 (time), 32 (timebase), 64 (format), 128 (size), 256 (rate))
  • f (of type int?, which defaults to null): set flags. (default: 1, possible values: 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 8 (pts), 16 (time), 32 (timebase), 64 (format), 128 (size), 256 (rate))
  • 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: 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), 8 (pts), 16 (time), 32 (timebase), 64 (format), 128 (size), 256 (rate))
  • f (of type int?, which defaults to null): set flags. (default: 1, possible values: 1 (queue), 4 (frame_count_in), 2 (frame_count_out), 8 (pts), 16 (time), 32 (timebase), 64 (format), 128 (size), 256 (rate))
  • 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:

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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 coefficients. (default: 1+0i 1-0i)
  • z (of type string?, which defaults to null): set B/numerator/zeros coefficients. (default: 1+0i 1-0i)
  • poles (of type string?, which defaults to null): set A/denominator/poles coefficients. (default: 1+0i 1-0i)
  • p (of type string?, which defaults to null): set A/denominator/poles 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: 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: 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))
  • r (of type int?, which defaults to null): set kind of processing. (default: 1, possible values: 0 (d), 1 (s))
  • 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: 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 coefficients. (default: 1+0i 1-0i)
  • z (of type string?, which defaults to null): set B/numerator/zeros coefficients. (default: 1+0i 1-0i)
  • poles (of type string?, which defaults to null): set A/denominator/poles coefficients. (default: 1+0i 1-0i)
  • p (of type string?, which defaults to null): set A/denominator/poles 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: 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: 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))
  • r (of type int?, which defaults to null): set kind of processing. (default: 1, possible values: 0 (d), 1 (s))
  • 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:

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?, 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: 1, 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: 1, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
  • width (of type float?, which defaults to null): set filter-width. (default: 707.1)
  • w (of type float?, which defaults to null): set filter-width. (default: 707.1)
  • 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
  • c (of type string?, which defaults to null): set channels to filter
  • 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)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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?, 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: 1, 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: 1, possible values: 1 (h), 3 (q), 2 (o), 4 (s), 5 (k))
  • width (of type float?, which defaults to null): set filter-width. (default: 707.1)
  • w (of type float?, which defaults to null): set filter-width. (default: 707.1)
  • 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
  • c (of type string?, which defaults to null): set channels to filter
  • 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)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type () -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type () -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

Ffmpeg filter: Extract an alpha channel as a grayscale image component. This filter has dynamic outputs: returned value is a tuple of audio and video outputs. Total number of outputs is determined at runtime.

Type:

(ffmpeg.filter.graph, ffmpeg.filter.video) ->
[ffmpeg.filter.audio] * [ffmpeg.filter.video]

Arguments:

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

Ffmpeg filter: Extract an alpha channel as a grayscale image component. 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:

(ffmpeg.filter.graph) -> unit

Arguments:

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

Methods:

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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

Type:

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

Arguments:

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

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:

(ffmpeg.filter.graph) -> unit

Arguments:

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video, ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type () -> unit): Set the filter’s input(s)

Ffmpeg filter: Amplify changes between successive video frames.

Type:

(?radius : int?, ?factor : float?, ?threshold : float?, ?tolerance : float?,
 ?low : int?, ?high : int?, ?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 int?, which defaults to null): set low limit for amplification. (default: 65535)
  • high (of type int?, 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 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 : int?, ?high : int?, ?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 int?, which defaults to null): set low limit for amplification. (default: 65535)
  • high (of type int?, 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:

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

Type:

(?s : float?, ?p : int?, ?r : int?, ?o : int?, ?m : float?,
 ffmpeg.filter.graph, ffmpeg.filter.audio) -> ffmpeg.filter.audio

Arguments:

  • s (of type float?, which defaults to null): set denoising strength. (default: 1e-05)
  • p (of type int?, which defaults to null): set patch duration. (default: 2000)
  • r (of type int?, which defaults to null): set research duration. (default: 6000)
  • o (of type int?, which defaults to null): set output mode. (default: 1, possible values: 0 (i), 1 (o), 2 (n))
  • 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: 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:

(?s : float?, ?p : int?, ?r : int?, ?o : int?, ?m : float?,
 ffmpeg.filter.graph) -> unit

Arguments:

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type () -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type unit): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type () -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

Ffmpeg filter: Resample audio data.

Type:

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

Arguments:

  • sample_rate (of type int?, which defaults to null): Default: 0
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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

Arguments:

  • sample_rate (of type int?, which defaults to null): Default: 0
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

Type:

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

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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 (QP_TABLE_PROPERTIES), 17 (QP_TABLE_DATA), 18 (S12M_TIMECOD), 19 (DYNAMIC_HDR_PLUS), 20 (REGIONS_OF_INTEREST))
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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 (QP_TABLE_PROPERTIES), 17 (QP_TABLE_DATA), 18 (S12M_TIMECOD), 19 (DYNAMIC_HDR_PLUS), 20 (REGIONS_OF_INTEREST))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

Ffmpeg filter: Audio Soft Clipper.

Type:

(?type : int?, ?param : float?, 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: 0 (tanh), 1 (atan), 2 (cubic), 3 (exp), 4 (alg), 5 (quintic), 6 (sin))
  • param (of type float?, which defaults to null): set softclip parameter. (default: 1.)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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?, ?param : float?, ffmpeg.filter.graph) -> unit

Arguments:

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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): recalculate stats after this many frames. (default: 0)
  • measure_perchannel (of type int?, which defaults to null): only measure_perchannel these per-channel statistics. (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), 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): only measure_perchannel these overall statistics. (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), 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: 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): recalculate stats after this many frames. (default: 0)
  • measure_perchannel (of type int?, which defaults to null): only measure_perchannel these per-channel statistics. (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), 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): only measure_perchannel these overall statistics. (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), 262144 (Number_of_samples), 524288 (Number_of_NaNs), 1048576 (Number_of_Infs), 2097152 (Number_of_denormals))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type [ffmpeg.filter.audio] * [ffmpeg.filter.video]): Filter output(s)
  • set_input (of type ([ffmpeg.filter.audio], [ffmpeg.filter.video]) -> unit): Set the filter’s input(s)

Ffmpeg filter: Boost subwoofer frequencies.

Type:

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

Arguments:

  • dry (of type float?, which defaults to null): set dry gain. (default: 0.5)
  • wet (of type float?, which defaults to null): set wet gain. (default: 0.8)
  • decay (of type float?, which defaults to null): set decay. (default: 0.7)
  • feedback (of type float?, which defaults to null): set feedback. (default: 0.5)
  • 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.)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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?, ?decay : float?, ?feedback : float?,
 ?cutoff : float?, ?slope : float?, ?delay : float?, ffmpeg.filter.graph) ->
unit

Arguments:

  • dry (of type float?, which defaults to null): set dry gain. (default: 0.5)
  • wet (of type float?, which defaults to null): set wet gain. (default: 0.8)
  • decay (of type float?, which defaults to null): set decay. (default: 0.7)
  • feedback (of type float?, which defaults to null): set feedback. (default: 0.5)
  • 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.)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

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

Methods:

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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 alghorithm. (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: 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 alghorithm. (default: 0, possible values: 0 (slow), 1 (fast))
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio, ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?,
 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 band-width. (default: 0.5)
  • w (of type float?, which defaults to null): set band-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
  • c (of type string?, which defaults to null): set channels to filter
  • normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • n (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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?,
 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 band-width. (default: 0.5)
  • w (of type float?, which defaults to null): set band-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
  • c (of type string?, which defaults to null): set channels to filter
  • normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • n (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?,
 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 band-width. (default: 0.5)
  • w (of type float?, which defaults to null): set band-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
  • c (of type string?, which defaults to null): set channels to filter
  • normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • n (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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?,
 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 band-width. (default: 0.5)
  • w (of type float?, which defaults to null): set band-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
  • c (of type string?, which defaults to null): set channels to filter
  • normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • n (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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?, ?mix : float?,
 ?m : float?, ?channels : string?, ?c : string?, ?normalize : bool?,
 ?n : bool?, 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 shelf transition steep. (default: 0.5)
  • w (of type float?, which defaults to null): set shelf transition steep. (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.)
  • 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
  • c (of type string?, which defaults to null): set channels to filter
  • normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • n (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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?, ?mix : float?,
 ?m : float?, ?channels : string?, ?c : string?, ?normalize : bool?,
 ?n : bool?, 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 shelf transition steep. (default: 0.5)
  • w (of type float?, which defaults to null): set shelf transition steep. (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.)
  • 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
  • c (of type string?, which defaults to null): set channels to filter
  • normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • n (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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?, 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
  • c (of type string?, which defaults to null): set channels to filter
  • normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • n (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • (unlabeled) (of type ffmpeg.filter.graph)
  • (unlabeled) (of type ffmpeg.filter.audio)

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?, 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
  • c (of type string?, which defaults to null): set channels to filter
  • normalize (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • n (of type bool?, which defaults to null): normalize coefficients. (default: false)
  • (unlabeled) (of type ffmpeg.filter.graph)

Methods:

  • 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.
  • output (of type ffmpeg.filter.audio): Filter output(s)
  • set_input (of type (ffmpeg.filter.audio) -> unit): Set the filter’s input(s)

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

  • 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.
  • output (of type ffmpeg.filter.video): Filter output(s)
  • set_input (of type (ffmpeg.filter.video) -> unit): Set the filter’s input(s)

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

Type:

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

Arguments:

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

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
  • on_get_ready (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.
  • on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
  • on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
  • on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
  • remaining (of type () -> float): Estimation of remaining time in the current track.
  • elapsed (of type () -> float): Elapsed time in the current track.
  • duration (of type () -> float): Estimation of the duration of the current track.
  • self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
  • log (of type {level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from 1 to 5.
  • 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.
  • 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.
  • seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
  • skip (of type () -> unit): Skip to the next track.
  • fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
  • time (of type () -> float): Get a source’s time, based on its assigned clock.

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

Type:

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

Arguments:

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

Methods:

  • id (of type () -> string): Identifier of the source.
  • 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.
  • buffered (of type () -> [string * float]): Length of buffered data.
  • last_metadata (of type () -> [string * string]?): Return the last metadata from the source.
  • on_metadata