pedalboard<
The following documentation lists all of the available types of Plugin.
-
-class pedalboard.AudioProcessorParameter(plugin: ExternalPlugin, parameter_name: str, search_steps: int = 1000)#
+class pedalboard.AudioProcessorParameter(plugin: ExternalPlugin, parameter_name: str, search_steps: int = 1000)#
A wrapper around various different parameters exposed by
VST3Plugin or AudioUnitPlugin instances.
AudioProcessorParameter objects are rarely used directly,
@@ -271,7 +271,7 @@
The pedalboard<
-
-property label: Optional[str]#
+property label: Optional[str]#
The units used by this parameter (Hz, dB, etc).
May be None if the plugin does not expose units for this
parameter or if automatic unit detection fails.
@@ -279,7 +279,7 @@ The pedalboard<
-
-property units: Optional[str]#
+property units: Optional[str]#
Alias for “label” - the units used by this parameter (Hz, dB, etc).
May be None if the plugin does not expose units for this
parameter or if automatic unit detection fails.
@@ -294,17 +294,17 @@ The pedalboard<
Don’t use this directly; use one of pedalboard.VST3Plugin or pedalboard.AudioUnitPlugin instead.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
-
-__call__(midi_messages: object, duration: float, sample_rate: float, num_channels: int = 2, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]
+__call__(midi_messages: object, duration: float, sample_rate: float, num_channels: int = 2, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]
Run an audio or MIDI buffer through this plugin, returning audio. Alias for process().
-
-process(midi_messages: object, duration: float, sample_rate: float, num_channels: int = 2, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(midi_messages: object, duration: float, sample_rate: float, num_channels: int = 2, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]
Pass a buffer of audio (as a 32- or 64-bit NumPy array) or a list of
MIDI messages to this plugin, returning audio.
(If calling this multiple times with multiple effect plugins, consider
@@ -380,21 +380,21 @@
The pedalboard<
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -402,7 +402,7 @@ The pedalboard<
-
-class pedalboard.Pedalboard(plugins: Optional[List[Plugin]] = None)#
+class pedalboard.Pedalboard(plugins: Optional[List[Plugin]] = None)#
A container for a series of Plugin objects, to use for processing audio, like a
guitar pedalboard.
Pedalboard objects act like regular Python List objects,
@@ -421,39 +421,39 @@
The pedalboard<
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-append(plugin: Plugin) None#
+append(plugin: Plugin) None#
Append a plugin to the end of this container.
-
-insert(index: int, plugin: Plugin) None#
+insert(index: int, plugin: Plugin) None#
Insert a plugin at the specified index.
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -471,11 +471,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -486,13 +481,13 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -500,7 +495,7 @@ The pedalboard<
-
-pedalboard.load_plugin(path_to_plugin_file: str, parameter_values: Dict[str, Union[str, int, float, bool]] = {}, plugin_name: Optional[str] = None, initialization_timeout: float = 10.0) ExternalPlugin#
+pedalboard.load_plugin(path_to_plugin_file: str, parameter_values: Dict[str, Union[str, int, float, bool]] = {}, plugin_name: Optional[str] = None, initialization_timeout: float = 10.0) ExternalPlugin#
Load an audio plugin.
- Two plugin formats are supported:
@@ -544,7 +539,7 @@ The pedalboard<
-
-class pedalboard.AudioUnitPlugin(path_to_plugin_file: str, parameter_values: Optional[object] = None, plugin_name: Optional[str] = None, initialization_timeout: float = 10.0)#
+class pedalboard.AudioUnitPlugin(path_to_plugin_file: str, parameter_values: Optional[object] = None, plugin_name: Optional[str] = None, initialization_timeout: float = 10.0)#
A wrapper around third-party, audio effect or instrument
plugins in Apple’s Audio Unit
format.
@@ -567,24 +562,24 @@ The pedalboard<
Support for loading AUv3 plugins ( .appex bundles) introduced in v0.9.5.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
-
-__call__(midi_messages: object, duration: float, sample_rate: float, num_channels: int = 2, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]
+__call__(midi_messages: object, duration: float, sample_rate: float, num_channels: int = 2, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]
Run an audio or MIDI buffer through this plugin, returning audio. Alias for process().
-
-static get_plugin_names_for_file(filename: str) list[str]#
+static get_plugin_names_for_file(filename: str) list[str]#
Return a list of plugin names contained within a given Audio Unit bundle (i.e.: a .component or .appex file). If the provided file cannot be scanned, an ImportError will be raised.
Note that most Audio Units have a single plugin inside, but this method can be useful to determine if multiple plugins are present in one bundle, and if so, what their names are.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
-
-process(midi_messages: object, duration: float, sample_rate: float, num_channels: int = 2, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]
+process(midi_messages: object, duration: float, sample_rate: float, num_channels: int = 2, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]
Pass a buffer of audio (as a 32- or 64-bit NumPy array) or a list of
MIDI messages to this plugin, returning audio.
(If calling this multiple times with multiple effect plugins, consider
@@ -660,7 +655,7 @@
The pedalboard<
-
-show_editor(close_event: Optional[Event] = None) None#
+show_editor(close_event: Optional[Event] = None) None#
Show the UI of this plugin as a native window.
This method may only be called on the main thread, and will block
the main thread until any of the following things happens:
@@ -669,8 +664,8 @@ The pedalboard<
the window is closed by clicking the close button
the window is closed by pressing the appropriate (OS-specific) keyboard shortcut
a KeyboardInterrupt (Ctrl-C) is sent to the program
the threading.Event.set() method is called (by another thread)
-on a provided threading.Event object
the threading.Event.set() method is called (by another thread)
+on a provided threading.Event object
An example of how to programmatically close an editor window:
@@ -696,57 +691,57 @@ The pedalboard<
-
-property category: str#
+property category: str#
A category that this plugin falls into, such as “Dynamics”, “Reverbs”, etc.
Introduced in v0.9.4.
-
-property descriptive_name: str#
+property descriptive_name: str#
A more descriptive name for this plugin. This may be the same as the ‘name’ field, but some plugins may provide an alternative name.
Introduced in v0.9.4.
+property has_shared_container: bool#
True iff this plugin is part of a multi-plugin container.
Introduced in v0.9.4.
-
-property identifier: str#
+property identifier: str#
A string that can be saved and used to uniquely identify this plugin (and version) again.
Introduced in v0.9.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin identifies itself as an instrument (generator, synthesizer, etc) plugin.
Introduced in v0.9.4.
-
-property manufacturer_name: str#
+property manufacturer_name: str#
The name of the manufacturer of this plugin, as reported by the plugin itself.
Introduced in v0.9.4.
-
-property raw_state: bytes#
-A bytes object representing the plugin’s internal state.
-For the Audio Unit format, this is usually a binary property list that can be decoded or encoded with the built-in plistlib package.
+property raw_state: bytes#
+A bytes object representing the plugin’s internal state.
+For the Audio Unit format, this is usually a binary property list that can be decoded or encoded with the built-in plistlib package.
Warning
This property can be set to change the plugin’s internal state, but providing invalid data may cause the plugin to crash, taking the entire Python process down with it.
@@ -755,21 +750,21 @@ The pedalboard<
-
-property version: str#
+property version: str#
The version string for this plugin, as reported by the plugin itself.
Introduced in v0.9.4.
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -777,38 +772,38 @@ The pedalboard<
-
-class pedalboard.Bitcrush(bit_depth: float = 8)#
+class pedalboard.Bitcrush(bit_depth: float = 8)#
A plugin that reduces the signal to a given bit depth, giving the audio a lo-fi, digitized sound. Floating-point bit depths are supported.
Bitcrushing changes the amount of “vertical” resolution used for an audio signal (i.e.: how many unique values could be used to represent each sample). For an effect that changes the “horizontal” resolution (i.e.: how many samples are available per second), see pedalboard.Resample.
-
-property bit_depth: float#
+property bit_depth: float#
The bit depth to quantize the signal to. Must be between 0 and 32 bits. May be an integer, decimal, or floating-point value. Each audio sample will be quantized onto 2 ** bit_depth values.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -826,11 +821,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -841,7 +831,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -849,43 +839,43 @@ The pedalboard<
-
-class pedalboard.Chain(plugins: list[Plugin])#
+class pedalboard.Chain(plugins: list[Plugin])#
Run zero or more plugins as a plugin. Useful when used with the Mix plugin.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-append(plugin: Plugin) None#
+append(plugin: Plugin) None#
Append a plugin to the end of this container.
-
-insert(index: int, plugin: Plugin) None#
+insert(index: int, plugin: Plugin) None#
Insert a plugin at the specified index.
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -903,11 +893,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -918,13 +903,13 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -932,39 +917,39 @@ The pedalboard<
-
-class pedalboard.Chorus(rate_hz: float = 1.0, depth: float = 0.25, centre_delay_ms: float = 7.0, feedback: float = 0.0, mix: float = 0.5)#
+class pedalboard.Chorus(rate_hz: float = 1.0, depth: float = 0.25, centre_delay_ms: float = 7.0, feedback: float = 0.0, mix: float = 0.5)#
A basic chorus effect.
This audio effect can be controlled via the speed and depth of the LFO controlling the frequency response, a mix control, a feedback control, and the centre delay of the modulation.
Note: To get classic chorus sounds try to use a centre delay time around 7-8 ms with a low feeback volume and a low depth. This effect can also be used as a flanger with a lower centre delay time and a lot of feedback, and as a vibrato effect if the mix value is 1.
-
-property rate_hz: float#
+property rate_hz: float#
The speed of the chorus effect’s low-frequency oscillator (LFO), in Hertz. This value must be between 0 Hz and 100 Hz.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -982,11 +967,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -997,7 +977,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1005,31 +985,31 @@ The pedalboard<
-
-class pedalboard.Clipping(threshold_db: float = -6.0)#
+class pedalboard.Clipping(threshold_db: float = -6.0)#
A distortion plugin that adds hard distortion to the signal by clipping the signal at the provided threshold (in decibels).
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1047,11 +1027,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1062,7 +1037,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1070,32 +1045,32 @@ The pedalboard<
-
-class pedalboard.Compressor(threshold_db: float = 0, ratio: float = 1, attack_ms: float = 1.0, release_ms: float = 100)#
+class pedalboard.Compressor(threshold_db: float = 0, ratio: float = 1, attack_ms: float = 1.0, release_ms: float = 100)#
A dynamic range compressor, used to reduce the volume of loud sounds and “compress” the loudness of the signal.
For a lossy compression algorithm that introduces noise or artifacts, see pedalboard.MP3Compressor or pedalboard.GSMCompressor.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1113,11 +1088,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1128,7 +1098,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1142,27 +1112,27 @@ The pedalboard<
Support for passing NumPy arrays as impulse responses introduced in v0.9.10.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1180,11 +1150,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1195,7 +1160,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1203,31 +1168,31 @@ The pedalboard<
-
-class pedalboard.Delay(delay_seconds: float = 0.5, feedback: float = 0.0, mix: float = 0.5)#
+class pedalboard.Delay(delay_seconds: float = 0.5, feedback: float = 0.0, mix: float = 0.5)#
A digital delay plugin with controllable delay time, feedback percentage, and dry/wet mix.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1245,11 +1210,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1260,7 +1220,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1268,32 +1228,32 @@ The pedalboard<
-
-class pedalboard.Distortion(drive_db: float = 25)#
+class pedalboard.Distortion(drive_db: float = 25)#
A distortion effect, which applies a non-linear (tanh, or hyperbolic tangent) waveshaping function to apply harmonically pleasing distortion to a signal.
This plugin produces a signal that is roughly equivalent to running: def distortion(x): return tanh(x * db_to_gain(drive_db))
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1311,11 +1271,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1326,7 +1281,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1338,27 +1293,27 @@ The pedalboard<
An audio degradation/compression plugin that applies the GSM “Full Rate” compression algorithm to emulate the sound of a 2G cellular phone connection. This plugin internally resamples the input audio to a fixed sample rate of 8kHz (required by the GSM Full Rate codec), although the quality of the resampling algorithm can be specified.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1376,11 +1331,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1391,7 +1341,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1399,32 +1349,32 @@ The pedalboard<
-
-class pedalboard.Gain(gain_db: float = 1.0)#
+class pedalboard.Gain(gain_db: float = 1.0)#
A gain plugin that increases or decreases the volume of a signal by amplifying or attenuating it by the provided value (in decibels). No distortion or other effects are applied.
Think of this as a volume control.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1442,11 +1392,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1457,7 +1402,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1465,31 +1410,31 @@ The pedalboard<
-
-class pedalboard.HighShelfFilter(cutoff_frequency_hz: float = 440, gain_db: float = 0.0, q: float = 0.7071067690849304)#
+class pedalboard.HighShelfFilter(cutoff_frequency_hz: float = 440, gain_db: float = 0.0, q: float = 0.7071067690849304)#
A high shelf filter plugin with variable Q and gain, as would be used in an equalizer. Frequencies above the cutoff frequency will be boosted (or cut) by the provided gain (in decibels).
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1507,11 +1452,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1522,7 +1462,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1530,31 +1470,31 @@ The pedalboard<
-
-class pedalboard.HighpassFilter(cutoff_frequency_hz: float = 50)#
+class pedalboard.HighpassFilter(cutoff_frequency_hz: float = 50)#
Apply a first-order high-pass filter with a roll-off of 6dB/octave. The cutoff frequency will be attenuated by -3dB (i.e.: \(\frac{1}{\sqrt{2}}\) as loud, expressed as a gain factor) and lower frequencies will be attenuated by a further 6dB per octave.)
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1572,11 +1512,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1587,7 +1522,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1599,27 +1534,27 @@ The pedalboard<
An abstract class that implements various kinds of infinite impulse response (IIR) filter designs. This should not be used directly; use HighShelfFilter, LowShelfFilter, or PeakFilter directly instead.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1637,11 +1572,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1652,7 +1582,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1665,27 +1595,27 @@ The pedalboard<
Inverting a signal may be useful to cancel out signals in many cases; for instance, Invert can be used with the Mix plugin to remove the original signal from an effects chain that contains multiple signals.
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1703,11 +1633,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).
Note
The process() method can also be used via __call__();
@@ -1718,7 +1643,7 @@
The pedalboard<
-
-reset() None#
+reset() None#
Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.
@@ -1726,7 +1651,7 @@ The pedalboard<
-
-class pedalboard.LadderFilter(mode: Mode = Mode.LPF12, cutoff_hz: float = 200, resonance: float = 0, drive: float = 1.0)#
+class pedalboard.LadderFilter(mode: Mode = Mode.LPF12, cutoff_hz: float = 200, resonance: float = 0, drive: float = 1.0)#
A multi-mode audio filter based on the classic Moog synthesizer ladder filter, invented by Dr. Bob Moog in 1968.
Depending on the filter’s mode, frequencies above, below, or on both sides of the cutoff frequency will be attenuated. Higher values for the resonance parameter may cause peaks in the frequency response around the cutoff frequency.
@@ -1773,27 +1698,27 @@ The pedalboard<
-
-__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+__call__(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run an audio buffer through this plugin. Alias for process().
-
-property is_effect: bool#
+property is_effect: bool#
True iff this plugin is an audio effect and accepts audio as input.
Introduced in v0.7.4.
-
-property is_instrument: bool#
+property is_instrument: bool#
True iff this plugin is not an audio effect and accepts only MIDI input, not audio.
Introduced in v0.7.4.
-
-process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
+process(input_array: ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) ndarray[Any, dtype[float32]]#
Run a 32-bit or 64-bit floating point audio buffer through this plugin.
(If calling this multiple times with multiple plugins, consider creating a
pedalboard.Pedalboard object instead.)
@@ -1811,11 +1736,6 @@ The pedalboard<
processing begins, clearing any state from previous calls to process.
If calling process multiple times while processing the same audio file
or buffer, set reset to False.
-The layout of the provided input_array will be automatically detected,
-assuming that the smaller dimension corresponds with the number of channels.
-If the number of samples and the number of channels are the same, each
-Plugin object will use the last-detected channel layout until
-reset() is explicitly called (as of v0.9.9).