Liquidsoap scripting language reference

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

• Bool
• Configuration
• File
• Getter
• Interaction
• Internet
• Liquidsoap
• List
• Math
• Metadata
• Programming
• Settings
• Source / Audio processing
• Source / Conversion
• Source / FFmpeg filter
• Source / Fade
• Source / Input
• Source / Liquidsoap
• Source / MIDI processing
• Source / Output
• Source / Sound synthesis
• Source / Track processing
• Source / Video processing
• Source / Visualization
• String
• System
• Time
• Uncategorized

Bool

Configuration

File

Getter

Interaction

add_skip_command

Add a skip function 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.

audioscrobbler.submit.full

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

Type:

(user : string, password : string, ?host : string, ?port : int,
 ?source : string, ?length : bool, ?delay : float, ?force : bool,
 source(audio='a, video='b, midi='c)) -> source(audio='a, video='b, midi='c)

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(audio='a, video='b, midi='c))

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

lastfm.nowplaying

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

Type:

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

Arguments:

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

lastfm.submit

Submit metadata to lastfm.fm using the audioscrobbler protocol.

Type:

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

Arguments:

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

lastfm.submit.full

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

Type:

(user : string, password : string, ?source : string, ?length : bool,
 ?delay : float, ?force : bool, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)

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(audio='a, video='b, midi='c))

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

librefm.nowplaying

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

Type:

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

Arguments:

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

librefm.submit

Submit metadata to libre.fm using the audioscrobbler protocol.

Type:

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

Arguments:

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

librefm.submit.full

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

Type:

(user : string, password : string, ?source : string, ?length : bool,
 ?delay : float, ?force : bool, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)

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(audio='a, video='b, midi='c))

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

Internet

harbor.http.middleware.cors

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 : ('b) -> unit,
   multipart_form : (?boundary : string?,
                     [
                      {
                        attributes : [string * string],
                        contents : {string},
                        headers : [string * string],
                        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 : ('b) -> unit,
     multipart_form : (?boundary : string?,
                       [
                        {
                          attributes : [string * string],
                          contents : {string},
                          headers : [string * string],
                          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.

server.harbor

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

Type:

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

Arguments:

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

Liquidsoap

List

Math

Metadata

Programming

Settings

Source / Audio processing

accelerate

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

Type:

(?id : string?, ?randomize : {float}, ?ratio : {float}, source(audio='a,
 video='b, midi='c)) -> source(audio='a, video='b, midi='c)

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(audio='a, video='b, midi='c))

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

helium

Increases the pitch, making voices sound like on helium.

Type:

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

Arguments:

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

ladspa.alias

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

Type:

(?id : string?, ?aliasing_level : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.allpass_c

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.allpass_l

Allpass delay line, linear interpolation by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {float}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.allpass_n

Allpass delay line, noninterpolating by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {float}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.amp

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

Type:

(?id : string?, ?amps_gain : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.amp_mono

Mono Amplifier by Richard Furse (LADSPA example plugins).

Type:

(?id : string?, ?gain : {float}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.amp_stereo

Stereo Amplifier by Richard Furse (LADSPA example plugins).

Type:

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

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(stereo), video='a, midi='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.
• 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.

ladspa.ampitchshift

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

Type:

(?id : string?, ?buffer_size : {int}, ?pitch_shift : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.artificiallatency

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

Type:

(?id : string?, ?delay : {float}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.autophaser

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), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.bandpass_a_iir

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

Type:

(?id : string?, ?bandwidth : {float}, ?center_frequency : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.bandpass_iir

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

Type:

(?id : string?, ?bandwidth : {float}, ?center_frequency : {float},
 ?stages : {int}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.bodeshifter

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

Type:

(?id : string?, ?frequency_shift : {float}, source(audio=pcm(mono), video='a,
 midi='b)) -> source(audio=pcm(stereo), video='c, midi='d)

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(mono), video='a, midi='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.
• 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.

ladspa.butthigh_iir

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

Type:

(?id : string?, ?cutoff_frequency : {float}, ?resonance : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.buttlow_iir

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

Type:

(?id : string?, ?cutoff_frequency : {float}, ?resonance : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.bwxover_iir

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

Type:

(?id : string?, ?cutoff_frequency : {float}, ?resonance : {float},
 source(audio=pcm(mono), video='a, midi='b)) -> source(audio=pcm(stereo),
video='c, midi='d)

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(mono), video='a, midi='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.
• 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.

ladspa.chebstortion

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

Type:

(?id : string?, ?distortion : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.comb

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

Type:

(?id : string?, ?band_separation : {float}, ?feedback : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.comb_c

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.comb_l

Comb delay line, linear interpolation by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {float}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.comb_n

Comb delay line, noninterpolating by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, delay_time : {float},
 max_delay : {float}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.combsplitter

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

Type:

(?id : string?, ?band_separation : {float}, source(audio=pcm(mono), video='a,
 midi='b)) -> source(audio=pcm(stereo), video='c, midi='d)

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(mono), video='a, midi='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.
• 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.

ladspa.const

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

Type:

(?id : string?, ?signal_amplitude : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.crossoverdist

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

Type:

(?id : string?, ?crossover_amplitude : {float}, ?smoothing : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.dcremove

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

Type:

(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

Arguments:

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

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

ladspa.decay

Exponential signal decay by Andy Wingo .

Type:

(?id : string?, decay_time : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.decimator

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

Type:

(?id : string?, ?bit_depth : {float}, ?sample_rate : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.declip

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

Type:

(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

Arguments:

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

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

ladspa.delay_5s

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

Type:

(?id : string?, ?delay : {float}, ?dry_wet_balance : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.delay_c

Simple delay line, cubic spline interpolation by Andy Wingo .

Type:

(?id : string?, delay_time : {float}, max_delay : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.delay_l

Simple delay line, linear interpolation by Andy Wingo .

Type:

(?id : string?, delay_time : {float}, max_delay : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.delay_n

Simple delay line, noninterpolating by Andy Wingo .

Type:

(?id : string?, delay_time : {float}, max_delay : {float},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.delayorama

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), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.diode

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

Type:

(?id : string?, ?mode : {float}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.divider

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

Type:

(?id : string?, ?denominator : {int}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.dj_eq

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(stereo), video='a, midi='b)) -> source(audio=pcm(stereo),
video='c, midi='d)

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(stereo), video='a, midi='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.
• 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.

ladspa.dj_eq_mono

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), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.djflanger

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), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.dysoncompress

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.faddelay

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

Type:

(?id : string?, ?delay : {float}, ?feedback : {float}, source(audio=pcm('a),
 video='b, midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.fastlookaheadlimiter

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(stereo), video='a, midi='b)) ->
source(audio=pcm(stereo), video='c, midi='d)

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(stereo), video='a, midi='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.
• 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.

ladspa.flanger

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),
 video='b, midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.fmosc

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

Type:

(?id : string?, ?waveform : {int}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.foldover

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

Type:

(?id : string?, ?drive : {float}, ?skew : {float}, source(audio=pcm('a),
 video='b, midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.fourbyfourpole

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), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.foverdrive

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

Type:

(?id : string?, ?drive_level : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.freqtracker

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

Type:

(?id : string?, ?tracking_speed : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.gate

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), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.giantflange

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), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.gong

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), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.gongbeater

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.gsm

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.gverb

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(mono), video='a, midi='b)) -> source(audio=pcm(stereo),
video='c, midi='d)

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(mono), video='a, midi='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.
• 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.

ladspa.hardlimiter

Hard Limiter by Marcus Andersson.

Type:

(?id : string?, ?db_limit : {float}, ?residue_level : {float},
 ?wet_level : {float}, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.harmonicgen

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.hermesfilter

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.highpass_iir

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

Type:

(?id : string?, ?cutoff_frequency : {float}, ?stages : {int},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.hilbert

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

Type:

(?id : string?, source(audio=pcm(mono), video='a, midi='b)) ->
source(audio=pcm(stereo), video='c, midi='d)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=pcm(mono), video='a, midi='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.
• 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.

ladspa.hpf

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

Type:

(?id : string?, ?cutoff_frequency : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.imp

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.inv

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

Type:

(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

Arguments:

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

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

ladspa.karaoke

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

Type:

(?id : string?, ?vocal_volume : {float}, source(audio=pcm(stereo), video='a,
 midi='b)) -> source(audio=pcm(stereo), video='c, midi='d)

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(stereo), video='a, midi='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.
• 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.

ladspa.lcrdelay

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(stereo), video='a, midi='b)) -> source(audio=pcm(stereo),
video='c, midi='d)

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(stereo), video='a, midi='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.
• 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.

ladspa.lfophaser

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), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.lowpass_iir

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

Type:

(?id : string?, ?cutoff_frequency : {float}, ?stages : {int},
 source(audio=pcm('a), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))

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

ladspa.lpf

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

Type:

(?id : string?, ?cutoff_frequency : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.lsfilter

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.matrixmsst

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

Type:

(?id : string?, ?width : {float}, source(audio=pcm(stereo), video='a,
 midi='b)) -> source(audio=pcm(stereo), video='c, midi='d)

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(stereo), video='a, midi='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.
• 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.

ladspa.matrixspatialiser

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

Type:

(?id : string?, ?width : {int}, source(audio=pcm(stereo), video='a, midi='b)) ->
source(audio=pcm(stereo), video='c, midi='d)

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(stereo), video='a, midi='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.
• 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.

ladspa.matrixstms

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

Type:

(?id : string?, source(audio=pcm(stereo), video='a, midi='b)) ->
source(audio=pcm(stereo), video='c, midi='d)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=pcm(stereo), video='a, midi='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.
• 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.

ladspa.mbeq

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), video='b, midi='c)) ->
source(audio=pcm('d), video='e, midi='f)

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), video='b, midi='c))

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

ladspa.moddelay

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

Type:

(?id : string?, ?base_delay : {float}, source(audio=pcm(stereo), video='a,
 midi='b)) -> source(audio=pcm(mono), video='c, midi='d)

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(stereo), video='a, midi='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.
• 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.

ladspa.multivoicechorus

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), video='b, midi='c)) -> source(audio=pcm('d), video='e,
midi='f)

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), video='b, midi='c))