Skip to content

🎛 🔊 A Python library for audio.

Regenerate documentation.

Peter Sobot8b28cc474cd9
diff --git a/docs/genindex.html b/docs/genindex.html
index 30fe9db..0c3b746 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -203,17 +203,29 @@
<section class="genindex-section">
<h1 id="index">Index</h1>
- <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#Q"><strong>Q</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#W"><strong>W</strong></a> | <a href="#Z"><strong>Z</strong></a></div>
+ <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#Q"><strong>Q</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#W"><strong>W</strong></a> | <a href="#Z"><strong>Z</strong></a></div>
</section>
<section id="A" class="genindex-section">
<h2>A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="reference/pedalboard.html#pedalboard.Mix.append">append() (pedalboard.Mix method)</a>
+ <li><a href="reference/pedalboard.html#pedalboard.Chain.append">append() (pedalboard.Chain method)</a>
+
+ <ul>
+ <li><a href="reference/pedalboard.html#pedalboard.Mix.append">(pedalboard.Mix method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Pedalboard.append">(pedalboard.Pedalboard method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.PluginContainer.append">(pedalboard.PluginContainer method)</a>
</li>
+ </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference/pedalboard.io.html#pedalboard.io.AudioFile">AudioFile (class in pedalboard.io)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioProcessorParameter">AudioProcessorParameter (class in pedalboard)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioUnitPlugin">AudioUnitPlugin (class in pedalboard)</a>
</li>
</ul></td>
</tr></table>
@@ -242,6 +254,8 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference/pedalboard.html#pedalboard.Resample.Quality.CatmullRom">CatmullRom (pedalboard.Resample.Quality attribute)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Chain">Chain (class in pedalboard)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Chorus">Chorus (class in pedalboard)</a>
</li>
@@ -327,6 +341,12 @@
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference/pedalboard.html#pedalboard.Gain">Gain (class in pedalboard)</a>
</li>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioUnitPlugin.get_plugin_names_for_file">get_plugin_names_for_file() (pedalboard.AudioUnitPlugin static method)</a>
+
+ <ul>
+ <li><a href="reference/pedalboard.html#pedalboard.VST3Plugin.get_plugin_names_for_file">(pedalboard.VST3Plugin static method)</a>
+</li>
+ </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference/pedalboard.html#pedalboard.GSMFullRateCompressor">GSMFullRateCompressor (class in pedalboard)</a>
@@ -361,10 +381,18 @@
</li>
<li><a href="reference/pedalboard.io.html#pedalboard.io.StreamResampler.input_latency">input_latency (pedalboard.io.StreamResampler property)</a>
</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Chain.insert">insert() (pedalboard.Chain method)</a>
+
+ <ul>
+ <li><a href="reference/pedalboard.html#pedalboard.Mix.insert">(pedalboard.Mix method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Pedalboard.insert">(pedalboard.Pedalboard method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.PluginContainer.insert">(pedalboard.PluginContainer method)</a>
+</li>
+ </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="reference/pedalboard.html#pedalboard.Mix.insert">insert() (pedalboard.Mix method)</a>
-</li>
<li><a href="reference/pedalboard.html#pedalboard.Invert">Invert (class in pedalboard)</a>
</li>
</ul></td>
@@ -375,6 +403,8 @@
<h2>L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioProcessorParameter.label">label (pedalboard.AudioProcessorParameter property)</a>
+</li>
<li><a href="reference/pedalboard.html#pedalboard.LadderFilter">LadderFilter (class in pedalboard)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.LadderFilter.Mode">LadderFilter.Mode (class in pedalboard)</a>
@@ -382,10 +412,14 @@
<li><a href="reference/pedalboard.html#pedalboard.Resample.Quality.Lagrange">Lagrange (pedalboard.Resample.Quality attribute)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Limiter">Limiter (class in pedalboard)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Resample.Quality.Linear">Linear (pedalboard.Resample.Quality attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="reference/pedalboard.html#pedalboard.Resample.Quality.Linear">Linear (pedalboard.Resample.Quality attribute)</a>
+ <li><a href="reference/pedalboard.html#pedalboard.load_plugin">load_plugin() (in module pedalboard)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.VST3Plugin.load_preset">load_preset() (pedalboard.VST3Plugin method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.LowpassFilter">LowpassFilter (class in pedalboard)</a>
</li>
@@ -426,16 +460,20 @@
<h2>N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="reference/pedalboard.io.html#pedalboard.io.ReadableAudioFile.name">name (pedalboard.io.ReadableAudioFile property)</a>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioUnitPlugin.name">name (pedalboard.AudioUnitPlugin property)</a>
<ul>
+ <li><a href="reference/pedalboard.io.html#pedalboard.io.ReadableAudioFile.name">(pedalboard.io.ReadableAudioFile property)</a>
+</li>
<li><a href="reference/pedalboard.io.html#pedalboard.io.ResampledReadableAudioFile.name">(pedalboard.io.ResampledReadableAudioFile property)</a>
</li>
- </ul></li>
- <li><a href="reference/pedalboard.html#pedalboard.NoiseGate">NoiseGate (class in pedalboard)</a>
+ <li><a href="reference/pedalboard.html#pedalboard.VST3Plugin.name">(pedalboard.VST3Plugin property)</a>
</li>
+ </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="reference/pedalboard.html#pedalboard.NoiseGate">NoiseGate (class in pedalboard)</a>
+</li>
<li><a href="reference/pedalboard.io.html#pedalboard.io.ReadableAudioFile.num_channels">num_channels (pedalboard.io.ReadableAudioFile property)</a>
<ul>
@@ -463,6 +501,8 @@
<li><a href="reference/pedalboard.html#module-pedalboard">module</a>
</li>
</ul></li>
+ <li><a href="reference/pedalboard.html#pedalboard.Pedalboard">Pedalboard (class in pedalboard)</a>
+</li>
<li>
pedalboard.io
@@ -478,9 +518,13 @@
</li>
<li><a href="reference/pedalboard.html#pedalboard.PluginContainer">PluginContainer (class in pedalboard)</a>
</li>
- <li><a href="reference/pedalboard.html#pedalboard.Bitcrush.process">process() (pedalboard.Bitcrush method)</a>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioUnitPlugin.process">process() (pedalboard.AudioUnitPlugin method)</a>
<ul>
+ <li><a href="reference/pedalboard.html#pedalboard.Bitcrush.process">(pedalboard.Bitcrush method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Chain.process">(pedalboard.Chain method)</a>
+</li>
<li><a href="reference/pedalboard.html#pedalboard.Chorus.process">(pedalboard.Chorus method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Clipping.process">(pedalboard.Clipping method)</a>
@@ -522,6 +566,8 @@
<li><a href="reference/pedalboard.html#pedalboard.NoiseGate.process">(pedalboard.NoiseGate method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.PeakFilter.process">(pedalboard.PeakFilter method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Pedalboard.process">(pedalboard.Pedalboard method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Phaser.process">(pedalboard.Phaser method)</a>
</li>
@@ -534,6 +580,8 @@
<li><a href="reference/pedalboard.html#pedalboard.Resample.process">(pedalboard.Resample method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Reverb.process">(pedalboard.Reverb method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.VST3Plugin.process">(pedalboard.VST3Plugin method)</a>
</li>
</ul></li>
</ul></td>
@@ -572,8 +620,16 @@
</li>
<li><a href="reference/pedalboard.io.html#pedalboard.io.ReadableAudioFile">ReadableAudioFile (class in pedalboard.io)</a>
</li>
- <li><a href="reference/pedalboard.html#pedalboard.Mix.remove">remove() (pedalboard.Mix method)</a>
+ <li><a href="reference/pedalboard.html#pedalboard.Chain.remove">remove() (pedalboard.Chain method)</a>
+
+ <ul>
+ <li><a href="reference/pedalboard.html#pedalboard.Mix.remove">(pedalboard.Mix method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Pedalboard.remove">(pedalboard.Pedalboard method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.PluginContainer.remove">(pedalboard.PluginContainer method)</a>
</li>
+ </ul></li>
<li><a href="reference/pedalboard.html#pedalboard.Resample">Resample (class in pedalboard)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Resample.Quality">Resample.Quality (class in pedalboard)</a>
@@ -584,9 +640,13 @@
</li>
<li><a href="reference/pedalboard.io.html#pedalboard.io.ResampledReadableAudioFile.resampling_quality">resampling_quality (pedalboard.io.ResampledReadableAudioFile property)</a>
</li>
- <li><a href="reference/pedalboard.html#pedalboard.Bitcrush.reset">reset() (pedalboard.Bitcrush method)</a>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioUnitPlugin.reset">reset() (pedalboard.AudioUnitPlugin method)</a>
<ul>
+ <li><a href="reference/pedalboard.html#pedalboard.Bitcrush.reset">(pedalboard.Bitcrush method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Chain.reset">(pedalboard.Chain method)</a>
+</li>
<li><a href="reference/pedalboard.html#pedalboard.Chorus.reset">(pedalboard.Chorus method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Clipping.reset">(pedalboard.Clipping method)</a>
@@ -628,6 +688,8 @@
<li><a href="reference/pedalboard.html#pedalboard.NoiseGate.reset">(pedalboard.NoiseGate method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.PeakFilter.reset">(pedalboard.PeakFilter method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.Pedalboard.reset">(pedalboard.Pedalboard method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Phaser.reset">(pedalboard.Phaser method)</a>
</li>
@@ -640,6 +702,8 @@
<li><a href="reference/pedalboard.html#pedalboard.Resample.reset">(pedalboard.Resample method)</a>
</li>
<li><a href="reference/pedalboard.html#pedalboard.Reverb.reset">(pedalboard.Reverb method)</a>
+</li>
+ <li><a href="reference/pedalboard.html#pedalboard.VST3Plugin.reset">(pedalboard.VST3Plugin method)</a>
</li>
</ul></li>
</ul></td>
@@ -674,6 +738,12 @@
<ul>
<li><a href="reference/pedalboard.io.html#pedalboard.io.ResampledReadableAudioFile.seekable">(pedalboard.io.ResampledReadableAudioFile method)</a>
+</li>
+ </ul></li>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioUnitPlugin.show_editor">show_editor() (pedalboard.AudioUnitPlugin method)</a>
+
+ <ul>
+ <li><a href="reference/pedalboard.html#pedalboard.VST3Plugin.show_editor">(pedalboard.VST3Plugin method)</a>
</li>
</ul></li>
<li><a href="reference/pedalboard.io.html#pedalboard.io.StreamResampler.source_sample_rate">source_sample_rate (pedalboard.io.StreamResampler property)</a>
@@ -706,6 +776,26 @@
</tr></table>
</section>
+<section id="U" class="genindex-section">
+ <h2>U</h2>
+ <table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="reference/pedalboard.html#pedalboard.AudioProcessorParameter.units">units (pedalboard.AudioProcessorParameter property)</a>
+</li>
+ </ul></td>
+ </tr></table>
+</section>
+
+<section id="V" class="genindex-section">
+ <h2>V</h2>
+ <table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="reference/pedalboard.html#pedalboard.VST3Plugin">VST3Plugin (class in pedalboard)</a>
+</li>
+ </ul></td>
+ </tr></table>
+</section>
+
<section id="W" class="genindex-section">
<h2>W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
diff --git a/docs/objects.inv b/docs/objects.inv
index 6be9621..f5ec4b3 100644
Binary files a/docs/objects.inv and b/docs/objects.inv differ
diff --git a/docs/reference/pedalboard.html b/docs/reference/pedalboard.html
index 89f8f6a..3bb9284 100644
--- a/docs/reference/pedalboard.html
+++ b/docs/reference/pedalboard.html
@@ -7,10 +7,8 @@
<meta property="og:type" content="website" />
<meta property="og:url" content="https://spotify.github.io/pedalboard/reference/pedalboard.html" />
<meta property="og:site_name" content="Pedalboard v0.6.8 Documentation" />
-<meta property="og:description" content="This module provides classes and functions for adding effects to audio. Most classes in this module are subclasses of Plugin, each of which allows applying effects to an audio buffer or stream. For..." />
<meta property="og:image" content="https://repository-images.githubusercontent.com/383471193/0f79b949-9b91-4436-bfc4-05d30ef384cc" />
<meta property="og:image:alt" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
-<meta name="description" content="This module provides classes and functions for adding effects to audio. Most classes in this module are subclasses of Plugin, each of which allows applying effects to an audio buffer or stream. For..." />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="The pedalboard.io API" href="pedalboard.io.html" /><link rel="prev" title="Features" href="../index.html" />
<link rel="shortcut icon" href="../_static/favicon.ico"/><meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/>
@@ -213,8 +211,223 @@
<article role="main">
<section id="module-pedalboard">
<span id="the-pedalboard-api"></span><h1>The <code class="docutils literal notranslate"><span class="pre">pedalboard</span></code> API<a class="headerlink" href="#module-pedalboard" title="Permalink to this heading">#</a></h1>
-<p>This module provides classes and functions for adding effects to audio. Most classes in this module are subclasses of <code class="docutils literal notranslate"><span class="pre">Plugin</span></code>, each of which allows applying effects to an audio buffer or stream.</p>
-<p>For audio I/O classes (i.e.: reading and writing audio files), see <code class="docutils literal notranslate"><span class="pre">pedalboard.io</span></code>.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="pedalboard.Pedalboard">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Pedalboard</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Pedalboard" title="Permalink to this definition">#</a></dt>
+<dd><p>A container for a series of <a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> objects, to use for processing audio, like a
+<a class="reference external" href="https://en.wikipedia.org/wiki/Guitar_pedalboard">guitar pedalboard</a>.</p>
+<p><a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pedalboard</span></code></a> objects act like regular Python <code class="docutils literal notranslate"><span class="pre">List</span></code> objects,
+but come with an additional <a class="reference internal" href="#pedalboard.Pedalboard.process" title="pedalboard.Pedalboard.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method (also aliased to <code class="docutils literal notranslate"><span class="pre">__call__</span></code>),
+allowing audio to be passed through the entire <a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pedalboard</span></code></a> object for processing:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">my_pedalboard</span> <span class="o">=</span> <span class="n">Pedalboard</span><span class="p">()</span>
+<span class="n">my_pedalboard</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Reverb</span><span class="p">())</span>
+<span class="n">output_audio</span> <span class="o">=</span> <span class="n">my_pedalboard</span><span class="p">(</span><span class="n">input_audio</span><span class="p">)</span>
+</pre></div>
+</div>
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Pedalboard.append">
+<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Pedalboard.append" title="Permalink to this definition">#</a></dt>
+<dd><p>Append a plugin to the end of this container.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Pedalboard.insert">
+<span class="sig-name descname"><span class="pre">insert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Pedalboard.insert" title="Permalink to this definition">#</a></dt>
+<dd><p>Insert a plugin at the specified index.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Pedalboard.process">
+<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">numpy.ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">numpy.float32</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Pedalboard.process" title="Permalink to this definition">#</a></dt>
+<dd><p>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
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
+<p>The returned array may contain up to (but not more than) the same number of
+samples as were provided. If fewer samples were returned than expected, the
+plugin has likely buffered audio inside itself. To receive the remaining
+audio, pass another audio buffer into <code class="docutils literal notranslate"><span class="pre">process</span></code> with <code class="docutils literal notranslate"><span class="pre">reset</span></code> set to
+<code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
+<p>If the provided buffer uses a 64-bit datatype, it will be converted to 32-bit
+for processing.</p>
+<p>The provided <code class="docutils literal notranslate"><span class="pre">buffer_size</span></code> argument will be used to control the size of
+each chunk of audio provided to the plugin. Higher buffer sizes may speed up
+processing at the expense of memory usage.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">reset</span></code> flag determines if all of the plugins should be reset before
+processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
+If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
+or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Pedalboard.process" title="pedalboard.Pedalboard.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Pedalboard.process" title="pedalboard.Pedalboard.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Pedalboard.remove">
+<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Pedalboard.remove" title="Permalink to this definition">#</a></dt>
+<dd><p>Remove a plugin by its value.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Pedalboard.reset">
+<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Pedalboard.reset" title="Permalink to this definition">#</a></dt>
+<dd><p>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.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="pedalboard.load_plugin">
+<span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">load_plugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path_to_plugin_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameter_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExternalPlugin</span></span></span><a class="headerlink" href="#pedalboard.load_plugin" title="Permalink to this definition">#</a></dt>
+<dd><p>Load an audio plugin.</p>
+<dl class="simple">
+<dt>Two plugin formats are supported:</dt><dd><ul class="simple">
+<li><p>VST3® format is supported on macOS, Windows, and Linux</p></li>
+<li><p>Audio Units are supported on macOS</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>path_to_plugin_file</strong> (<em>str</em>) – The path of a VST3® or Audio Unit plugin file or bundle.</p></li>
+<li><p><strong>parameter_values</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Union</em><em>[</em><em>str</em><em>, </em><em>int</em><em>, </em><em>float</em><em>, </em><em>bool</em><em>]</em><em>]</em>) – An optional dictionary of initial values to provide to the plugin
+after loading. Keys in this dictionary are expected to match the
+parameter names reported by the plugin, but normalized to strings
+that can be used as Python identifiers. (These are the same
+identifiers that are used as keys in the <code class="docutils literal notranslate"><span class="pre">.parameters</span></code> dictionary
+of a loaded plugin.)</p></li>
+<li><p><strong>plugin_name</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – An optional plugin name that can be used to load a specific plugin
+from a multi-plugin package. If a package is loaded but a
+<code class="docutils literal notranslate"><span class="pre">plugin_name</span></code> is not provided, an exception will be thrown.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>an instance of <a class="reference internal" href="#pedalboard.VST3Plugin" title="pedalboard.VST3Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.VST3Plugin</span></code></a> or <a class="reference internal" href="#pedalboard.AudioUnitPlugin" title="pedalboard.AudioUnitPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.AudioUnitPlugin</span></code></a></p>
+</dd>
+</dl>
+<dl>
+<dt>Throws:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">ImportError</span></code>: if the plugin cannot be found or loaded</p>
+<p><code class="docutils literal notranslate"><span class="pre">RuntimeError</span></code>: if the plugin file contains more than one plugin,
+but no <code class="docutils literal notranslate"><span class="pre">plugin_name</span></code> was provided</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="pedalboard.AudioProcessorParameter">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">AudioProcessorParameter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ExternalPlugin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameter_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">search_steps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1000</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.AudioProcessorParameter" title="Permalink to this definition">#</a></dt>
+<dd><p>A wrapper around various different parameters exposed by
+<a class="reference internal" href="#pedalboard.VST3Plugin" title="pedalboard.VST3Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">VST3Plugin</span></code></a> or <a class="reference internal" href="#pedalboard.AudioUnitPlugin" title="pedalboard.AudioUnitPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioUnitPlugin</span></code></a> instances.</p>
+<p><a class="reference internal" href="#pedalboard.AudioProcessorParameter" title="pedalboard.AudioProcessorParameter"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioProcessorParameter</span></code></a> objects are rarely used directly,
+and usually used via their implicit interface:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">my_plugin</span> <span class="o">=</span> <span class="n">load_plugin</span><span class="p">(</span><span class="s2">&quot;My Cool Audio Effect.vst3&quot;</span><span class="p">)</span>
+<span class="c1"># Print all of the parameter names:</span>
+<span class="nb">print</span><span class="p">(</span><span class="n">my_plugin</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
+<span class="c1"># [&quot;mix&quot;, &quot;delay_time_ms&quot;, &quot;foobar&quot;]</span>
+<span class="c1"># Access each parameter as if it were just a Python attribute:</span>
+<span class="n">my_plugin</span><span class="o">.</span><span class="n">mix</span> <span class="o">=</span> <span class="mf">0.5</span>
+<span class="n">my_plugin</span><span class="o">.</span><span class="n">delay_time_ms</span> <span class="o">=</span> <span class="mi">400</span>
+</pre></div>
+</div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p><a class="reference internal" href="#pedalboard.AudioProcessorParameter" title="pedalboard.AudioProcessorParameter"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioProcessorParameter</span></code></a> tries to guess the range of
+valid parameter values, as well as the type/unit of the parameter,
+when instantiated. This guess may not always be accurate.
+Raw control over the underlying parameter’s value can be had by
+accessing the <code class="xref py py-attr docutils literal notranslate"><span class="pre">raw_value</span></code> attribute, which is always bounded
+on [0, 1] and is passed directly to the underlying plugin object.</p>
+</div>
+<dl class="py property">
+<dt class="sig sig-object py" id="pedalboard.AudioProcessorParameter.label">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pedalboard.AudioProcessorParameter.label" title="Permalink to this definition">#</a></dt>
+<dd><p>The units used by this parameter (Hz, dB, etc).</p>
+<p>May be <cite>None</cite> if the plugin does not expose units for this
+parameter or if automatic unit detection fails.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="pedalboard.AudioProcessorParameter.units">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">units</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pedalboard.AudioProcessorParameter.units" title="Permalink to this definition">#</a></dt>
+<dd><p>Alias for “label” - the units used by this parameter (Hz, dB, etc).</p>
+<p>May be <cite>None</cite> if the plugin does not expose units for this
+parameter or if automatic unit detection fails.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="pedalboard.AudioUnitPlugin">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">AudioUnitPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path_to_plugin_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameter_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.AudioUnitPlugin" title="Permalink to this definition">#</a></dt>
+<dd><p>A wrapper around third-party, non-Pedalboard audio effects
+plugins in
+<a class="reference external" href="https://en.wikipedia.org/wiki/Audio_Units">Apple’s Audio Unit</a>
+format.</p>
+<p>Audio Unit plugins are only supported on macOS. This class will be
+unavailable on non-macOS platforms. Plugin files must be installed
+in the appropriate system-wide path for them to be
+loadable (usually <code class="docutils literal notranslate"><span class="pre">/Library/Audio/Plug-Ins/Components/</span></code> or
+<code class="docutils literal notranslate"><span class="pre">~/Library/Audio/Plug-Ins/Components/</span></code>).</p>
+<p>For a plugin wrapper that works on Windows and Linux as well,
+see <a class="reference internal" href="#pedalboard.VST3Plugin" title="pedalboard.VST3Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.VST3Plugin</span></code></a>.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.AudioUnitPlugin.get_plugin_names_for_file">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_plugin_names_for_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.AudioUnitPlugin.get_plugin_names_for_file" title="Permalink to this definition">#</a></dt>
+<dd><p>Return a list of plugin names contained within a given Audio Unit bundle (i.e.: a <code class="docutils literal notranslate"><span class="pre">.component</span></code> file). If the provided file cannot be scanned, an <code class="docutils literal notranslate"><span class="pre">ImportError</span></code> will be raised.</p>
+<p>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.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="pedalboard.AudioUnitPlugin.name">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#pedalboard.AudioUnitPlugin.name" title="Permalink to this definition">#</a></dt>
+<dd><p>The name of this plugin, as reported by the plugin itself.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.AudioUnitPlugin.process">
+<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">numpy.ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">numpy.float32</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.AudioUnitPlugin.process" title="Permalink to this definition">#</a></dt>
+<dd><p>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
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
+<p>The returned array may contain up to (but not more than) the same number of
+samples as were provided. If fewer samples were returned than expected, the
+plugin has likely buffered audio inside itself. To receive the remaining
+audio, pass another audio buffer into <code class="docutils literal notranslate"><span class="pre">process</span></code> with <code class="docutils literal notranslate"><span class="pre">reset</span></code> set to
+<code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
+<p>If the provided buffer uses a 64-bit datatype, it will be converted to 32-bit
+for processing.</p>
+<p>The provided <code class="docutils literal notranslate"><span class="pre">buffer_size</span></code> argument will be used to control the size of
+each chunk of audio provided to the plugin. Higher buffer sizes may speed up
+processing at the expense of memory usage.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">reset</span></code> flag determines if all of the plugins should be reset before
+processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
+If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
+or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.AudioUnitPlugin.process" title="pedalboard.AudioUnitPlugin.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.AudioUnitPlugin.process" title="pedalboard.AudioUnitPlugin.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.AudioUnitPlugin.reset">
+<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.AudioUnitPlugin.reset" title="Permalink to this definition">#</a></dt>
+<dd><p>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.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.AudioUnitPlugin.show_editor">
+<span class="sig-name descname"><span class="pre">show_editor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.AudioUnitPlugin.show_editor" title="Permalink to this definition">#</a></dt>
+<dd><p>Show the UI of this plugin as a native window. This method will block until the window is closed or a KeyboardInterrupt is received.</p>
+</dd></dl>
+
+</dd></dl>
+
<dl class="py class">
<dt class="sig sig-object py" id="pedalboard.Bitcrush">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Bitcrush</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bit_depth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Bitcrush" title="Permalink to this definition">#</a></dt>
@@ -231,7 +444,7 @@
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Bitcrush.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -246,6 +459,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Bitcrush.process" title="pedalboard.Bitcrush.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Bitcrush.process" title="pedalboard.Bitcrush.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -256,6 +475,64 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
</dd></dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="pedalboard.Chain">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Chain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Chain" title="Permalink to this definition">#</a></dt>
+<dd><p>Run zero or more plugins as a plugin. Useful when used with the Mix plugin.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Chain.append">
+<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Chain.append" title="Permalink to this definition">#</a></dt>
+<dd><p>Append a plugin to the end of this container.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Chain.insert">
+<span class="sig-name descname"><span class="pre">insert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Chain.insert" title="Permalink to this definition">#</a></dt>
+<dd><p>Insert a plugin at the specified index.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Chain.process">
+<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Chain.process" title="Permalink to this definition">#</a></dt>
+<dd><p>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
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
+<p>The returned array may contain up to (but not more than) the same number of
+samples as were provided. If fewer samples were returned than expected, the
+plugin has likely buffered audio inside itself. To receive the remaining
+audio, pass another audio buffer into <code class="docutils literal notranslate"><span class="pre">process</span></code> with <code class="docutils literal notranslate"><span class="pre">reset</span></code> set to
+<code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
+<p>If the provided buffer uses a 64-bit datatype, it will be converted to 32-bit
+for processing.</p>
+<p>The provided <code class="docutils literal notranslate"><span class="pre">buffer_size</span></code> argument will be used to control the size of
+each chunk of audio provided to the plugin. Higher buffer sizes may speed up
+processing at the expense of memory usage.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">reset</span></code> flag determines if all of the plugins should be reset before
+processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
+If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
+or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Chain.process" title="pedalboard.Chain.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Chain.process" title="pedalboard.Chain.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Chain.remove">
+<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Chain.remove" title="Permalink to this definition">#</a></dt>
+<dd><p>Remove a plugin by its value.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Chain.reset">
+<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Chain.reset" title="Permalink to this definition">#</a></dt>
+<dd><p>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.</p>
+</dd></dl>
+
+</dd></dl>
+
<dl class="py class">
<dt class="sig sig-object py" id="pedalboard.Chorus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Chorus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rate_hz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.25</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">centre_delay_ms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">7.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feedback</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Chorus" title="Permalink to this definition">#</a></dt>
@@ -273,7 +550,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Chorus.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -288,6 +565,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Chorus.process" title="pedalboard.Chorus.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Chorus.process" title="pedalboard.Chorus.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -307,7 +590,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Clipping.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -322,6 +605,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Clipping.process" title="pedalboard.Clipping.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Clipping.process" title="pedalboard.Clipping.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -342,7 +631,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Compressor.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -357,6 +646,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Compressor.process" title="pedalboard.Compressor.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Compressor.process" title="pedalboard.Compressor.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -376,7 +671,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Convolution.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -391,6 +686,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Convolution.process" title="pedalboard.Convolution.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Convolution.process" title="pedalboard.Convolution.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -410,7 +711,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Delay.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -425,6 +726,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Delay.process" title="pedalboard.Delay.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Delay.process" title="pedalboard.Delay.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -445,7 +752,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Distortion.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -460,6 +767,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Distortion.process" title="pedalboard.Distortion.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Distortion.process" title="pedalboard.Distortion.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -472,14 +785,14 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<dl class="py class">
<dt class="sig sig-object py" id="pedalboard.GSMFullRateCompressor">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">GSMFullRateCompressor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quality:</span> <span class="pre">~pedalboard.Resample.Quality</span> <span class="pre">=</span> <span class="pre">&lt;Quality.WindowedSinc:</span> <span class="pre">4&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.GSMFullRateCompressor" title="Permalink to this definition">#</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">GSMFullRateCompressor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quality</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Resample.Quality" title="pedalboard.Resample.Quality"><span class="pre">Quality</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Quality.WindowedSinc</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.GSMFullRateCompressor" title="Permalink to this definition">#</a></dt>
<dd><p>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.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pedalboard.GSMFullRateCompressor.process">
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.GSMFullRateCompressor.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -494,6 +807,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.GSMFullRateCompressor.process" title="pedalboard.GSMFullRateCompressor.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.GSMFullRateCompressor.process" title="pedalboard.GSMFullRateCompressor.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -514,7 +833,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Gain.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -529,6 +848,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Gain.process" title="pedalboard.Gain.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Gain.process" title="pedalboard.Gain.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -548,7 +873,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.HighShelfFilter.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -563,6 +888,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.HighShelfFilter.process" title="pedalboard.HighShelfFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.HighShelfFilter.process" title="pedalboard.HighShelfFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -582,7 +913,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.HighpassFilter.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -597,6 +928,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.HighpassFilter.process" title="pedalboard.HighpassFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.HighpassFilter.process" title="pedalboard.HighpassFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -616,7 +953,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.IIRFilter.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -631,6 +968,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.IIRFilter.process" title="pedalboard.IIRFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.IIRFilter.process" title="pedalboard.IIRFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -651,7 +994,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Invert.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -666,6 +1009,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Invert.process" title="pedalboard.Invert.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Invert.process" title="pedalboard.Invert.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -728,7 +1077,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.LadderFilter.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -743,6 +1092,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.LadderFilter.process" title="pedalboard.LadderFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.LadderFilter.process" title="pedalboard.LadderFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -762,7 +1117,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Limiter.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -777,6 +1132,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Limiter.process" title="pedalboard.Limiter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Limiter.process" title="pedalboard.Limiter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -796,7 +1157,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.LowShelfFilter.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -811,6 +1172,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.LowShelfFilter.process" title="pedalboard.LowShelfFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.LowShelfFilter.process" title="pedalboard.LowShelfFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -830,7 +1197,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.LowpassFilter.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -845,6 +1212,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.LowpassFilter.process" title="pedalboard.LowpassFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.LowpassFilter.process" title="pedalboard.LowpassFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -866,7 +1239,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.MP3Compressor.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -881,6 +1254,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.MP3Compressor.process" title="pedalboard.MP3Compressor.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.MP3Compressor.process" title="pedalboard.MP3Compressor.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -893,24 +1272,26 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<dl class="py class">
<dt class="sig sig-object py" id="pedalboard.Mix">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Mix</span></span><a class="headerlink" href="#pedalboard.Mix" title="Permalink to this definition">#</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Mix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Mix" title="Permalink to this definition">#</a></dt>
<dd><p>A utility plugin that allows running other plugins in parallel. All plugins provided will be mixed equally.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pedalboard.Mix.append">
-<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pedalboard_native.PluginContainer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pedalboard_native.Plugin</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Mix.append" title="Permalink to this definition">#</a></dt>
-<dd></dd></dl>
+<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Mix.append" title="Permalink to this definition">#</a></dt>
+<dd><p>Append a plugin to the end of this container.</p>
+</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pedalboard.Mix.insert">
-<span class="sig-name descname"><span class="pre">insert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pedalboard_native.PluginContainer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pedalboard_native.Plugin</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Mix.insert" title="Permalink to this definition">#</a></dt>
-<dd></dd></dl>
+<span class="sig-name descname"><span class="pre">insert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Mix.insert" title="Permalink to this definition">#</a></dt>
+<dd><p>Insert a plugin at the specified index.</p>
+</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pedalboard.Mix.process">
-<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pedalboard_native.Plugin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">numpy.ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">numpy.float32</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Mix.process" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Mix.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -925,16 +1306,23 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Mix.process" title="pedalboard.Mix.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Mix.process" title="pedalboard.Mix.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pedalboard.Mix.remove">
-<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pedalboard_native.PluginContainer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pedalboard_native.Plugin</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Mix.remove" title="Permalink to this definition">#</a></dt>
-<dd></dd></dl>
+<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Mix.remove" title="Permalink to this definition">#</a></dt>
+<dd><p>Remove a plugin by its value.</p>
+</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pedalboard.Mix.reset">
-<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pedalboard_native.Plugin</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Mix.reset" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Mix.reset" title="Permalink to this definition">#</a></dt>
<dd><p>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.</p>
</dd></dl>
@@ -949,7 +1337,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.NoiseGate.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -964,6 +1352,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.NoiseGate.process" title="pedalboard.NoiseGate.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.NoiseGate.process" title="pedalboard.NoiseGate.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -983,7 +1377,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.PeakFilter.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -998,6 +1392,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.PeakFilter.process" title="pedalboard.PeakFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.PeakFilter.process" title="pedalboard.PeakFilter.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -1017,7 +1417,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Phaser.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -1032,6 +1432,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Phaser.process" title="pedalboard.Phaser.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Phaser.process" title="pedalboard.Phaser.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -1052,7 +1458,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.PitchShift.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -1067,6 +1473,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.PitchShift.process" title="pedalboard.PitchShift.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.PitchShift.process" title="pedalboard.PitchShift.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -1086,7 +1498,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Plugin.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -1101,6 +1513,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Plugin.process" title="pedalboard.Plugin.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Plugin.process" title="pedalboard.Plugin.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -1115,12 +1533,30 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<dt class="sig sig-object py" id="pedalboard.PluginContainer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">PluginContainer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.PluginContainer" title="Permalink to this definition">#</a></dt>
<dd><p>A generic audio processing plugin that contains zero or more other plugins. Not intended for direct use.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.PluginContainer.append">
+<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.PluginContainer.append" title="Permalink to this definition">#</a></dt>
+<dd><p>Append a plugin to the end of this container.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.PluginContainer.insert">
+<span class="sig-name descname"><span class="pre">insert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.PluginContainer.insert" title="Permalink to this definition">#</a></dt>
+<dd><p>Insert a plugin at the specified index.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.PluginContainer.remove">
+<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Plugin" title="pedalboard.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.PluginContainer.remove" title="Permalink to this definition">#</a></dt>
+<dd><p>Remove a plugin by its value.</p>
+</dd></dl>
+
<dl class="py method">
<dt class="sig sig-object py" id="pedalboard.PluginContainer.process">
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.PluginContainer.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -1135,6 +1571,12 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.PluginContainer.process" title="pedalboard.PluginContainer.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.PluginContainer.process" title="pedalboard.PluginContainer.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
@@ -1147,7 +1589,7 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<dl class="py class">
<dt class="sig sig-object py" id="pedalboard.Resample">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Resample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_sample_rate:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">8000.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quality:</span> <span class="pre">~pedalboard.Resample.Quality</span> <span class="pre">=</span> <span class="pre">&lt;Quality.WindowedSinc:</span> <span class="pre">4&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Resample" title="Permalink to this definition">#</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Resample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8000.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quality</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pedalboard.Resample.Quality" title="pedalboard.Resample.Quality"><span class="pre">Quality</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Quality.WindowedSinc</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Resample" title="Permalink to this definition">#</a></dt>
<dd><p>A plugin that downsamples the input audio to the given sample rate, then upsamples it back to the original sample rate. Various quality settings will produce audible distortion and aliasing effects.</p>
<dl class="py class">
<dt class="sig sig-object py" id="pedalboard.Resample.Quality">
@@ -1185,6 +1627,40 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Resample.process">
+<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Resample.process" title="Permalink to this definition">#</a></dt>
+<dd><p>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
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
+<p>The returned array may contain up to (but not more than) the same number of
+samples as were provided. If fewer samples were returned than expected, the
+plugin has likely buffered audio inside itself. To receive the remaining
+audio, pass another audio buffer into <code class="docutils literal notranslate"><span class="pre">process</span></code> with <code class="docutils literal notranslate"><span class="pre">reset</span></code> set to
+<code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
+<p>If the provided buffer uses a 64-bit datatype, it will be converted to 32-bit
+for processing.</p>
+<p>The provided <code class="docutils literal notranslate"><span class="pre">buffer_size</span></code> argument will be used to control the size of
+each chunk of audio provided to the plugin. Higher buffer sizes may speed up
+processing at the expense of memory usage.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">reset</span></code> flag determines if all of the plugins should be reset before
+processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
+If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
+or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Resample.process" title="pedalboard.Resample.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Resample.process" title="pedalboard.Resample.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.Resample.reset">
+<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Resample.reset" title="Permalink to this definition">#</a></dt>
+<dd><p>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.</p>
+</dd></dl>
+
<dl class="py property">
<dt class="sig sig-object py" id="pedalboard.Resample.quality">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pedalboard.Resample.Quality" title="pedalboard.Resample.Quality"><span class="pre">Quality</span></a></em><a class="headerlink" href="#pedalboard.Resample.quality" title="Permalink to this definition">#</a></dt>
@@ -1197,12 +1673,18 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<dd><p>The sample rate to resample the input audio to. This value may be a floating-point number, in which case a floating-point sampling rate will be used. Note that the output of this plugin will still be at the original sample rate; this is merely the sample rate used for quality reduction.</p>
</dd></dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="pedalboard.Reverb">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Reverb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">room_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">damping</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wet_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.33</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dry_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freeze_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Reverb" title="Permalink to this definition">#</a></dt>
+<dd><p>A simple reverb effect. Uses a simple stereo reverb algorithm, based on the technique and tunings used in <cite>FreeVerb &lt;https://ccrma.stanford.edu/~jos/pasp/Freeverb.html&gt;_</cite>.</p>
<dl class="py method">
-<dt class="sig sig-object py" id="pedalboard.Resample.process">
-<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Resample.process" title="Permalink to this definition">#</a></dt>
+<dt class="sig sig-object py" id="pedalboard.Reverb.process">
+<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Reverb.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -1217,26 +1699,58 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.Reverb.process" title="pedalboard.Reverb.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.Reverb.process" title="pedalboard.Reverb.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
-<dt class="sig sig-object py" id="pedalboard.Resample.reset">
-<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Resample.reset" title="Permalink to this definition">#</a></dt>
+<dt class="sig sig-object py" id="pedalboard.Reverb.reset">
+<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Reverb.reset" title="Permalink to this definition">#</a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
-<dt class="sig sig-object py" id="pedalboard.Reverb">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">Reverb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">room_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">damping</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wet_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.33</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dry_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freeze_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.Reverb" title="Permalink to this definition">#</a></dt>
-<dd><p>A simple reverb effect. Uses a simple stereo reverb algorithm, based on the technique and tunings used in <cite>FreeVerb &lt;https://ccrma.stanford.edu/~jos/pasp/Freeverb.html&gt;_</cite>.</p>
+<dt class="sig sig-object py" id="pedalboard.VST3Plugin">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.</span></span><span class="sig-name descname"><span class="pre">VST3Plugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path_to_plugin_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameter_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plugin_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.VST3Plugin" title="Permalink to this definition">#</a></dt>
+<dd><p>A wrapper around third-party, non-Pedalboard audio effects
+plugins in
+<a class="reference external" href="https://en.wikipedia.org/wiki/Virtual_Studio_Technology">Steinberg GmbH’s VST3®</a>
+format.</p>
+<p>VST3® plugins are supported on macOS, Windows, and Linux.
+However, VST3® plugin files are not cross-compatible with
+different operating systems; a platform-specific build of each plugin
+is required to load that plugin on a given platform. (For example:
+a Windows VST3 plugin bundle will not load on Linux or macOS.)</p>
<dl class="py method">
-<dt class="sig sig-object py" id="pedalboard.Reverb.process">
-<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dtype</span><span class="p"><span class="pre">[</span></span><span class="pre">float32</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.Reverb.process" title="Permalink to this definition">#</a></dt>
+<dt class="sig sig-object py" id="pedalboard.VST3Plugin.get_plugin_names_for_file">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_plugin_names_for_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.VST3Plugin.get_plugin_names_for_file" title="Permalink to this definition">#</a></dt>
+<dd><p>Return a list of plugin names contained within a given VST3 plugin (i.e.: a “.vst3”). If the provided file cannot be scanned, an ImportError will be raised.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.VST3Plugin.load_preset">
+<span class="sig-name descname"><span class="pre">load_preset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">preset_file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.VST3Plugin.load_preset" title="Permalink to this definition">#</a></dt>
+<dd><p>Load a VST3 preset file in .vstpreset format.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="pedalboard.VST3Plugin.name">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#pedalboard.VST3Plugin.name" title="Permalink to this definition">#</a></dt>
+<dd><p>The name of this plugin.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.VST3Plugin.process">
+<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_array</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">numpy.ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8192</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">numpy.float32</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pedalboard.VST3Plugin.process" title="Permalink to this definition">#</a></dt>
<dd><p>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
-<code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code> object instead.)</p>
+<a class="reference internal" href="#pedalboard.Pedalboard" title="pedalboard.Pedalboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">pedalboard.Pedalboard</span></code></a> object instead.)</p>
<p>The returned array may contain up to (but not more than) the same number of
samples as were provided. If fewer samples were returned than expected, the
plugin has likely buffered audio inside itself. To receive the remaining
@@ -1251,14 +1765,26 @@ processing at the expense of memory usage.</p>
processing begins, clearing any state from previous calls to <code class="docutils literal notranslate"><span class="pre">process</span></code>.
If calling <code class="docutils literal notranslate"><span class="pre">process</span></code> multiple times while processing the same audio file
or buffer, set <code class="docutils literal notranslate"><span class="pre">reset</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference internal" href="#pedalboard.VST3Plugin.process" title="pedalboard.VST3Plugin.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> method can also be used via <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>;
+i.e.: just calling this object like a function (<code class="docutils literal notranslate"><span class="pre">my_plugin(...)</span></code>) will
+automatically invoke <a class="reference internal" href="#pedalboard.VST3Plugin.process" title="pedalboard.VST3Plugin.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> with the same arguments.</p>
+</div>
</dd></dl>
<dl class="py method">
-<dt class="sig sig-object py" id="pedalboard.Reverb.reset">
-<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.Reverb.reset" title="Permalink to this definition">#</a></dt>
+<dt class="sig sig-object py" id="pedalboard.VST3Plugin.reset">
+<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.VST3Plugin.reset" title="Permalink to this definition">#</a></dt>
<dd><p>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.</p>
</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="pedalboard.VST3Plugin.show_editor">
+<span class="sig-name descname"><span class="pre">show_editor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pedalboard.VST3Plugin.show_editor" title="Permalink to this definition">#</a></dt>
+<dd><p>Show the UI of this plugin as a native window. This method will block until the window is closed or a KeyboardInterrupt is received.</p>
+</dd></dl>
+
</dd></dl>
</section>
@@ -1327,12 +1853,42 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">The <code class="docutils literal notranslate"><span class="pre">pedalboard</span></code> API</a><ul>
+<li><a class="reference internal" href="#pedalboard.Pedalboard"><code class="docutils literal notranslate"><span class="pre">Pedalboard</span></code></a><ul>
+<li><a class="reference internal" href="#pedalboard.Pedalboard.append"><code class="docutils literal notranslate"><span class="pre">Pedalboard.append()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Pedalboard.insert"><code class="docutils literal notranslate"><span class="pre">Pedalboard.insert()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Pedalboard.process"><code class="docutils literal notranslate"><span class="pre">Pedalboard.process()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Pedalboard.remove"><code class="docutils literal notranslate"><span class="pre">Pedalboard.remove()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Pedalboard.reset"><code class="docutils literal notranslate"><span class="pre">Pedalboard.reset()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#pedalboard.load_plugin"><code class="docutils literal notranslate"><span class="pre">load_plugin()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.AudioProcessorParameter"><code class="docutils literal notranslate"><span class="pre">AudioProcessorParameter</span></code></a><ul>
+<li><a class="reference internal" href="#pedalboard.AudioProcessorParameter.label"><code class="docutils literal notranslate"><span class="pre">AudioProcessorParameter.label</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.AudioProcessorParameter.units"><code class="docutils literal notranslate"><span class="pre">AudioProcessorParameter.units</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#pedalboard.AudioUnitPlugin"><code class="docutils literal notranslate"><span class="pre">AudioUnitPlugin</span></code></a><ul>
+<li><a class="reference internal" href="#pedalboard.AudioUnitPlugin.get_plugin_names_for_file"><code class="docutils literal notranslate"><span class="pre">AudioUnitPlugin.get_plugin_names_for_file()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.AudioUnitPlugin.name"><code class="docutils literal notranslate"><span class="pre">AudioUnitPlugin.name</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.AudioUnitPlugin.process"><code class="docutils literal notranslate"><span class="pre">AudioUnitPlugin.process()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.AudioUnitPlugin.reset"><code class="docutils literal notranslate"><span class="pre">AudioUnitPlugin.reset()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.AudioUnitPlugin.show_editor"><code class="docutils literal notranslate"><span class="pre">AudioUnitPlugin.show_editor()</span></code></a></li>
+</ul>
+</li>
<li><a class="reference internal" href="#pedalboard.Bitcrush"><code class="docutils literal notranslate"><span class="pre">Bitcrush</span></code></a><ul>
<li><a class="reference internal" href="#pedalboard.Bitcrush.bit_depth"><code class="docutils literal notranslate"><span class="pre">Bitcrush.bit_depth</span></code></a></li>
<li><a class="reference internal" href="#pedalboard.Bitcrush.process"><code class="docutils literal notranslate"><span class="pre">Bitcrush.process()</span></code></a></li>
<li><a class="reference internal" href="#pedalboard.Bitcrush.reset"><code class="docutils literal notranslate"><span class="pre">Bitcrush.reset()</span></code></a></li>
</ul>
</li>
+<li><a class="reference internal" href="#pedalboard.Chain"><code class="docutils literal notranslate"><span class="pre">Chain</span></code></a><ul>
+<li><a class="reference internal" href="#pedalboard.Chain.append"><code class="docutils literal notranslate"><span class="pre">Chain.append()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Chain.insert"><code class="docutils literal notranslate"><span class="pre">Chain.insert()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Chain.process"><code class="docutils literal notranslate"><span class="pre">Chain.process()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Chain.remove"><code class="docutils literal notranslate"><span class="pre">Chain.remove()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Chain.reset"><code class="docutils literal notranslate"><span class="pre">Chain.reset()</span></code></a></li>
+</ul>
+</li>
<li><a class="reference internal" href="#pedalboard.Chorus"><code class="docutils literal notranslate"><span class="pre">Chorus</span></code></a><ul>
<li><a class="reference internal" href="#pedalboard.Chorus.rate_hz"><code class="docutils literal notranslate"><span class="pre">Chorus.rate_hz</span></code></a></li>
<li><a class="reference internal" href="#pedalboard.Chorus.process"><code class="docutils literal notranslate"><span class="pre">Chorus.process()</span></code></a></li>
@@ -1462,6 +2018,9 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
</ul>
</li>
<li><a class="reference internal" href="#pedalboard.PluginContainer"><code class="docutils literal notranslate"><span class="pre">PluginContainer</span></code></a><ul>
+<li><a class="reference internal" href="#pedalboard.PluginContainer.append"><code class="docutils literal notranslate"><span class="pre">PluginContainer.append()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.PluginContainer.insert"><code class="docutils literal notranslate"><span class="pre">PluginContainer.insert()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.PluginContainer.remove"><code class="docutils literal notranslate"><span class="pre">PluginContainer.remove()</span></code></a></li>
<li><a class="reference internal" href="#pedalboard.PluginContainer.process"><code class="docutils literal notranslate"><span class="pre">PluginContainer.process()</span></code></a></li>
<li><a class="reference internal" href="#pedalboard.PluginContainer.reset"><code class="docutils literal notranslate"><span class="pre">PluginContainer.reset()</span></code></a></li>
</ul>
@@ -1475,10 +2034,10 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<li><a class="reference internal" href="#pedalboard.Resample.Quality.WindowedSinc"><code class="docutils literal notranslate"><span class="pre">Resample.Quality.WindowedSinc</span></code></a></li>
</ul>
</li>
-<li><a class="reference internal" href="#pedalboard.Resample.quality"><code class="docutils literal notranslate"><span class="pre">Resample.quality</span></code></a></li>
-<li><a class="reference internal" href="#pedalboard.Resample.target_sample_rate"><code class="docutils literal notranslate"><span class="pre">Resample.target_sample_rate</span></code></a></li>
<li><a class="reference internal" href="#pedalboard.Resample.process"><code class="docutils literal notranslate"><span class="pre">Resample.process()</span></code></a></li>
<li><a class="reference internal" href="#pedalboard.Resample.reset"><code class="docutils literal notranslate"><span class="pre">Resample.reset()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Resample.quality"><code class="docutils literal notranslate"><span class="pre">Resample.quality</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.Resample.target_sample_rate"><code class="docutils literal notranslate"><span class="pre">Resample.target_sample_rate</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pedalboard.Reverb"><code class="docutils literal notranslate"><span class="pre">Reverb</span></code></a><ul>
@@ -1486,6 +2045,15 @@ or buffer, set <code class="docutils literal notranslate"><span class="pre">rese
<li><a class="reference internal" href="#pedalboard.Reverb.reset"><code class="docutils literal notranslate"><span class="pre">Reverb.reset()</span></code></a></li>
</ul>
</li>
+<li><a class="reference internal" href="#pedalboard.VST3Plugin"><code class="docutils literal notranslate"><span class="pre">VST3Plugin</span></code></a><ul>
+<li><a class="reference internal" href="#pedalboard.VST3Plugin.get_plugin_names_for_file"><code class="docutils literal notranslate"><span class="pre">VST3Plugin.get_plugin_names_for_file()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.VST3Plugin.load_preset"><code class="docutils literal notranslate"><span class="pre">VST3Plugin.load_preset()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.VST3Plugin.name"><code class="docutils literal notranslate"><span class="pre">VST3Plugin.name</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.VST3Plugin.process"><code class="docutils literal notranslate"><span class="pre">VST3Plugin.process()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.VST3Plugin.reset"><code class="docutils literal notranslate"><span class="pre">VST3Plugin.reset()</span></code></a></li>
+<li><a class="reference internal" href="#pedalboard.VST3Plugin.show_editor"><code class="docutils literal notranslate"><span class="pre">VST3Plugin.show_editor()</span></code></a></li>
+</ul>
+</li>
</ul>
</li>
</ul>
diff --git a/docs/reference/pedalboard.io.html b/docs/reference/pedalboard.io.html
index 56d6902..fec3240 100644
--- a/docs/reference/pedalboard.io.html
+++ b/docs/reference/pedalboard.io.html
@@ -7,10 +7,8 @@
<meta property="og:type" content="website" />
<meta property="og:url" content="https://spotify.github.io/pedalboard/reference/pedalboard.io.html" />
<meta property="og:site_name" content="Pedalboard v0.6.8 Documentation" />
-<meta property="og:description" content="This module provides classes and functions for reading and writing audio files or streams. Introduced in v0.5.1." />
<meta property="og:image" content="https://repository-images.githubusercontent.com/383471193/0f79b949-9b91-4436-bfc4-05d30ef384cc" />
<meta property="og:image:alt" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
-<meta name="description" content="This module provides classes and functions for reading and writing audio files or streams. Introduced in v0.5.1." />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Examples" href="../examples.html" /><link rel="prev" title="The pedalboard API" href="pedalboard.html" />
<link rel="shortcut icon" href="../_static/favicon.ico"/><meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/>
@@ -213,8 +211,6 @@
<article role="main">
<section id="module-pedalboard.io">
<span id="the-pedalboard-io-api"></span><h1>The <code class="docutils literal notranslate"><span class="pre">pedalboard.io</span></code> API<a class="headerlink" href="#module-pedalboard.io" title="Permalink to this heading">#</a></h1>
-<p>This module provides classes and functions for reading and writing audio files or streams.</p>
-<p><em>Introduced in v0.5.1.</em></p>
<dl class="py class">
<dt class="sig sig-object py" id="pedalboard.io.AudioFile">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pedalboard.io.</span></span><span class="sig-name descname"><span class="pre">AudioFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_like</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BinaryIO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'r'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'r'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pedalboard.io.AudioFile" title="Permalink to this definition">#</a></dt>
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 459e152..ea81768 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["compatibility", "examples", "faq", "index", "internals", "license", "reference/pedalboard", "reference/pedalboard.io"], "filenames": ["compatibility.rst", "examples.rst", "faq.rst", "index.rst", "internals.rst", "license.rst", "reference/pedalboard.rst", "reference/pedalboard.io.rst"], "titles": ["Plugin Compatibility", "Examples", "Frequently Asked Questions", "Features", "Pedalboard Internals", "License", "The <code class=\"docutils literal notranslate\"><span class=\"pre\">pedalboard</span></code> API", "The <code class=\"docutils literal notranslate\"><span class=\"pre\">pedalboard.io</span></code> API"], "terms": {"pedalboard": [0, 3, 5], "allow": [0, 2, 3, 6, 7], "load": [0, 1, 3, 4], "vst3": [0, 3, 4, 5], "audio": [0, 3, 4, 5, 6, 7], "unit": [0, 2, 3, 4], "which": [0, 2, 5, 6, 7], "could": [0, 2, 6], "contain": [0, 1, 2, 6, 7], "ani": [0, 2, 4, 6, 7], "code": [0, 2, 4, 5], "most": [0, 2, 3, 4, 6, 7], "have": [0, 2, 4, 7], "been": [0, 7], "test": [0, 3, 4], "work": [0, 1, 3, 7], "just": [0, 1, 2, 4, 7], "fine": [0, 2], "some": [0, 1, 4, 7], "mai": [0, 4, 6, 7], "worst": [0, 7], "even": [0, 3], "crash": [0, 7], "python": [0, 1, 2, 3, 4, 7], "interpret": [0, 2, 3], "without": [0, 2, 3, 6, 7], "warn": 0, "abil": 0, "catch": 0, "error": 0, "ar": [0, 1, 2, 3, 4, 5, 6, 7], "well": [0, 3, 4, 7], "behav": [0, 1], "conform": 0, "set": [0, 1, 2, 6, 7], "convent": 0, "how": [0, 1, 6], "suppos": 0, "mani": [0, 3, 6, 7], "do": [0, 1, 7], "specif": [0, 6], "attempt": [0, 7], "detect": 0, "common": [0, 3], "program": [0, 1, 2], "can": [0, 1, 3, 4, 6, 7], "around": [0, 4, 6], "issu": [0, 2, 4], "includ": [0, 1, 2, 3, 4, 5], "automat": [0, 3, 7], "don": [0, 1, 7], "t": [0, 1, 2, 7], "clear": [0, 6], "intern": [0, 3, 6, 7], "state": [0, 6, 7], "when": [0, 2, 3, 4, 7], "ask": [0, 3], "so": [0, 1, 2, 7], "misbehav": 0, "notic": 0, "If": [0, 1, 3, 6, 7], "i": [0, 1, 2, 3, 4, 5, 6, 7], "being": 0, "render": [0, 7], "incorrectli": 0, "leak": [0, 7], "from": [0, 1, 2, 3, 5, 6, 7], "one": [0, 1, 3, 7], "process": [0, 1, 2, 3, 4, 5, 6, 7], "call": [0, 6, 7], "next": 0, "an": [0, 1, 2, 4, 6, 7], "undesir": 0, "fashion": [0, 2], "try": [0, 6], "pass": [0, 2, 6, 7], "silenc": 0, "between": [0, 2, 6, 7], "ensur": [0, 2, 4, 7], "reverb": [0, 1, 2, 3, 6], "tail": [0, 2, 6], "other": [0, 1, 3, 6, 7], "ha": [0, 6, 7], "time": [0, 1, 3, 6, 7], "fade": 0, "reload": 0, "everi": [0, 4, 7], "load_plugin": [0, 1, 3, 4], "import": [1, 2, 4], "choru": [1, 3, 6], "io": [1, 2, 3, 6], "audiofil": [1, 2, 7], "read": [1, 2, 3, 6, 7], "whole": 1, "file": [1, 2, 3, 4, 6, 7], "wav": [1, 2, 3, 7], "f": [1, 7], "frame": [1, 2, 7], "sampler": [1, 2, 7], "object": [1, 2, 6, 7], "multipl": [1, 2, 3, 6, 7], "board": [1, 2], "room_siz": [1, 6], "0": [1, 2, 6, 7], "25": [1, 6], "run": [1, 6], "through": [1, 2, 6, 7], "thi": [1, 2, 5, 6, 7], "write": [1, 2, 3, 6, 7], "back": [1, 6], "output": [1, 2, 6, 7], "w": [1, 2, 7], "shape": [1, 2, 7], "It": [1, 3], "smaller": [1, 2, 7], "resampl": [1, 3, 6, 7], "our": [1, 2], "desir": 1, "sampl": [1, 2, 6, 7], "rate": [1, 2, 6, 7], "44100": [1, 7], "input": [1, 2, 6, 7], "resampled_to": [1, 7], "pretti": 1, "interest": 1, "sound": [1, 6], "compressor": [1, 2, 3, 6], "threshold_db": [1, 6], "50": [1, 6], "ratio": [1, 6], "gain": [1, 3, 6], "gain_db": [1, 6], "30": 1, "ladderfilt": [1, 3, 6], "mode": [1, 6, 7], "hpf12": [1, 6], "cutoff_hz": [1, 6], "900": 1, "phaser": [1, 3, 6], "convolut": [1, 3, 6], "guitar_amp": 1, "1": [1, 2, 3, 6, 7], "like": [1, 6, 7], "list": [1, 6], "you": [1, 3, 7], "add": [1, 2, 3, 4, 6], "append": [1, 6, 7], "10": [1, 3, 6, 7], "limit": [1, 3, 6], "chang": [1, 3, 6, 7], "paramet": [1, 3, 6, 7], "easili": 1, "40": 1, "known": 1, "path": [1, 7], "disk": [1, 7], "vst": [1, 3, 5], "roughrider3": 1, "print": 1, "kei": 1, "dict_kei": 1, "sc_hpf_hz": 1, "input_lvl_db": 1, "sensitivity_db": 1, "attack_m": [1, 6], "release_m": [1, 6], "makeup_db": 1, "mix": [1, 6], "output_lvl_db": 1, "sc_activ": 1, "full_bandwidth": 1, "bypass": 1, "15": 1, "r": [1, 7], "put": 1, "same": [1, 4, 6, 7], "instanc": [1, 4, 6, 7], "delai": [1, 2, 3, 6], "pitch": [1, 3, 6], "shift": [1, 6], "themselv": 1, "nest": 1, "them": 1, "much": [1, 6], "distort": [1, 3, 6], "pitchshift": [1, 3, 5, 6], "passthrough": 1, "delay_and_pitch_shift": 1, "delay_second": [1, 6], "semiton": [1, 6], "7": [1, 3, 6], "3": [1, 3, 6], "delay_longer_and_more_pitch_shift": 1, "5": [1, 6, 7], "12": [1, 6], "6": [1, 3, 5, 6, 7], "front": 1, "all": [1, 2, 3, 4, 6, 7], "simultan": 1, "final": 1, "For": [1, 6, 7], "more": [1, 3, 4, 6, 7], "see": [1, 2, 6, 7], "folder": 1, "repositori": [1, 4], "demo": 1, "colab": 1, "notebook": 1, "interact": 1, "web": 1, "hug": 1, "face": 1, "space": 1, "gradio": 1, "via": [1, 3, 6, 7], "ak391": 1, "technic": 2, "ye": 2, "pull": [2, 5], "request": 2, "98": 2, "experiment": [2, 3], "interfac": [2, 4], "written": [2, 4, 7], "c": [2, 4], "stefanobazzi": 2, "guitarboard": 2, "project": [2, 5], "exampl": [2, 3, 4, 7], "sounddevic": 2, "librari": [2, 3, 4, 5, 6, 7], "howev": 2, "coupl": 2, "big": 2, "caveat": 2, "talk": 2, "about": [1, 2], "context": 2, "languag": 2, "garbag": 2, "collect": 2, "mean": 2, "your": 2, "randomli": 2, "paus": 2, "regular": [1, 2, 7], "interv": 2, "clean": 2, "up": [2, 3, 6], "unus": [2, 7], "In": 2, "result": [2, 7], "random": [2, 7], "pop": 2, "click": 2, "drop": 2, "out": [2, 3, 6, 7], "veri": 2, "difficult": 2, "prevent": [2, 7], "global": [2, 3], "lock": [2, 3], "also": [2, 3, 4, 6, 7], "potenti": [2, 7], "unbound": [2, 7], "switch": 2, "thread": [2, 3, 4], "oper": [2, 7], "system": [2, 7], "separ": 2, "high": [2, 6], "prioriti": 2, "block": 2, "caus": [2, 6, 7], "stutter": 2, "access": 2, "mutat": 2, "note": [1, 2, 6, 7], "applic": [2, 4], "stream": [2, 3, 6, 7], "larg": [2, 7], "buffer": [2, 6, 7], "size": [2, 4, 6], "second": [1, 2, 6, 7], "soft": 2, "requir": [2, 3, 4, 6, 7], "case": [2, 3, 4, 6], "network": 2, "data": [2, 3, 7], "offlin": 2, "chunk": [1, 2, 6, 7], "while": [1, 2, 6, 7], "built": [2, 3], "function": [2, 4, 6, 7], "possibl": [2, 3, 7], "vari": 2, "manual": [2, 3], "tqdm": 2, "step": 2, "would": [2, 4, 6, 7], "give": [2, 6], "smoother": 2, "transit": 2, "expens": [2, 6], "speed": [2, 3, 4, 6], "step_size_in_sampl": 2, "100": [2, 6, 7], "_n_": 2, "af": 2, "open": [1, 2, 4, 7], "we": 2, "directli": [2, 6, 7], "save": 2, "memori": [2, 3, 6, 7], "num_channel": [1, 2, 7], "o": [1, 2, 3, 6, 7], "creat": [2, 3, 6, 7], "progress": 2, "bar": 2, "show": [2, 4], "total": [2, 7], "pbar": 2, "rang": [2, 3, 6], "wet": [2, 6], "equal": [2, 3, 6, 7], "percentag": [2, 6], "track": 2, "e": [2, 6, 7], "make": [2, 3], "ramp": 2, "percentage_through_track": 2, "wet_level": [2, 6], "updat": 2, "number": [2, 3, 5, 6, 7], "receiv": [2, 6], "reset": [1, 2, 6, 7], "fals": [1, 2, 6, 7], "aren": 2, "cut": [2, 6], "off": [2, 6], "With": 2, "techniqu": [2, 6], "autom": 2, "usual": [2, 7], "somewher": 2, "000": [2, 7], "2m": 2, "22m": 2, "44": [2, 6, 7], "1khz": [2, 6], "small": 2, "enough": 2, "avoid": [2, 7], "hear": 2, "artifact": [2, 6], "slow": [2, 6], "down": 2, "dramat": 2, "Not": [2, 4, 6, 7], "yet": 2, "The": [2, 4, 5], "underli": [2, 7], "framework": 2, "juce": [2, 4, 5], "au": [2, 7], "itself": [2, 4, 6], "modifi": 2, "either": [2, 7], "although": [2, 6, 7], "ad": [3, 6, 7], "effect": [3, 4, 6, 7], "support": [3, 4, 6, 7], "popular": 3, "format": [3, 6, 7], "box": 3, "us": [3, 4, 5, 6, 7], "third": 3, "parti": 3, "plugin": [3, 5, 6], "wa": [3, 7], "spotifi": [1, 3, 5], "": [3, 4, 6, 7], "intellig": 3, "lab": 3, "enabl": 3, "studio": 3, "qualiti": [3, 6, 7], "within": [3, 4], "tensorflow": 3, "augment": 3, "improv": 3, "machin": [3, 4], "learn": [3, 4], "model": [3, 6], "help": 3, "content": [3, 7], "creation": 3, "digit": [3, 4, 6], "workstat": 3, "util": [3, 6], "aiff": [3, 7], "flac": [3, 7], "mp3": [3, 6, 7], "ogg": [3, 7], "platform": [3, 4, 7], "depend": [3, 4, 6, 7], "addit": [3, 4, 7], "aac": [3, 7], "ac3": [3, 7], "wma": [3, 7], "fly": [3, 7], "usag": [3, 6], "basic": [3, 6, 7], "transform": 3, "guitar": 3, "style": 3, "clip": [3, 6], "loud": [3, 6], "dynam": [3, 6], "filter": [3, 6], "highpassfilt": [3, 6], "lowpassfilt": [3, 6], "spatial": 3, "lossi": [3, 6], "compress": [3, 6, 7], "gsmfullratecompressor": [3, 5, 6], "mp3compressor": [3, 5, 6], "reduct": [3, 6], "bitcrush": [3, 6], "maco": [3, 4, 7], "window": [3, 4, 7], "linux": [3, 4, 7], "strong": 3, "safeti": 3, "guarante": 3, "releas": [3, 6], "gil": 3, "cpu": 3, "core": [3, 5], "No": [3, 6], "need": [3, 4], "multiprocess": 3, "onli": [3, 6, 7], "300x": 3, "faster": 3, "than": [3, 4, 6, 7], "pysox": 3, "singl": 3, "2": [3, 6, 7], "5x": 3, "soxbind": 3, "icorv": 3, "4x": 3, "librosa": 3, "tf": 3, "pipelin": 3, "avail": [3, 4, 6], "pypi": 3, "wheel": [3, 4], "pip": 3, "That": 3, "new": [3, 7], "follow": [3, 4, 5], "md": 3, "robust": 3, "guid": 3, "thoroughli": 3, "8": [3, 6], "9": 3, "11": 3, "heavili": 3, "product": 3, "github": [1, 3], "manylinux": 3, "x86_64": 3, "intel": 3, "amd": 3, "aarch64": 3, "arm": 3, "appl": 3, "silicon": 3, "rel": 3, "modern": 3, "glibc": 3, "27": 3, "both": [3, 6], "wide": 3, "amd64": 3, "x86": 3, "64": [3, 6], "api": [3, 4], "quick": 3, "start": [3, 7], "parallel": [3, 6], "chain": [3, 6], "frequent": 3, "question": 3, "live": 3, "real": [3, 6, 7], "doe": [3, 4, 7], "over": 3, "instrument": 3, "instead": [1, 3, 6, 7], "accept": [3, 6, 7], "midi": 3, "design": [3, 6], "consider": 3, "licens": [3, 4], "repo": 3, "wrapper": 4, "sourc": [4, 7], "cross": 4, "develop": 4, "pybind11": 4, "bind": 4, "goal": 4, "expos": 4, "signal": [4, 6], "idiomat": 4, "wai": 4, "provid": [4, 6, 7], "raw": [4, 7], "perform": 4, "dsp": 4, "hide": 4, "complex": 4, "programm": 4, "intuit": 4, "varieti": 4, "reason": 4, "wider": 4, "compat": [4, 5], "notabl": 4, "rare": 4, "fewer": [4, 6], "simpler": 4, "remov": [4, 6], "copi": 4, "associ": 4, "resourc": 4, "option": [4, 7], "might": 4, "meant": 4, "music": 4, "appropri": 4, "vice": 4, "versa": 4, "stabil": 4, "environ": 4, "where": 4, "implement": [4, 6], "logic": 4, "portabl": 4, "safe": 4, "constraint": 4, "should": [4, 6, 7], "consid": [4, 6, 7], "gplv3": [4, 5], "static": [4, 5], "link": 4, "vendor": 4, "git": 4, "submodul": 4, "binari": [4, 7], "distribut": 4, "Will": [4, 7], "increas": [4, 6, 7], "amount": [4, 6, 7], "compil": [4, 5], "runtim": 4, "cannot": 4, "user": 4, "instal": [4, 7], "softwar": 4, "complic": 4, "simplic": 4, "packag": [4, 7], "copyright": 5, "2021": 5, "2022": [1, 5], "ab": 5, "under": [5, 7], "gnu": 5, "gener": [5, 6], "public": 5, "v3": 5, "carri": 5, "dual": 5, "commerci": 5, "sdk": 5, "bundl": 5, "own": [5, 6], "steinberg": 5, "media": 5, "technologi": 5, "gmbh": 5, "rubber": [5, 6], "band": [5, 6], "gplv2": 5, "newer": 5, "libmp3lam": 5, "lame": [5, 6, 7], "lgplv2": 5, "upgrad": 5, "inclus": 5, "permit": 5, "libgsm": 5, "isc": 5, "regist": 5, "trademark": 5, "modul": [6, 7], "class": [6, 7], "subclass": 6, "each": [6, 7], "appli": 6, "audiounitplugin": [], "path_to_plugin_fil": [], "str": [6, 7], "parameter_valu": [], "dict": [], "union": 7, "int": [1, 6, 7], "float": [6, 7], "bool": [6, 7], "plugin_nam": [], "none": [6, 7], "A": [6, 7], "non": [6, 7], "unavail": [], "must": [6, 7], "loadabl": [], "plug": 7, "Ins": [], "compon": [], "vst3plugin": [], "get_plugin_names_for_fil": [], "filenam": 7, "return": [6, 7], "name": 7, "given": [6, 7], "scan": [], "importerror": [], "rais": 7, "insid": 6, "method": [6, 7], "determin": 6, "present": [], "what": [], "properti": [6, 7], "report": [], "self": 6, "pedalboard_n": 6, "input_arrai": 6, "numpi": [6, 7], "ndarrai": [6, 7], "sample_r": 6, "buffer_s": 6, "8192": 6, "true": [6, 7], "float32": [6, 7], "32": [6, 7], "bit": [6, 7], "point": [6, 7], "arrai": [6, 7], "were": 6, "expect": [6, 7], "To": [6, 7], "remain": [6, 7], "anoth": 6, "datatyp": [6, 7], "convert": [6, 7], "argument": [6, 7], "control": 6, "higher": 6, "flag": 6, "befor": [6, 7], "begin": [6, 7], "previou": 6, "store": [6, 7], "g": 6, "line": [6, 7], "lfo": 6, "etc": [6, 7], "valu": [6, 7], "unchang": 6, "show_editor": [], "_audiounitplugin": [], "ui": [], "nativ": 7, "until": 1, "close": 7, "keyboardinterrupt": [], "bit_depth": [6, 7], "reduc": 6, "depth": [6, 7], "lo": 6, "fi": 6, "vertic": 6, "resolut": 6, "uniqu": 6, "repres": 6, "horizont": 6, "per": [6, 7], "quantiz": 6, "integ": [6, 7], "decim": 6, "onto": 6, "dtype": [6, 7], "zero": 6, "plugincontain": 6, "arg0": 6, "insert": 6, "index": 6, "arg": [], "kwarg": [], "overload": [], "float64": 7, "rate_hz": 6, "centre_delay_m": 6, "feedback": 6, "frequenc": 6, "respons": 6, "centr": 6, "get": 6, "classic": 6, "m": 6, "low": 6, "feeback": 6, "volum": 6, "flanger": 6, "lower": 6, "lot": 6, "vibrato": 6, "oscil": 6, "hertz": 6, "hz": [6, 7], "hard": [6, 7], "threshold": 6, "decibel": 6, "algorithm": [6, 7], "introduc": [6, 7], "nois": 6, "gsmcompressor": 6, "impulse_response_filenam": 6, "suitabl": 6, "thing": 6, "speaker": 6, "simul": 6, "dry": 6, "drive_db": 6, "linear": [6, 7], "tanh": 6, "hyperbol": 6, "tangent": 6, "waveshap": 6, "harmon": 6, "pleas": 6, "produc": 6, "roughli": 6, "equival": 6, "def": 6, "x": 6, "db_to_gain": 6, "windowedsinc": [6, 7], "4": 6, "degrad": 6, "gsm": 6, "full": 6, "emul": 6, "2g": 6, "cellular": 6, "phone": 6, "connect": 6, "fix": 6, "8khz": 6, "codec": [6, 7], "specifi": [6, 7], "decreas": [6, 7], "amplifi": 6, "attenu": 6, "think": 6, "highshelffilt": 6, "cutoff_frequency_hz": 6, "440": 6, "q": 6, "7071067690849304": 6, "shelf": 6, "variabl": [6, 7], "abov": 6, "cutoff": 6, "boost": 6, "first": 6, "order": 6, "roll": 6, "6db": 6, "octav": 6, "3db": 6, "frac": 6, "sqrt": 6, "express": 6, "factor": 6, "further": [6, 7], "iirfilt": 6, "abstract": 6, "variou": 6, "kind": 6, "infinit": 6, "impuls": 6, "iir": 6, "lowshelffilt": 6, "peakfilt": 6, "invert": 6, "flip": 6, "polar": 6, "audibl": 6, "its": [6, 7], "take": 6, "mathemat": 6, "ident": [6, 7], "cancel": 6, "origin": [6, 7], "lpf12": 6, "200": 6, "reson": 6, "drive": 6, "multi": [6, 7], "base": [6, 7], "moog": 6, "synthes": 6, "ladder": 6, "invent": 6, "dr": 6, "bob": 6, "1968": 6, "below": 6, "side": 6, "peak": 6, "type": [6, 7], "architectur": 6, "db": 6, "bpf12": 6, "lpf24": 6, "24": 6, "hpf24": 6, "bpf24": 6, "simpl": 6, "standard": 6, "featur": 6, "two": 6, "clipper": 6, "707x": 6, "vbr_qualiti": 6, "encod": [6, 7], "current": [6, 7], "vbr": 6, "better": 6, "32khz": 6, "48khz": 6, "unsupport": [6, 7], "except": [6, 7], "thrown": 6, "noiseg": 6, "gate": 6, "attack": 6, "expand": 6, "notch": 6, "centre_frequency_hz": 6, "1300": 6, "stage": 6, "sweep": 6, "magnitud": 6, "affect": 6, "durat": [6, 7], "chri": 6, "cannam": 6, "wonder": 6, "stretch": 6, "intend": 6, "direct": 6, "target_sample_r": [6, 7], "8000": 6, "downsampl": 6, "upsampl": 6, "alias": 6, "indic": [6, 7], "zeroorderhold": 6, "lowest": 6, "fastest": [6, 7], "slightli": 6, "less": 6, "noisi": 6, "simplest": 6, "catmullrom": 6, "moder": 6, "good": 6, "fast": 6, "lagrang": 6, "highest": 6, "slowest": [6, 7], "still": 6, "mere": 6, "damp": 6, "33": 6, "dry_level": 6, "width": 6, "freeze_mod": 6, "stereo": [6, 7], "tune": 6, "freeverb": 6, "http": [1, 6], "ccrma": 6, "stanford": 6, "edu": 6, "jo": 6, "pasp": 6, "html": [1, 6], "_": [1, 6], "differ": 7, "build": [], "load_preset": [], "_vst3plugin": [], "preset_file_path": [], "preset": [], "vstpreset": [], "externalplugin": [], "dictionari": [], "initi": [], "after": [], "match": 7, "normal": [], "string": 7, "identifi": [], "These": [], "throw": 7, "found": [], "runtimeerror": 7, "v0": 7, "file_lik": 7, "binaryio": 7, "liter": 7, "16": 7, "readabl": 7, "writeabl": 7, "default": 7, "unlik": 7, "typic": 7, "trail": 7, "b": 7, "redund": 7, "exist": 7, "seekabl": 7, "stringio": 7, "my_fil": 7, "first_ten_second": 7, "ogg_buff": 7, "bytesio": 7, "get_audio_buff": 7, "22_050": 7, "white_nois": 7, "np": 7, "rand": 7, "wav_buff": 7, "getvalu": 7, "someth": 7, "160": 7, "kilobit": 7, "re": 7, "four": 7, "tell": [1, 7], "1024": 7, "readableaudiofil": 7, "cross_platform_formats_onli": 7, "wrap": 7, "vorbi": 7, "3g2": 7, "3gp": 7, "adt": 7, "aif": 7, "aifc": 7, "amr": 7, "bwf": 7, "caf": 7, "ec3": 7, "latm": 7, "loa": 7, "m4a": 7, "m4b": 7, "m4r": 7, "mov": 7, "mp1": 7, "mp2": 7, "mp4": 7, "mpa": 7, "mpeg": 7, "qt": 7, "sd2": 7, "snd": 7, "w64": 7, "xhe": 7, "get_supported_read_format": 7, "extens": 7, "pars": 7, "consist": 7, "constructor": 7, "certain": 7, "probabl": 7, "want": 7, "too": 7, "d": [1, 7], "num_fram": 7, "channel": 7, "posit": 7, "decept": 7, "hour": 7, "long": 7, "hand": 7, "megabyt": 7, "decompress": 7, "nearli": 7, "gigabyt": 7, "rather": [1, 7], "onc": 7, "debug": 7, "problem": 7, "dimension": 7, "length": 7, "alwai": 7, "minimum": 7, "0f": 7, "maximum": 7, "read_raw": 7, "int8": 7, "int16": 7, "int32": 7, "resampledreadableaudiofil": 7, "constant": 7, "seek": 7, "locat": 7, "futur": 7, "pointer": 7, "iff": 7, "longer": 7, "usabl": 7, "otherwis": 7, "divid": 7, "file_dtyp": 7, "regardless": 7, "441": 7, "audio_fil": 7, "resampling_qu": 7, "22050": 7, "fraction": 7, "hood": 7, "streamresampl": 7, "obtain": 7, "entir": 7, "benefit": 7, "target": 7, "As": 7, "version": 7, "respect": 7, "push": 7, "accur": 7, "optim": 7, "22": 7, "050": 7, "source_sample_r": 7, "seri": 7, "flush": 7, "input_lat": 7, "suppli": 7, "writeableaudiofil": 7, "get_supported_write_format": 7, "filename_or_file_lik": 7, "assum": 7, "level": 7, "numer": 7, "128": 7, "256": 7, "advanc": 7, "v2": 7, "best": 7, "happen": 7, "reliabl": 7, "forc": 7, "occur": 7, "typeerror": 7, "far": 7, "increment": 7, "kbp": 7, "v9": 7, "aupreset": [], "preset_st": [], "audiounit": [], "bytestr": [], "watch": 1, "video": 1, "document": 1, "feat": 1, "youtub": 1, "empti": 1, "inform": 1, "refer": 1, "member": [], "peter": 1, "sobot": 1, "europython": 1, "contribut": 3}, "objects": {"": [[6, 0, 0, "-", "pedalboard"]], "pedalboard": [[6, 1, 1, "", "Bitcrush"], [6, 1, 1, "", "Chorus"], [6, 1, 1, "", "Clipping"], [6, 1, 1, "", "Compressor"], [6, 1, 1, "", "Convolution"], [6, 1, 1, "", "Delay"], [6, 1, 1, "", "Distortion"], [6, 1, 1, "", "GSMFullRateCompressor"], [6, 1, 1, "", "Gain"], [6, 1, 1, "", "HighShelfFilter"], [6, 1, 1, "", "HighpassFilter"], [6, 1, 1, "", "IIRFilter"], [6, 1, 1, "", "Invert"], [6, 1, 1, "", "LadderFilter"], [6, 1, 1, "", "Limiter"], [6, 1, 1, "", "LowShelfFilter"], [6, 1, 1, "", "LowpassFilter"], [6, 1, 1, "", "MP3Compressor"], [6, 1, 1, "", "Mix"], [6, 1, 1, "", "NoiseGate"], [6, 1, 1, "", "PeakFilter"], [6, 1, 1, "", "Phaser"], [6, 1, 1, "", "PitchShift"], [6, 1, 1, "", "Plugin"], [6, 1, 1, "", "PluginContainer"], [6, 1, 1, "", "Resample"], [6, 1, 1, "", "Reverb"], [7, 0, 0, "-", "io"]], "pedalboard.Bitcrush": [[6, 2, 1, "", "bit_depth"], [6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Chorus": [[6, 3, 1, "", "process"], [6, 2, 1, "", "rate_hz"], [6, 3, 1, "", "reset"]], "pedalboard.Clipping": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Compressor": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Convolution": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Delay": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Distortion": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.GSMFullRateCompressor": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Gain": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.HighShelfFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.HighpassFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.IIRFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Invert": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.LadderFilter": [[6, 1, 1, "", "Mode"], [6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.LadderFilter.Mode": [[6, 4, 1, "", "BPF12"], [6, 4, 1, "", "BPF24"], [6, 4, 1, "", "HPF12"], [6, 4, 1, "", "HPF24"], [6, 4, 1, "", "LPF12"], [6, 4, 1, "", "LPF24"]], "pedalboard.Limiter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.LowShelfFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.LowpassFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.MP3Compressor": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Mix": [[6, 3, 1, "", "append"], [6, 3, 1, "", "insert"], [6, 3, 1, "", "process"], [6, 3, 1, "", "remove"], [6, 3, 1, "", "reset"]], "pedalboard.NoiseGate": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.PeakFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Phaser": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.PitchShift": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Plugin": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.PluginContainer": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Resample": [[6, 1, 1, "", "Quality"], [6, 3, 1, "", "process"], [6, 2, 1, "", "quality"], [6, 3, 1, "", "reset"], [6, 2, 1, "", "target_sample_rate"]], "pedalboard.Resample.Quality": [[6, 4, 1, "", "CatmullRom"], [6, 4, 1, "", "Lagrange"], [6, 4, 1, "", "Linear"], [6, 4, 1, "", "WindowedSinc"], [6, 4, 1, "", "ZeroOrderHold"]], "pedalboard.Reverb": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.io": [[7, 1, 1, "", "AudioFile"], [7, 1, 1, "", "ReadableAudioFile"], [7, 1, 1, "", "ResampledReadableAudioFile"], [7, 1, 1, "", "StreamResampler"], [7, 1, 1, "", "WriteableAudioFile"]], "pedalboard.io.ReadableAudioFile": [[7, 3, 1, "", "close"], [7, 2, 1, "", "closed"], [7, 2, 1, "", "duration"], [7, 2, 1, "", "file_dtype"], [7, 2, 1, "", "frames"], [7, 2, 1, "", "name"], [7, 2, 1, "", "num_channels"], [7, 3, 1, "", "read"], [7, 3, 1, "", "read_raw"], [7, 3, 1, "", "resampled_to"], [7, 2, 1, "", "samplerate"], [7, 3, 1, "", "seek"], [7, 3, 1, "", "seekable"], [7, 3, 1, "", "tell"]], "pedalboard.io.ResampledReadableAudioFile": [[7, 3, 1, "", "close"], [7, 2, 1, "", "closed"], [7, 2, 1, "", "duration"], [7, 2, 1, "", "file_dtype"], [7, 2, 1, "", "frames"], [7, 2, 1, "", "name"], [7, 2, 1, "", "num_channels"], [7, 3, 1, "", "read"], [7, 2, 1, "", "resampling_quality"], [7, 2, 1, "", "samplerate"], [7, 3, 1, "", "seek"], [7, 3, 1, "", "seekable"], [7, 3, 1, "", "tell"]], "pedalboard.io.StreamResampler": [[7, 2, 1, "", "input_latency"], [7, 2, 1, "", "num_channels"], [7, 3, 1, "", "process"], [7, 2, 1, "", "quality"], [7, 3, 1, "", "reset"], [7, 2, 1, "", "source_sample_rate"], [7, 2, 1, "", "target_sample_rate"]], "pedalboard.io.WriteableAudioFile": [[7, 3, 1, "", "close"], [7, 2, 1, "", "closed"], [7, 2, 1, "", "file_dtype"], [7, 3, 1, "", "flush"], [7, 2, 1, "", "frames"], [7, 2, 1, "", "num_channels"], [7, 2, 1, "", "quality"], [7, 2, 1, "", "samplerate"], [7, 3, 1, "", "write"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:property", "3": "py:method", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "property", "Python property"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"]}, "titleterms": {"plugin": [0, 1, 2, 4], "compat": [0, 3], "exampl": 1, "quick": 1, "start": 1, "make": 1, "guitar": 1, "style": 1, "pedalboard": [1, 2, 4, 6, 7], "us": [1, 2], "vst3": 1, "audio": [1, 2], "unit": 1, "creat": 1, "parallel": 1, "effect": [1, 2], "chain": 1, "frequent": 2, "ask": 2, "question": 2, "can": 2, "live": 2, "real": 2, "time": 2, "doe": 2, "support": 2, "chang": 2, "": 2, "paramet": 2, "over": 2, "vst": 2, "instrument": 2, "instead": 2, "accept": 2, "midi": 2, "featur": 3, "instal": 3, "refer": 3, "document": 3, "intern": 4, "ad": 4, "new": 4, "built": 4, "design": 4, "consider": 4, "licens": 5, "The": [6, 7], "api": [6, 7], "io": 7, "put": [], "compressor": [], "front": [], "run": [], "all": [], "simultan": [], "mix": [], "contribut": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Plugin Compatibility": [[0, "plugin-compatibility"]], "Examples": [[1, "examples"]], "Quick start": [[1, "quick-start"]], "Making a guitar-style pedalboard": [[1, "making-a-guitar-style-pedalboard"]], "Using VST3\u00ae or Audio Unit plugins": [[1, "using-vst3-or-audio-unit-plugins"]], "Creating parallel effects chains": [[1, "creating-parallel-effects-chains"]], "Contributing": [[1, "contributing"]], "Frequently Asked Questions": [[2, "frequently-asked-questions"]], "Can Pedalboard be used with live (real-time) audio?": [[2, "can-pedalboard-be-used-with-live-real-time-audio"]], "Does Pedalboard support changing a plugin\u2019s parameters over time?": [[2, "does-pedalboard-support-changing-a-plugin-s-parameters-over-time"]], "Can Pedalboard be used with VST instruments, instead of effects?": [[2, "can-pedalboard-be-used-with-vst-instruments-instead-of-effects"]], "Can Pedalboard plugins accept MIDI?": [[2, "can-pedalboard-plugins-accept-midi"]], "Features": [[3, "features"]], "Installation": [[3, "installation"]], "Compatibility": [[3, "compatibility"]], "Reference": [[3, "reference"]], "Documentation": [[3, "documentation"]], "Pedalboard Internals": [[4, "pedalboard-internals"]], "Adding new built-in Pedalboard plugins": [[4, "adding-new-built-in-pedalboard-plugins"]], "Design considerations": [[4, "design-considerations"]], "License": [[5, "license"]], "The pedalboard API": [[6, "module-pedalboard"]], "The pedalboard.io API": [[7, "module-pedalboard.io"]]}, "indexentries": {"bpf12 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.BPF12"]], "bpf24 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.BPF24"]], "bitcrush (class in pedalboard)": [[6, "pedalboard.Bitcrush"]], "catmullrom (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.CatmullRom"]], "chorus (class in pedalboard)": [[6, "pedalboard.Chorus"]], "clipping (class in pedalboard)": [[6, "pedalboard.Clipping"]], "compressor (class in pedalboard)": [[6, "pedalboard.Compressor"]], "convolution (class in pedalboard)": [[6, "pedalboard.Convolution"]], "delay (class in pedalboard)": [[6, "pedalboard.Delay"]], "distortion (class in pedalboard)": [[6, "pedalboard.Distortion"]], "gsmfullratecompressor (class in pedalboard)": [[6, "pedalboard.GSMFullRateCompressor"]], "gain (class in pedalboard)": [[6, "pedalboard.Gain"]], "hpf12 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.HPF12"]], "hpf24 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.HPF24"]], "highshelffilter (class in pedalboard)": [[6, "pedalboard.HighShelfFilter"]], "highpassfilter (class in pedalboard)": [[6, "pedalboard.HighpassFilter"]], "iirfilter (class in pedalboard)": [[6, "pedalboard.IIRFilter"]], "invert (class in pedalboard)": [[6, "pedalboard.Invert"]], "lpf12 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.LPF12"]], "lpf24 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.LPF24"]], "ladderfilter (class in pedalboard)": [[6, "pedalboard.LadderFilter"]], "ladderfilter.mode (class in pedalboard)": [[6, "pedalboard.LadderFilter.Mode"]], "lagrange (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.Lagrange"]], "limiter (class in pedalboard)": [[6, "pedalboard.Limiter"]], "linear (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.Linear"]], "lowshelffilter (class in pedalboard)": [[6, "pedalboard.LowShelfFilter"]], "lowpassfilter (class in pedalboard)": [[6, "pedalboard.LowpassFilter"]], "mp3compressor (class in pedalboard)": [[6, "pedalboard.MP3Compressor"]], "mix (class in pedalboard)": [[6, "pedalboard.Mix"]], "noisegate (class in pedalboard)": [[6, "pedalboard.NoiseGate"]], "peakfilter (class in pedalboard)": [[6, "pedalboard.PeakFilter"]], "phaser (class in pedalboard)": [[6, "pedalboard.Phaser"]], "pitchshift (class in pedalboard)": [[6, "pedalboard.PitchShift"]], "plugin (class in pedalboard)": [[6, "pedalboard.Plugin"]], "plugincontainer (class in pedalboard)": [[6, "pedalboard.PluginContainer"]], "resample (class in pedalboard)": [[6, "pedalboard.Resample"]], "resample.quality (class in pedalboard)": [[6, "pedalboard.Resample.Quality"]], "reverb (class in pedalboard)": [[6, "pedalboard.Reverb"]], "windowedsinc (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.WindowedSinc"]], "zeroorderhold (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.ZeroOrderHold"]], "append() (pedalboard.mix method)": [[6, "pedalboard.Mix.append"]], "bit_depth (pedalboard.bitcrush property)": [[6, "pedalboard.Bitcrush.bit_depth"]], "insert() (pedalboard.mix method)": [[6, "pedalboard.Mix.insert"]], "module": [[6, "module-pedalboard"], [7, "module-pedalboard.io"]], "pedalboard": [[6, "module-pedalboard"]], "process() (pedalboard.bitcrush method)": [[6, "pedalboard.Bitcrush.process"]], "process() (pedalboard.chorus method)": [[6, "pedalboard.Chorus.process"]], "process() (pedalboard.clipping method)": [[6, "pedalboard.Clipping.process"]], "process() (pedalboard.compressor method)": [[6, "pedalboard.Compressor.process"]], "process() (pedalboard.convolution method)": [[6, "pedalboard.Convolution.process"]], "process() (pedalboard.delay method)": [[6, "pedalboard.Delay.process"]], "process() (pedalboard.distortion method)": [[6, "pedalboard.Distortion.process"]], "process() (pedalboard.gsmfullratecompressor method)": [[6, "pedalboard.GSMFullRateCompressor.process"]], "process() (pedalboard.gain method)": [[6, "pedalboard.Gain.process"]], "process() (pedalboard.highshelffilter method)": [[6, "pedalboard.HighShelfFilter.process"]], "process() (pedalboard.highpassfilter method)": [[6, "pedalboard.HighpassFilter.process"]], "process() (pedalboard.iirfilter method)": [[6, "pedalboard.IIRFilter.process"]], "process() (pedalboard.invert method)": [[6, "pedalboard.Invert.process"]], "process() (pedalboard.ladderfilter method)": [[6, "pedalboard.LadderFilter.process"]], "process() (pedalboard.limiter method)": [[6, "pedalboard.Limiter.process"]], "process() (pedalboard.lowshelffilter method)": [[6, "pedalboard.LowShelfFilter.process"]], "process() (pedalboard.lowpassfilter method)": [[6, "pedalboard.LowpassFilter.process"]], "process() (pedalboard.mp3compressor method)": [[6, "pedalboard.MP3Compressor.process"]], "process() (pedalboard.mix method)": [[6, "pedalboard.Mix.process"]], "process() (pedalboard.noisegate method)": [[6, "pedalboard.NoiseGate.process"]], "process() (pedalboard.peakfilter method)": [[6, "pedalboard.PeakFilter.process"]], "process() (pedalboard.phaser method)": [[6, "pedalboard.Phaser.process"]], "process() (pedalboard.pitchshift method)": [[6, "pedalboard.PitchShift.process"]], "process() (pedalboard.plugin method)": [[6, "pedalboard.Plugin.process"]], "process() (pedalboard.plugincontainer method)": [[6, "pedalboard.PluginContainer.process"]], "process() (pedalboard.resample method)": [[6, "pedalboard.Resample.process"]], "process() (pedalboard.reverb method)": [[6, "pedalboard.Reverb.process"]], "quality (pedalboard.resample property)": [[6, "pedalboard.Resample.quality"]], "rate_hz (pedalboard.chorus property)": [[6, "pedalboard.Chorus.rate_hz"]], "remove() (pedalboard.mix method)": [[6, "pedalboard.Mix.remove"]], "reset() (pedalboard.bitcrush method)": [[6, "pedalboard.Bitcrush.reset"]], "reset() (pedalboard.chorus method)": [[6, "pedalboard.Chorus.reset"]], "reset() (pedalboard.clipping method)": [[6, "pedalboard.Clipping.reset"]], "reset() (pedalboard.compressor method)": [[6, "pedalboard.Compressor.reset"]], "reset() (pedalboard.convolution method)": [[6, "pedalboard.Convolution.reset"]], "reset() (pedalboard.delay method)": [[6, "pedalboard.Delay.reset"]], "reset() (pedalboard.distortion method)": [[6, "pedalboard.Distortion.reset"]], "reset() (pedalboard.gsmfullratecompressor method)": [[6, "pedalboard.GSMFullRateCompressor.reset"]], "reset() (pedalboard.gain method)": [[6, "pedalboard.Gain.reset"]], "reset() (pedalboard.highshelffilter method)": [[6, "pedalboard.HighShelfFilter.reset"]], "reset() (pedalboard.highpassfilter method)": [[6, "pedalboard.HighpassFilter.reset"]], "reset() (pedalboard.iirfilter method)": [[6, "pedalboard.IIRFilter.reset"]], "reset() (pedalboard.invert method)": [[6, "pedalboard.Invert.reset"]], "reset() (pedalboard.ladderfilter method)": [[6, "pedalboard.LadderFilter.reset"]], "reset() (pedalboard.limiter method)": [[6, "pedalboard.Limiter.reset"]], "reset() (pedalboard.lowshelffilter method)": [[6, "pedalboard.LowShelfFilter.reset"]], "reset() (pedalboard.lowpassfilter method)": [[6, "pedalboard.LowpassFilter.reset"]], "reset() (pedalboard.mp3compressor method)": [[6, "pedalboard.MP3Compressor.reset"]], "reset() (pedalboard.mix method)": [[6, "pedalboard.Mix.reset"]], "reset() (pedalboard.noisegate method)": [[6, "pedalboard.NoiseGate.reset"]], "reset() (pedalboard.peakfilter method)": [[6, "pedalboard.PeakFilter.reset"]], "reset() (pedalboard.phaser method)": [[6, "pedalboard.Phaser.reset"]], "reset() (pedalboard.pitchshift method)": [[6, "pedalboard.PitchShift.reset"]], "reset() (pedalboard.plugin method)": [[6, "pedalboard.Plugin.reset"]], "reset() (pedalboard.plugincontainer method)": [[6, "pedalboard.PluginContainer.reset"]], "reset() (pedalboard.resample method)": [[6, "pedalboard.Resample.reset"]], "reset() (pedalboard.reverb method)": [[6, "pedalboard.Reverb.reset"]], "target_sample_rate (pedalboard.resample property)": [[6, "pedalboard.Resample.target_sample_rate"]], "audiofile (class in pedalboard.io)": [[7, "pedalboard.io.AudioFile"]], "readableaudiofile (class in pedalboard.io)": [[7, "pedalboard.io.ReadableAudioFile"]], "resampledreadableaudiofile (class in pedalboard.io)": [[7, "pedalboard.io.ResampledReadableAudioFile"]], "streamresampler (class in pedalboard.io)": [[7, "pedalboard.io.StreamResampler"]], "writeableaudiofile (class in pedalboard.io)": [[7, "pedalboard.io.WriteableAudioFile"]], "close() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.close"]], "close() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.close"]], "close() (pedalboard.io.writeableaudiofile method)": [[7, "pedalboard.io.WriteableAudioFile.close"]], "closed (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.closed"]], "closed (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.closed"]], "closed (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.closed"]], "duration (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.duration"]], "duration (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.duration"]], "file_dtype (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.file_dtype"]], "file_dtype (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.file_dtype"]], "file_dtype (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.file_dtype"]], "flush() (pedalboard.io.writeableaudiofile method)": [[7, "pedalboard.io.WriteableAudioFile.flush"]], "frames (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.frames"]], "frames (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.frames"]], "frames (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.frames"]], "input_latency (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.input_latency"]], "name (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.name"]], "name (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.name"]], "num_channels (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.num_channels"]], "num_channels (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.num_channels"]], "num_channels (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.num_channels"]], "num_channels (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.num_channels"]], "pedalboard.io": [[7, "module-pedalboard.io"]], "process() (pedalboard.io.streamresampler method)": [[7, "pedalboard.io.StreamResampler.process"]], "quality (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.quality"]], "quality (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.quality"]], "read() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.read"]], "read() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.read"]], "read_raw() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.read_raw"]], "resampled_to() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.resampled_to"]], "resampling_quality (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.resampling_quality"]], "reset() (pedalboard.io.streamresampler method)": [[7, "pedalboard.io.StreamResampler.reset"]], "samplerate (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.samplerate"]], "samplerate (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.samplerate"]], "samplerate (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.samplerate"]], "seek() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.seek"]], "seek() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.seek"]], "seekable() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.seekable"]], "seekable() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.seekable"]], "source_sample_rate (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.source_sample_rate"]], "target_sample_rate (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.target_sample_rate"]], "tell() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.tell"]], "tell() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.tell"]], "write() (pedalboard.io.writeableaudiofile method)": [[7, "pedalboard.io.WriteableAudioFile.write"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["compatibility", "examples", "faq", "index", "internals", "license", "reference/pedalboard", "reference/pedalboard.io"], "filenames": ["compatibility.rst", "examples.rst", "faq.rst", "index.rst", "internals.rst", "license.rst", "reference/pedalboard.rst", "reference/pedalboard.io.rst"], "titles": ["Plugin Compatibility", "Examples", "Frequently Asked Questions", "Features", "Pedalboard Internals", "License", "The <code class=\"docutils literal notranslate\"><span class=\"pre\">pedalboard</span></code> API", "The <code class=\"docutils literal notranslate\"><span class=\"pre\">pedalboard.io</span></code> API"], "terms": {"pedalboard": [0, 3, 5], "allow": [0, 2, 3, 6, 7], "load": [0, 1, 3, 4, 6], "vst3": [0, 3, 4, 5, 6], "audio": [0, 3, 4, 5, 6, 7], "unit": [0, 2, 3, 4, 6], "which": [0, 2, 5, 6, 7], "could": [0, 2, 6], "contain": [0, 1, 2, 6, 7], "ani": [0, 2, 4, 6, 7], "code": [0, 2, 4, 5], "most": [0, 2, 3, 4, 6, 7], "have": [0, 2, 4, 6, 7], "been": [0, 7], "test": [0, 3, 4], "work": [0, 1, 3, 6, 7], "just": [0, 1, 2, 4, 6, 7], "fine": [0, 2], "some": [0, 1, 4, 7], "mai": [0, 4, 6, 7], "worst": [0, 7], "even": [0, 3], "crash": [0, 7], "python": [0, 1, 2, 3, 4, 6, 7], "interpret": [0, 2, 3], "without": [0, 2, 3, 6, 7], "warn": 0, "abil": 0, "catch": 0, "error": 0, "ar": [0, 1, 2, 3, 4, 5, 6, 7], "well": [0, 3, 4, 6, 7], "behav": [0, 1], "conform": 0, "set": [0, 1, 2, 6, 7], "convent": 0, "how": [0, 1, 6], "suppos": 0, "mani": [0, 3, 6, 7], "do": [0, 1, 7], "specif": [0, 6], "attempt": [0, 7], "detect": [0, 6], "common": [0, 3], "program": [0, 1, 2], "can": [0, 1, 3, 4, 6, 7], "around": [0, 4, 6], "issu": [0, 2, 4], "includ": [0, 1, 2, 3, 4, 5], "automat": [0, 3, 6, 7], "don": [0, 1, 7], "t": [0, 1, 2, 7], "clear": [0, 6], "intern": [0, 3, 6, 7], "state": [0, 6, 7], "when": [0, 2, 3, 4, 6, 7], "ask": [0, 3], "so": [0, 1, 2, 6, 7], "misbehav": 0, "notic": 0, "If": [0, 1, 3, 6, 7], "i": [0, 1, 2, 3, 4, 5, 6, 7], "being": 0, "render": [0, 7], "incorrectli": 0, "leak": [0, 7], "from": [0, 1, 2, 3, 5, 6, 7], "one": [0, 1, 3, 6, 7], "process": [0, 1, 2, 3, 4, 5, 6, 7], "call": [0, 6, 7], "next": 0, "an": [0, 1, 2, 4, 6, 7], "undesir": 0, "fashion": [0, 2], "try": [0, 6], "pass": [0, 2, 6, 7], "silenc": 0, "between": [0, 2, 6, 7], "ensur": [0, 2, 4, 7], "reverb": [0, 1, 2, 3, 6], "tail": [0, 2, 6], "other": [0, 1, 3, 6, 7], "ha": [0, 6, 7], "time": [0, 1, 3, 6, 7], "fade": 0, "reload": 0, "everi": [0, 4, 7], "load_plugin": [0, 1, 3, 4, 6], "import": [1, 2, 4], "choru": [1, 3, 6], "io": [1, 2, 3], "audiofil": [1, 2, 7], "read": [1, 2, 3, 7], "whole": 1, "file": [1, 2, 3, 4, 6, 7], "wav": [1, 2, 3, 7], "f": [1, 7], "frame": [1, 2, 7], "sampler": [1, 2, 7], "object": [1, 2, 6, 7], "multipl": [1, 2, 3, 6, 7], "board": [1, 2], "room_siz": [1, 6], "0": [1, 2, 6, 7], "25": [1, 6], "run": [1, 6], "through": [1, 2, 6, 7], "thi": [1, 2, 5, 6, 7], "write": [1, 2, 3, 7], "back": [1, 6], "output": [1, 2, 6, 7], "w": [1, 2, 7], "shape": [1, 2, 7], "It": [1, 3], "smaller": [1, 2, 7], "resampl": [1, 3, 6, 7], "our": [1, 2], "desir": 1, "sampl": [1, 2, 6, 7], "rate": [1, 2, 6, 7], "44100": [1, 7], "input": [1, 2, 6, 7], "resampled_to": [1, 7], "pretti": 1, "interest": 1, "sound": [1, 6], "compressor": [1, 2, 3, 6], "threshold_db": [1, 6], "50": [1, 6], "ratio": [1, 6], "gain": [1, 3, 6], "gain_db": [1, 6], "30": 1, "ladderfilt": [1, 3, 6], "mode": [1, 6, 7], "hpf12": [1, 6], "cutoff_hz": [1, 6], "900": 1, "phaser": [1, 3, 6], "convolut": [1, 3, 6], "guitar_amp": 1, "1": [1, 2, 3, 6, 7], "like": [1, 6, 7], "list": [1, 6], "you": [1, 3, 7], "add": [1, 2, 3, 4, 6], "append": [1, 6, 7], "10": [1, 3, 6, 7], "limit": [1, 3, 6], "chang": [1, 3, 6, 7], "paramet": [1, 3, 6, 7], "easili": 1, "40": 1, "known": 1, "path": [1, 6, 7], "disk": [1, 7], "vst": [1, 3, 5], "roughrider3": 1, "print": [1, 6], "kei": [1, 6], "dict_kei": 1, "sc_hpf_hz": 1, "input_lvl_db": 1, "sensitivity_db": 1, "attack_m": [1, 6], "release_m": [1, 6], "makeup_db": 1, "mix": [1, 6], "output_lvl_db": 1, "sc_activ": 1, "full_bandwidth": 1, "bypass": 1, "15": 1, "r": [1, 7], "put": 1, "same": [1, 4, 6, 7], "instanc": [1, 4, 6, 7], "delai": [1, 2, 3, 6], "pitch": [1, 3, 6], "shift": [1, 6], "themselv": 1, "nest": 1, "them": [1, 6], "much": [1, 6], "distort": [1, 3, 6], "pitchshift": [1, 3, 5, 6], "passthrough": 1, "delay_and_pitch_shift": 1, "delay_second": [1, 6], "semiton": [1, 6], "7": [1, 3, 6], "3": [1, 3, 6], "delay_longer_and_more_pitch_shift": 1, "5": [1, 6], "12": [1, 6], "6": [1, 3, 5, 6, 7], "front": 1, "all": [1, 2, 3, 4, 6, 7], "simultan": 1, "final": 1, "For": [1, 6, 7], "more": [1, 3, 4, 6, 7], "see": [1, 2, 6, 7], "folder": 1, "repositori": [1, 4], "demo": 1, "colab": 1, "notebook": 1, "interact": 1, "web": 1, "hug": 1, "face": 1, "space": 1, "gradio": 1, "via": [1, 3, 6, 7], "ak391": 1, "technic": 2, "ye": 2, "pull": [2, 5], "request": 2, "98": 2, "experiment": [2, 3], "interfac": [2, 4, 6], "written": [2, 4, 7], "c": [2, 4], "stefanobazzi": 2, "guitarboard": 2, "project": [2, 5], "exampl": [2, 3, 4, 6, 7], "sounddevic": 2, "librari": [2, 3, 4, 5, 6, 7], "howev": [2, 6], "coupl": 2, "big": 2, "caveat": 2, "talk": 2, "about": [1, 2], "context": 2, "languag": 2, "garbag": 2, "collect": 2, "mean": 2, "your": 2, "randomli": 2, "paus": 2, "regular": [1, 2, 6, 7], "interv": 2, "clean": 2, "up": [2, 3, 6], "unus": [2, 7], "In": 2, "result": [2, 7], "random": [2, 7], "pop": 2, "click": 2, "drop": 2, "out": [2, 3, 6, 7], "veri": 2, "difficult": 2, "prevent": [2, 7], "global": [2, 3], "lock": [2, 3], "also": [2, 3, 4, 6, 7], "potenti": [2, 7], "unbound": [2, 7], "switch": 2, "thread": [2, 3, 4], "oper": [2, 6, 7], "system": [2, 6, 7], "separ": 2, "high": [2, 6], "prioriti": 2, "block": [2, 6], "caus": [2, 6, 7], "stutter": 2, "access": [2, 6], "mutat": 2, "note": [1, 2, 6, 7], "applic": [2, 4], "stream": [2, 3, 6, 7], "larg": [2, 7], "buffer": [2, 6, 7], "size": [2, 4, 6], "second": [1, 2, 6, 7], "soft": 2, "requir": [2, 3, 4, 6, 7], "case": [2, 3, 4, 6], "network": 2, "data": [2, 3, 7], "offlin": 2, "chunk": [1, 2, 6, 7], "while": [1, 2, 6, 7], "built": [2, 3], "function": [2, 4, 6, 7], "possibl": [2, 3, 7], "vari": 2, "manual": [2, 3], "tqdm": 2, "step": 2, "would": [2, 4, 6, 7], "give": [2, 6], "smoother": 2, "transit": 2, "expens": [2, 6], "speed": [2, 3, 4, 6], "step_size_in_sampl": 2, "100": [2, 6, 7], "_n_": 2, "af": 2, "open": [1, 2, 4, 7], "we": 2, "directli": [2, 6, 7], "save": 2, "memori": [2, 3, 6, 7], "num_channel": [1, 2, 7], "o": [1, 2, 3, 7], "creat": [2, 3, 6, 7], "progress": 2, "bar": 2, "show": [2, 4, 6], "total": [2, 7], "pbar": 2, "rang": [2, 3, 6], "wet": [2, 6], "equal": [2, 3, 6, 7], "percentag": [2, 6], "track": 2, "e": [2, 6, 7], "make": [2, 3], "ramp": 2, "percentage_through_track": 2, "wet_level": [2, 6], "updat": 2, "number": [2, 3, 5, 6, 7], "receiv": [2, 6], "reset": [1, 2, 6, 7], "fals": [1, 2, 6, 7], "aren": 2, "cut": [2, 6], "off": [2, 6], "With": 2, "techniqu": [2, 6], "autom": 2, "usual": [2, 6, 7], "somewher": 2, "000": [2, 7], "2m": 2, "22m": 2, "44": [2, 6, 7], "1khz": [2, 6], "small": 2, "enough": 2, "avoid": [2, 7], "hear": 2, "artifact": [2, 6], "slow": [2, 6], "down": 2, "dramat": 2, "Not": [2, 4, 6, 7], "yet": 2, "The": [2, 4, 5], "underli": [2, 6, 7], "framework": 2, "juce": [2, 4, 5], "au": [2, 7], "itself": [2, 4, 6], "modifi": 2, "either": [2, 7], "although": [2, 6, 7], "ad": [3, 7], "effect": [3, 4, 6, 7], "support": [3, 4, 6, 7], "popular": 3, "format": [3, 6, 7], "box": 3, "us": [3, 4, 5, 6, 7], "third": [3, 6], "parti": [3, 6], "plugin": [3, 5, 6], "wa": [3, 6, 7], "spotifi": [1, 3, 5], "": [3, 4, 6, 7], "intellig": 3, "lab": 3, "enabl": 3, "studio": 3, "qualiti": [3, 6, 7], "within": [3, 4, 6], "tensorflow": 3, "augment": 3, "improv": 3, "machin": [3, 4], "learn": [3, 4], "model": [3, 6], "help": 3, "content": [3, 7], "creation": 3, "digit": [3, 4, 6], "workstat": 3, "util": [3, 6], "aiff": [3, 7], "flac": [3, 7], "mp3": [3, 6, 7], "ogg": [3, 7], "platform": [3, 4, 6, 7], "depend": [3, 4, 6, 7], "addit": [3, 4, 6, 7], "aac": [3, 7], "ac3": [3, 7], "wma": [3, 7], "fly": [3, 7], "usag": [3, 6], "basic": [3, 6, 7], "transform": 3, "guitar": [3, 6], "style": 3, "clip": [3, 6], "loud": [3, 6], "dynam": [3, 6], "filter": [3, 6], "highpassfilt": [3, 6], "lowpassfilt": [3, 6], "spatial": 3, "lossi": [3, 6], "compress": [3, 6, 7], "gsmfullratecompressor": [3, 5, 6], "mp3compressor": [3, 5, 6], "reduct": [3, 6], "bitcrush": [3, 6], "maco": [3, 4, 6, 7], "window": [3, 4, 6, 7], "linux": [3, 4, 6, 7], "strong": 3, "safeti": 3, "guarante": 3, "releas": [3, 6], "gil": 3, "cpu": 3, "core": [3, 5], "No": [3, 6], "need": [3, 4], "multiprocess": 3, "onli": [3, 6, 7], "300x": 3, "faster": 3, "than": [3, 4, 6, 7], "pysox": 3, "singl": [3, 6], "2": [3, 6, 7], "5x": 3, "soxbind": 3, "icorv": 3, "4x": 3, "librosa": 3, "tf": 3, "pipelin": 3, "avail": [3, 4, 6], "pypi": 3, "wheel": [3, 4], "pip": 3, "That": 3, "new": [3, 7], "follow": [3, 4, 5], "md": 3, "robust": 3, "guid": 3, "thoroughli": 3, "8": [3, 6], "9": 3, "11": 3, "heavili": 3, "product": 3, "github": [1, 3], "manylinux": 3, "x86_64": 3, "intel": 3, "amd": 3, "aarch64": 3, "arm": 3, "appl": [3, 6], "silicon": 3, "rel": 3, "modern": 3, "glibc": 3, "27": 3, "both": [3, 6], "wide": [3, 6], "amd64": 3, "x86": 3, "64": [3, 6], "api": [3, 4], "quick": 3, "start": [3, 7], "parallel": [3, 6], "chain": [3, 6], "frequent": 3, "question": 3, "live": 3, "real": [3, 6, 7], "doe": [3, 4, 6, 7], "over": [3, 6], "instrument": 3, "instead": [1, 3, 6, 7], "accept": [3, 6, 7], "midi": 3, "design": [3, 6], "consider": 3, "licens": [3, 4], "repo": 3, "wrapper": [4, 6], "sourc": [4, 7], "cross": [4, 6], "develop": 4, "pybind11": 4, "bind": 4, "goal": 4, "expos": [4, 6], "signal": [4, 6], "idiomat": 4, "wai": 4, "provid": [4, 6, 7], "raw": [4, 6, 7], "perform": 4, "dsp": 4, "hide": 4, "complex": 4, "programm": 4, "intuit": 4, "varieti": 4, "reason": 4, "wider": 4, "compat": [4, 5, 6], "notabl": 4, "rare": [4, 6], "fewer": [4, 6], "simpler": 4, "remov": [4, 6], "copi": 4, "associ": 4, "resourc": 4, "option": [4, 6, 7], "might": 4, "meant": 4, "music": 4, "appropri": [4, 6], "vice": 4, "versa": 4, "stabil": 4, "environ": 4, "where": 4, "implement": [4, 6], "logic": 4, "portabl": 4, "safe": 4, "constraint": 4, "should": [4, 6, 7], "consid": [4, 6, 7], "gplv3": [4, 5], "static": [4, 5, 6], "link": 4, "vendor": 4, "git": 4, "submodul": 4, "binari": [4, 7], "distribut": 4, "Will": [4, 7], "increas": [4, 6, 7], "amount": [4, 6, 7], "compil": [4, 5], "runtim": 4, "cannot": [4, 6], "user": 4, "instal": [4, 6, 7], "softwar": 4, "complic": 4, "simplic": 4, "packag": [4, 6, 7], "copyright": 5, "2021": 5, "2022": [1, 5], "ab": 5, "under": [5, 7], "gnu": 5, "gener": [5, 6], "public": 5, "v3": 5, "carri": 5, "dual": 5, "commerci": 5, "sdk": 5, "bundl": [5, 6], "own": [5, 6], "steinberg": [5, 6], "media": 5, "technologi": 5, "gmbh": [5, 6], "rubber": [5, 6], "band": [5, 6], "gplv2": 5, "newer": 5, "libmp3lam": 5, "lame": [5, 6, 7], "lgplv2": 5, "upgrad": 5, "inclus": 5, "permit": 5, "libgsm": 5, "isc": 5, "regist": 5, "trademark": 5, "modul": 6, "class": [6, 7], "subclass": [], "each": [6, 7], "appli": 6, "audiounitplugin": 6, "path_to_plugin_fil": 6, "str": [6, 7], "parameter_valu": 6, "dict": 6, "union": [6, 7], "int": [1, 6, 7], "float": [6, 7], "bool": [6, 7], "plugin_nam": 6, "none": [6, 7], "A": [6, 7], "non": [6, 7], "unavail": 6, "must": [6, 7], "loadabl": 6, "plug": [6, 7], "Ins": 6, "compon": 6, "vst3plugin": 6, "get_plugin_names_for_fil": 6, "filenam": [6, 7], "return": [6, 7], "name": [6, 7], "given": [6, 7], "scan": 6, "importerror": 6, "rais": [6, 7], "insid": 6, "method": [6, 7], "determin": 6, "present": 6, "what": 6, "properti": [6, 7], "report": 6, "self": 6, "pedalboard_n": 6, "input_arrai": 6, "numpi": [6, 7], "ndarrai": [6, 7], "sample_r": 6, "buffer_s": 6, "8192": 6, "true": [6, 7], "float32": [6, 7], "32": [6, 7], "bit": [6, 7], "point": [6, 7], "arrai": [6, 7], "were": 6, "expect": [6, 7], "To": [6, 7], "remain": [6, 7], "anoth": 6, "datatyp": [6, 7], "convert": [6, 7], "argument": [6, 7], "control": 6, "higher": 6, "flag": 6, "befor": [6, 7], "begin": [6, 7], "previou": 6, "store": [6, 7], "g": 6, "line": [6, 7], "lfo": 6, "etc": [6, 7], "valu": [6, 7], "unchang": 6, "show_editor": 6, "_audiounitplugin": 6, "ui": 6, "nativ": [6, 7], "until": [1, 6], "close": [6, 7], "keyboardinterrupt": 6, "bit_depth": [6, 7], "reduc": 6, "depth": [6, 7], "lo": 6, "fi": 6, "vertic": 6, "resolut": 6, "uniqu": 6, "repres": 6, "horizont": 6, "per": [6, 7], "quantiz": 6, "integ": [6, 7], "decim": 6, "onto": 6, "dtype": [6, 7], "zero": 6, "plugincontain": 6, "arg0": 6, "insert": 6, "index": 6, "arg": [], "kwarg": [], "overload": [], "float64": 7, "rate_hz": 6, "centre_delay_m": 6, "feedback": 6, "frequenc": 6, "respons": 6, "centr": 6, "get": 6, "classic": 6, "m": 6, "low": 6, "feeback": 6, "volum": 6, "flanger": 6, "lower": 6, "lot": 6, "vibrato": 6, "oscil": 6, "hertz": 6, "hz": [6, 7], "hard": [6, 7], "threshold": 6, "decibel": 6, "algorithm": [6, 7], "introduc": [6, 7], "nois": 6, "gsmcompressor": 6, "impulse_response_filenam": 6, "suitabl": 6, "thing": 6, "speaker": 6, "simul": 6, "dry": 6, "drive_db": 6, "linear": [6, 7], "tanh": 6, "hyperbol": 6, "tangent": 6, "waveshap": 6, "harmon": 6, "pleas": 6, "produc": 6, "roughli": 6, "equival": 6, "def": 6, "x": 6, "db_to_gain": 6, "windowedsinc": [6, 7], "4": 6, "degrad": 6, "gsm": 6, "full": 6, "emul": 6, "2g": 6, "cellular": 6, "phone": 6, "connect": 6, "fix": 6, "8khz": 6, "codec": [6, 7], "specifi": [6, 7], "decreas": [6, 7], "amplifi": 6, "attenu": 6, "think": 6, "highshelffilt": 6, "cutoff_frequency_hz": 6, "440": 6, "q": 6, "7071067690849304": 6, "shelf": 6, "variabl": [6, 7], "abov": 6, "cutoff": 6, "boost": 6, "first": 6, "order": 6, "roll": 6, "6db": 6, "octav": 6, "3db": 6, "frac": 6, "sqrt": 6, "express": 6, "factor": 6, "further": [6, 7], "iirfilt": 6, "abstract": 6, "variou": 6, "kind": 6, "infinit": 6, "impuls": 6, "iir": 6, "lowshelffilt": 6, "peakfilt": 6, "invert": 6, "flip": 6, "polar": 6, "audibl": 6, "its": [6, 7], "take": 6, "mathemat": 6, "ident": [6, 7], "cancel": 6, "origin": [6, 7], "lpf12": 6, "200": 6, "reson": 6, "drive": 6, "multi": [6, 7], "base": [6, 7], "moog": 6, "synthes": 6, "ladder": 6, "invent": 6, "dr": 6, "bob": 6, "1968": 6, "below": 6, "side": 6, "peak": 6, "type": [6, 7], "architectur": 6, "db": 6, "bpf12": 6, "lpf24": 6, "24": 6, "hpf24": 6, "bpf24": 6, "simpl": 6, "standard": 6, "featur": 6, "two": 6, "clipper": 6, "707x": 6, "vbr_qualiti": 6, "encod": [6, 7], "current": [6, 7], "vbr": 6, "better": 6, "32khz": 6, "48khz": 6, "unsupport": [6, 7], "except": [6, 7], "thrown": 6, "noiseg": 6, "gate": 6, "attack": 6, "expand": 6, "notch": 6, "centre_frequency_hz": 6, "1300": 6, "stage": 6, "sweep": 6, "magnitud": 6, "affect": 6, "durat": [6, 7], "chri": 6, "cannam": 6, "wonder": 6, "stretch": 6, "intend": 6, "direct": 6, "target_sample_r": [6, 7], "8000": 6, "downsampl": 6, "upsampl": 6, "alias": 6, "indic": [6, 7], "zeroorderhold": 6, "lowest": 6, "fastest": [6, 7], "slightli": 6, "less": 6, "noisi": 6, "simplest": 6, "catmullrom": 6, "moder": 6, "good": 6, "fast": 6, "lagrang": 6, "highest": 6, "slowest": [6, 7], "still": 6, "mere": 6, "damp": 6, "33": 6, "dry_level": 6, "width": 6, "freeze_mod": 6, "stereo": [6, 7], "tune": 6, "freeverb": 6, "http": [1, 6], "ccrma": 6, "stanford": 6, "edu": 6, "jo": 6, "pasp": 6, "html": [1, 6], "_": [1, 6], "differ": [6, 7], "build": 6, "load_preset": 6, "_vst3plugin": 6, "preset_file_path": 6, "preset": 6, "vstpreset": 6, "externalplugin": 6, "dictionari": 6, "initi": 6, "after": 6, "match": [6, 7], "normal": 6, "string": [6, 7], "identifi": 6, "These": 6, "throw": [6, 7], "found": 6, "runtimeerror": [6, 7], "v0": 7, "file_lik": 7, "binaryio": 7, "liter": 7, "16": 7, "readabl": 7, "writeabl": 7, "default": 7, "unlik": 7, "typic": 7, "trail": 7, "b": 7, "redund": 7, "exist": 7, "seekabl": 7, "stringio": 7, "my_fil": 7, "first_ten_second": 7, "ogg_buff": 7, "bytesio": 7, "get_audio_buff": 7, "22_050": 7, "white_nois": 7, "np": 7, "rand": 7, "wav_buff": 7, "getvalu": 7, "someth": 7, "160": 7, "kilobit": 7, "re": 7, "four": 7, "tell": [1, 7], "1024": 7, "readableaudiofil": 7, "cross_platform_formats_onli": 7, "wrap": 7, "vorbi": 7, "3g2": 7, "3gp": 7, "adt": 7, "aif": 7, "aifc": 7, "amr": 7, "bwf": 7, "caf": 7, "ec3": 7, "latm": 7, "loa": 7, "m4a": 7, "m4b": 7, "m4r": 7, "mov": 7, "mp1": 7, "mp2": 7, "mp4": 7, "mpa": 7, "mpeg": 7, "qt": 7, "sd2": 7, "snd": 7, "w64": 7, "xhe": 7, "get_supported_read_format": 7, "extens": 7, "pars": 7, "consist": 7, "constructor": 7, "certain": 7, "probabl": 7, "want": 7, "too": 7, "d": [1, 7], "num_fram": 7, "channel": 7, "posit": 7, "decept": 7, "hour": 7, "long": 7, "hand": 7, "megabyt": 7, "decompress": 7, "nearli": 7, "gigabyt": 7, "rather": [1, 7], "onc": 7, "debug": 7, "problem": 7, "dimension": 7, "length": 7, "alwai": [6, 7], "minimum": 7, "0f": 7, "maximum": 7, "read_raw": 7, "int8": 7, "int16": 7, "int32": 7, "resampledreadableaudiofil": 7, "constant": 7, "seek": 7, "locat": 7, "futur": 7, "pointer": 7, "iff": 7, "longer": 7, "usabl": 7, "otherwis": 7, "divid": 7, "file_dtyp": 7, "regardless": 7, "441": 7, "audio_fil": 7, "resampling_qu": 7, "22050": 7, "fraction": 7, "hood": 7, "streamresampl": 7, "obtain": 7, "entir": [6, 7], "benefit": 7, "target": 7, "As": 7, "version": 7, "respect": 7, "push": 7, "accur": [6, 7], "optim": 7, "22": 7, "050": 7, "source_sample_r": 7, "seri": [6, 7], "flush": 7, "input_lat": 7, "suppli": 7, "writeableaudiofil": 7, "get_supported_write_format": 7, "filename_or_file_lik": 7, "assum": 7, "level": 7, "numer": 7, "128": 7, "256": 7, "advanc": 7, "v2": 7, "best": 7, "happen": 7, "reliabl": 7, "forc": 7, "occur": 7, "typeerror": 7, "far": 7, "increment": 7, "kbp": 7, "v9": 7, "aupreset": [], "preset_st": [], "audiounit": [], "bytestr": [], "watch": 1, "video": 1, "document": 1, "feat": 1, "youtub": 1, "empti": 1, "inform": 1, "refer": 1, "member": [], "peter": 1, "sobot": 1, "europython": 1, "contribut": 3, "audioprocessorparamet": 6, "parameter_nam": 6, "search_step": 6, "1000": 6, "_audioprocessorparamet": [], "address": [], "look": [], "map": [], "enum": [], "attribut": 6, "hint": [], "num_step": [], "allowed_valu": [], "is_discret": [], "properli": [], "assign": [], "label": 6, "alia": 6, "kwd": [], "helper": [], "end": 6, "implicit": 6, "my_plugin": 6, "my": 6, "cool": 6, "delay_time_m": 6, "foobar": 6, "400": 6, "tri": 6, "guess": 6, "valid": 6, "instanti": 6, "had": 6, "raw_valu": 6, "bound": 6, "fail": 6, "en": [], "wikipedia": [], "org": [], "wiki": [], "audio_unit": [], "virtual_studio_technologi": [], "guitar_pedalboard": [], "act": 6, "come": 6, "__call__": 6, "my_pedalboard": 6, "output_audio": 6, "input_audio": 6, "invok": 6}, "objects": {"": [[6, 0, 0, "-", "pedalboard"]], "pedalboard": [[6, 1, 1, "", "AudioProcessorParameter"], [6, 1, 1, "", "AudioUnitPlugin"], [6, 1, 1, "", "Bitcrush"], [6, 1, 1, "", "Chain"], [6, 1, 1, "", "Chorus"], [6, 1, 1, "", "Clipping"], [6, 1, 1, "", "Compressor"], [6, 1, 1, "", "Convolution"], [6, 1, 1, "", "Delay"], [6, 1, 1, "", "Distortion"], [6, 1, 1, "", "GSMFullRateCompressor"], [6, 1, 1, "", "Gain"], [6, 1, 1, "", "HighShelfFilter"], [6, 1, 1, "", "HighpassFilter"], [6, 1, 1, "", "IIRFilter"], [6, 1, 1, "", "Invert"], [6, 1, 1, "", "LadderFilter"], [6, 1, 1, "", "Limiter"], [6, 1, 1, "", "LowShelfFilter"], [6, 1, 1, "", "LowpassFilter"], [6, 1, 1, "", "MP3Compressor"], [6, 1, 1, "", "Mix"], [6, 1, 1, "", "NoiseGate"], [6, 1, 1, "", "PeakFilter"], [6, 1, 1, "", "Pedalboard"], [6, 1, 1, "", "Phaser"], [6, 1, 1, "", "PitchShift"], [6, 1, 1, "", "Plugin"], [6, 1, 1, "", "PluginContainer"], [6, 1, 1, "", "Resample"], [6, 1, 1, "", "Reverb"], [6, 1, 1, "", "VST3Plugin"], [7, 0, 0, "-", "io"], [6, 5, 1, "", "load_plugin"]], "pedalboard.AudioProcessorParameter": [[6, 2, 1, "", "label"], [6, 2, 1, "", "units"]], "pedalboard.AudioUnitPlugin": [[6, 3, 1, "", "get_plugin_names_for_file"], [6, 2, 1, "", "name"], [6, 3, 1, "", "process"], [6, 3, 1, "", "reset"], [6, 3, 1, "", "show_editor"]], "pedalboard.Bitcrush": [[6, 2, 1, "", "bit_depth"], [6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Chain": [[6, 3, 1, "", "append"], [6, 3, 1, "", "insert"], [6, 3, 1, "", "process"], [6, 3, 1, "", "remove"], [6, 3, 1, "", "reset"]], "pedalboard.Chorus": [[6, 3, 1, "", "process"], [6, 2, 1, "", "rate_hz"], [6, 3, 1, "", "reset"]], "pedalboard.Clipping": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Compressor": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Convolution": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Delay": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Distortion": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.GSMFullRateCompressor": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Gain": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.HighShelfFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.HighpassFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.IIRFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Invert": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.LadderFilter": [[6, 1, 1, "", "Mode"], [6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.LadderFilter.Mode": [[6, 4, 1, "", "BPF12"], [6, 4, 1, "", "BPF24"], [6, 4, 1, "", "HPF12"], [6, 4, 1, "", "HPF24"], [6, 4, 1, "", "LPF12"], [6, 4, 1, "", "LPF24"]], "pedalboard.Limiter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.LowShelfFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.LowpassFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.MP3Compressor": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Mix": [[6, 3, 1, "", "append"], [6, 3, 1, "", "insert"], [6, 3, 1, "", "process"], [6, 3, 1, "", "remove"], [6, 3, 1, "", "reset"]], "pedalboard.NoiseGate": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.PeakFilter": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Pedalboard": [[6, 3, 1, "", "append"], [6, 3, 1, "", "insert"], [6, 3, 1, "", "process"], [6, 3, 1, "", "remove"], [6, 3, 1, "", "reset"]], "pedalboard.Phaser": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.PitchShift": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.Plugin": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.PluginContainer": [[6, 3, 1, "", "append"], [6, 3, 1, "", "insert"], [6, 3, 1, "", "process"], [6, 3, 1, "", "remove"], [6, 3, 1, "", "reset"]], "pedalboard.Resample": [[6, 1, 1, "", "Quality"], [6, 3, 1, "", "process"], [6, 2, 1, "", "quality"], [6, 3, 1, "", "reset"], [6, 2, 1, "", "target_sample_rate"]], "pedalboard.Resample.Quality": [[6, 4, 1, "", "CatmullRom"], [6, 4, 1, "", "Lagrange"], [6, 4, 1, "", "Linear"], [6, 4, 1, "", "WindowedSinc"], [6, 4, 1, "", "ZeroOrderHold"]], "pedalboard.Reverb": [[6, 3, 1, "", "process"], [6, 3, 1, "", "reset"]], "pedalboard.VST3Plugin": [[6, 3, 1, "", "get_plugin_names_for_file"], [6, 3, 1, "", "load_preset"], [6, 2, 1, "", "name"], [6, 3, 1, "", "process"], [6, 3, 1, "", "reset"], [6, 3, 1, "", "show_editor"]], "pedalboard.io": [[7, 1, 1, "", "AudioFile"], [7, 1, 1, "", "ReadableAudioFile"], [7, 1, 1, "", "ResampledReadableAudioFile"], [7, 1, 1, "", "StreamResampler"], [7, 1, 1, "", "WriteableAudioFile"]], "pedalboard.io.ReadableAudioFile": [[7, 3, 1, "", "close"], [7, 2, 1, "", "closed"], [7, 2, 1, "", "duration"], [7, 2, 1, "", "file_dtype"], [7, 2, 1, "", "frames"], [7, 2, 1, "", "name"], [7, 2, 1, "", "num_channels"], [7, 3, 1, "", "read"], [7, 3, 1, "", "read_raw"], [7, 3, 1, "", "resampled_to"], [7, 2, 1, "", "samplerate"], [7, 3, 1, "", "seek"], [7, 3, 1, "", "seekable"], [7, 3, 1, "", "tell"]], "pedalboard.io.ResampledReadableAudioFile": [[7, 3, 1, "", "close"], [7, 2, 1, "", "closed"], [7, 2, 1, "", "duration"], [7, 2, 1, "", "file_dtype"], [7, 2, 1, "", "frames"], [7, 2, 1, "", "name"], [7, 2, 1, "", "num_channels"], [7, 3, 1, "", "read"], [7, 2, 1, "", "resampling_quality"], [7, 2, 1, "", "samplerate"], [7, 3, 1, "", "seek"], [7, 3, 1, "", "seekable"], [7, 3, 1, "", "tell"]], "pedalboard.io.StreamResampler": [[7, 2, 1, "", "input_latency"], [7, 2, 1, "", "num_channels"], [7, 3, 1, "", "process"], [7, 2, 1, "", "quality"], [7, 3, 1, "", "reset"], [7, 2, 1, "", "source_sample_rate"], [7, 2, 1, "", "target_sample_rate"]], "pedalboard.io.WriteableAudioFile": [[7, 3, 1, "", "close"], [7, 2, 1, "", "closed"], [7, 2, 1, "", "file_dtype"], [7, 3, 1, "", "flush"], [7, 2, 1, "", "frames"], [7, 2, 1, "", "num_channels"], [7, 2, 1, "", "quality"], [7, 2, 1, "", "samplerate"], [7, 3, 1, "", "write"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:property", "3": "py:method", "4": "py:attribute", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "property", "Python property"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "function", "Python function"]}, "titleterms": {"plugin": [0, 1, 2, 4], "compat": [0, 3], "exampl": 1, "quick": 1, "start": 1, "make": 1, "guitar": 1, "style": 1, "pedalboard": [1, 2, 4, 6, 7], "us": [1, 2], "vst3": 1, "audio": [1, 2], "unit": 1, "creat": 1, "parallel": 1, "effect": [1, 2], "chain": 1, "frequent": 2, "ask": 2, "question": 2, "can": 2, "live": 2, "real": 2, "time": 2, "doe": 2, "support": 2, "chang": 2, "": 2, "paramet": 2, "over": 2, "vst": 2, "instrument": 2, "instead": 2, "accept": 2, "midi": 2, "featur": 3, "instal": 3, "refer": 3, "document": 3, "intern": 4, "ad": 4, "new": 4, "built": 4, "design": 4, "consider": 4, "licens": 5, "The": [6, 7], "api": [6, 7], "io": 7, "put": [], "compressor": [], "front": [], "run": [], "all": [], "simultan": [], "mix": [], "contribut": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Plugin Compatibility": [[0, "plugin-compatibility"]], "Examples": [[1, "examples"]], "Quick start": [[1, "quick-start"]], "Making a guitar-style pedalboard": [[1, "making-a-guitar-style-pedalboard"]], "Using VST3\u00ae or Audio Unit plugins": [[1, "using-vst3-or-audio-unit-plugins"]], "Creating parallel effects chains": [[1, "creating-parallel-effects-chains"]], "Contributing": [[1, "contributing"]], "Frequently Asked Questions": [[2, "frequently-asked-questions"]], "Can Pedalboard be used with live (real-time) audio?": [[2, "can-pedalboard-be-used-with-live-real-time-audio"]], "Does Pedalboard support changing a plugin\u2019s parameters over time?": [[2, "does-pedalboard-support-changing-a-plugin-s-parameters-over-time"]], "Can Pedalboard be used with VST instruments, instead of effects?": [[2, "can-pedalboard-be-used-with-vst-instruments-instead-of-effects"]], "Can Pedalboard plugins accept MIDI?": [[2, "can-pedalboard-plugins-accept-midi"]], "Features": [[3, "features"]], "Installation": [[3, "installation"]], "Compatibility": [[3, "compatibility"]], "Reference": [[3, "reference"]], "Documentation": [[3, "documentation"]], "Pedalboard Internals": [[4, "pedalboard-internals"]], "Adding new built-in Pedalboard plugins": [[4, "adding-new-built-in-pedalboard-plugins"]], "Design considerations": [[4, "design-considerations"]], "License": [[5, "license"]], "The pedalboard API": [[6, "module-pedalboard"]], "The pedalboard.io API": [[7, "module-pedalboard.io"]]}, "indexentries": {"audioprocessorparameter (class in pedalboard)": [[6, "pedalboard.AudioProcessorParameter"]], "audiounitplugin (class in pedalboard)": [[6, "pedalboard.AudioUnitPlugin"]], "bpf12 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.BPF12"]], "bpf24 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.BPF24"]], "bitcrush (class in pedalboard)": [[6, "pedalboard.Bitcrush"]], "catmullrom (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.CatmullRom"]], "chain (class in pedalboard)": [[6, "pedalboard.Chain"]], "chorus (class in pedalboard)": [[6, "pedalboard.Chorus"]], "clipping (class in pedalboard)": [[6, "pedalboard.Clipping"]], "compressor (class in pedalboard)": [[6, "pedalboard.Compressor"]], "convolution (class in pedalboard)": [[6, "pedalboard.Convolution"]], "delay (class in pedalboard)": [[6, "pedalboard.Delay"]], "distortion (class in pedalboard)": [[6, "pedalboard.Distortion"]], "gsmfullratecompressor (class in pedalboard)": [[6, "pedalboard.GSMFullRateCompressor"]], "gain (class in pedalboard)": [[6, "pedalboard.Gain"]], "hpf12 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.HPF12"]], "hpf24 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.HPF24"]], "highshelffilter (class in pedalboard)": [[6, "pedalboard.HighShelfFilter"]], "highpassfilter (class in pedalboard)": [[6, "pedalboard.HighpassFilter"]], "iirfilter (class in pedalboard)": [[6, "pedalboard.IIRFilter"]], "invert (class in pedalboard)": [[6, "pedalboard.Invert"]], "lpf12 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.LPF12"]], "lpf24 (pedalboard.ladderfilter.mode attribute)": [[6, "pedalboard.LadderFilter.Mode.LPF24"]], "ladderfilter (class in pedalboard)": [[6, "pedalboard.LadderFilter"]], "ladderfilter.mode (class in pedalboard)": [[6, "pedalboard.LadderFilter.Mode"]], "lagrange (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.Lagrange"]], "limiter (class in pedalboard)": [[6, "pedalboard.Limiter"]], "linear (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.Linear"]], "lowshelffilter (class in pedalboard)": [[6, "pedalboard.LowShelfFilter"]], "lowpassfilter (class in pedalboard)": [[6, "pedalboard.LowpassFilter"]], "mp3compressor (class in pedalboard)": [[6, "pedalboard.MP3Compressor"]], "mix (class in pedalboard)": [[6, "pedalboard.Mix"]], "noisegate (class in pedalboard)": [[6, "pedalboard.NoiseGate"]], "peakfilter (class in pedalboard)": [[6, "pedalboard.PeakFilter"]], "pedalboard (class in pedalboard)": [[6, "pedalboard.Pedalboard"]], "phaser (class in pedalboard)": [[6, "pedalboard.Phaser"]], "pitchshift (class in pedalboard)": [[6, "pedalboard.PitchShift"]], "plugin (class in pedalboard)": [[6, "pedalboard.Plugin"]], "plugincontainer (class in pedalboard)": [[6, "pedalboard.PluginContainer"]], "resample (class in pedalboard)": [[6, "pedalboard.Resample"]], "resample.quality (class in pedalboard)": [[6, "pedalboard.Resample.Quality"]], "reverb (class in pedalboard)": [[6, "pedalboard.Reverb"]], "vst3plugin (class in pedalboard)": [[6, "pedalboard.VST3Plugin"]], "windowedsinc (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.WindowedSinc"]], "zeroorderhold (pedalboard.resample.quality attribute)": [[6, "pedalboard.Resample.Quality.ZeroOrderHold"]], "append() (pedalboard.chain method)": [[6, "pedalboard.Chain.append"]], "append() (pedalboard.mix method)": [[6, "pedalboard.Mix.append"]], "append() (pedalboard.pedalboard method)": [[6, "pedalboard.Pedalboard.append"]], "append() (pedalboard.plugincontainer method)": [[6, "pedalboard.PluginContainer.append"]], "bit_depth (pedalboard.bitcrush property)": [[6, "pedalboard.Bitcrush.bit_depth"]], "get_plugin_names_for_file() (pedalboard.audiounitplugin static method)": [[6, "pedalboard.AudioUnitPlugin.get_plugin_names_for_file"]], "get_plugin_names_for_file() (pedalboard.vst3plugin static method)": [[6, "pedalboard.VST3Plugin.get_plugin_names_for_file"]], "insert() (pedalboard.chain method)": [[6, "pedalboard.Chain.insert"]], "insert() (pedalboard.mix method)": [[6, "pedalboard.Mix.insert"]], "insert() (pedalboard.pedalboard method)": [[6, "pedalboard.Pedalboard.insert"]], "insert() (pedalboard.plugincontainer method)": [[6, "pedalboard.PluginContainer.insert"]], "label (pedalboard.audioprocessorparameter property)": [[6, "pedalboard.AudioProcessorParameter.label"]], "load_plugin() (in module pedalboard)": [[6, "pedalboard.load_plugin"]], "load_preset() (pedalboard.vst3plugin method)": [[6, "pedalboard.VST3Plugin.load_preset"]], "module": [[6, "module-pedalboard"], [7, "module-pedalboard.io"]], "name (pedalboard.audiounitplugin property)": [[6, "pedalboard.AudioUnitPlugin.name"]], "name (pedalboard.vst3plugin property)": [[6, "pedalboard.VST3Plugin.name"]], "pedalboard": [[6, "module-pedalboard"]], "process() (pedalboard.audiounitplugin method)": [[6, "pedalboard.AudioUnitPlugin.process"]], "process() (pedalboard.bitcrush method)": [[6, "pedalboard.Bitcrush.process"]], "process() (pedalboard.chain method)": [[6, "pedalboard.Chain.process"]], "process() (pedalboard.chorus method)": [[6, "pedalboard.Chorus.process"]], "process() (pedalboard.clipping method)": [[6, "pedalboard.Clipping.process"]], "process() (pedalboard.compressor method)": [[6, "pedalboard.Compressor.process"]], "process() (pedalboard.convolution method)": [[6, "pedalboard.Convolution.process"]], "process() (pedalboard.delay method)": [[6, "pedalboard.Delay.process"]], "process() (pedalboard.distortion method)": [[6, "pedalboard.Distortion.process"]], "process() (pedalboard.gsmfullratecompressor method)": [[6, "pedalboard.GSMFullRateCompressor.process"]], "process() (pedalboard.gain method)": [[6, "pedalboard.Gain.process"]], "process() (pedalboard.highshelffilter method)": [[6, "pedalboard.HighShelfFilter.process"]], "process() (pedalboard.highpassfilter method)": [[6, "pedalboard.HighpassFilter.process"]], "process() (pedalboard.iirfilter method)": [[6, "pedalboard.IIRFilter.process"]], "process() (pedalboard.invert method)": [[6, "pedalboard.Invert.process"]], "process() (pedalboard.ladderfilter method)": [[6, "pedalboard.LadderFilter.process"]], "process() (pedalboard.limiter method)": [[6, "pedalboard.Limiter.process"]], "process() (pedalboard.lowshelffilter method)": [[6, "pedalboard.LowShelfFilter.process"]], "process() (pedalboard.lowpassfilter method)": [[6, "pedalboard.LowpassFilter.process"]], "process() (pedalboard.mp3compressor method)": [[6, "pedalboard.MP3Compressor.process"]], "process() (pedalboard.mix method)": [[6, "pedalboard.Mix.process"]], "process() (pedalboard.noisegate method)": [[6, "pedalboard.NoiseGate.process"]], "process() (pedalboard.peakfilter method)": [[6, "pedalboard.PeakFilter.process"]], "process() (pedalboard.pedalboard method)": [[6, "pedalboard.Pedalboard.process"]], "process() (pedalboard.phaser method)": [[6, "pedalboard.Phaser.process"]], "process() (pedalboard.pitchshift method)": [[6, "pedalboard.PitchShift.process"]], "process() (pedalboard.plugin method)": [[6, "pedalboard.Plugin.process"]], "process() (pedalboard.plugincontainer method)": [[6, "pedalboard.PluginContainer.process"]], "process() (pedalboard.resample method)": [[6, "pedalboard.Resample.process"]], "process() (pedalboard.reverb method)": [[6, "pedalboard.Reverb.process"]], "process() (pedalboard.vst3plugin method)": [[6, "pedalboard.VST3Plugin.process"]], "quality (pedalboard.resample property)": [[6, "pedalboard.Resample.quality"]], "rate_hz (pedalboard.chorus property)": [[6, "pedalboard.Chorus.rate_hz"]], "remove() (pedalboard.chain method)": [[6, "pedalboard.Chain.remove"]], "remove() (pedalboard.mix method)": [[6, "pedalboard.Mix.remove"]], "remove() (pedalboard.pedalboard method)": [[6, "pedalboard.Pedalboard.remove"]], "remove() (pedalboard.plugincontainer method)": [[6, "pedalboard.PluginContainer.remove"]], "reset() (pedalboard.audiounitplugin method)": [[6, "pedalboard.AudioUnitPlugin.reset"]], "reset() (pedalboard.bitcrush method)": [[6, "pedalboard.Bitcrush.reset"]], "reset() (pedalboard.chain method)": [[6, "pedalboard.Chain.reset"]], "reset() (pedalboard.chorus method)": [[6, "pedalboard.Chorus.reset"]], "reset() (pedalboard.clipping method)": [[6, "pedalboard.Clipping.reset"]], "reset() (pedalboard.compressor method)": [[6, "pedalboard.Compressor.reset"]], "reset() (pedalboard.convolution method)": [[6, "pedalboard.Convolution.reset"]], "reset() (pedalboard.delay method)": [[6, "pedalboard.Delay.reset"]], "reset() (pedalboard.distortion method)": [[6, "pedalboard.Distortion.reset"]], "reset() (pedalboard.gsmfullratecompressor method)": [[6, "pedalboard.GSMFullRateCompressor.reset"]], "reset() (pedalboard.gain method)": [[6, "pedalboard.Gain.reset"]], "reset() (pedalboard.highshelffilter method)": [[6, "pedalboard.HighShelfFilter.reset"]], "reset() (pedalboard.highpassfilter method)": [[6, "pedalboard.HighpassFilter.reset"]], "reset() (pedalboard.iirfilter method)": [[6, "pedalboard.IIRFilter.reset"]], "reset() (pedalboard.invert method)": [[6, "pedalboard.Invert.reset"]], "reset() (pedalboard.ladderfilter method)": [[6, "pedalboard.LadderFilter.reset"]], "reset() (pedalboard.limiter method)": [[6, "pedalboard.Limiter.reset"]], "reset() (pedalboard.lowshelffilter method)": [[6, "pedalboard.LowShelfFilter.reset"]], "reset() (pedalboard.lowpassfilter method)": [[6, "pedalboard.LowpassFilter.reset"]], "reset() (pedalboard.mp3compressor method)": [[6, "pedalboard.MP3Compressor.reset"]], "reset() (pedalboard.mix method)": [[6, "pedalboard.Mix.reset"]], "reset() (pedalboard.noisegate method)": [[6, "pedalboard.NoiseGate.reset"]], "reset() (pedalboard.peakfilter method)": [[6, "pedalboard.PeakFilter.reset"]], "reset() (pedalboard.pedalboard method)": [[6, "pedalboard.Pedalboard.reset"]], "reset() (pedalboard.phaser method)": [[6, "pedalboard.Phaser.reset"]], "reset() (pedalboard.pitchshift method)": [[6, "pedalboard.PitchShift.reset"]], "reset() (pedalboard.plugin method)": [[6, "pedalboard.Plugin.reset"]], "reset() (pedalboard.plugincontainer method)": [[6, "pedalboard.PluginContainer.reset"]], "reset() (pedalboard.resample method)": [[6, "pedalboard.Resample.reset"]], "reset() (pedalboard.reverb method)": [[6, "pedalboard.Reverb.reset"]], "reset() (pedalboard.vst3plugin method)": [[6, "pedalboard.VST3Plugin.reset"]], "show_editor() (pedalboard.audiounitplugin method)": [[6, "pedalboard.AudioUnitPlugin.show_editor"]], "show_editor() (pedalboard.vst3plugin method)": [[6, "pedalboard.VST3Plugin.show_editor"]], "target_sample_rate (pedalboard.resample property)": [[6, "pedalboard.Resample.target_sample_rate"]], "units (pedalboard.audioprocessorparameter property)": [[6, "pedalboard.AudioProcessorParameter.units"]], "audiofile (class in pedalboard.io)": [[7, "pedalboard.io.AudioFile"]], "readableaudiofile (class in pedalboard.io)": [[7, "pedalboard.io.ReadableAudioFile"]], "resampledreadableaudiofile (class in pedalboard.io)": [[7, "pedalboard.io.ResampledReadableAudioFile"]], "streamresampler (class in pedalboard.io)": [[7, "pedalboard.io.StreamResampler"]], "writeableaudiofile (class in pedalboard.io)": [[7, "pedalboard.io.WriteableAudioFile"]], "close() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.close"]], "close() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.close"]], "close() (pedalboard.io.writeableaudiofile method)": [[7, "pedalboard.io.WriteableAudioFile.close"]], "closed (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.closed"]], "closed (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.closed"]], "closed (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.closed"]], "duration (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.duration"]], "duration (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.duration"]], "file_dtype (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.file_dtype"]], "file_dtype (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.file_dtype"]], "file_dtype (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.file_dtype"]], "flush() (pedalboard.io.writeableaudiofile method)": [[7, "pedalboard.io.WriteableAudioFile.flush"]], "frames (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.frames"]], "frames (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.frames"]], "frames (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.frames"]], "input_latency (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.input_latency"]], "name (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.name"]], "name (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.name"]], "num_channels (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.num_channels"]], "num_channels (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.num_channels"]], "num_channels (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.num_channels"]], "num_channels (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.num_channels"]], "pedalboard.io": [[7, "module-pedalboard.io"]], "process() (pedalboard.io.streamresampler method)": [[7, "pedalboard.io.StreamResampler.process"]], "quality (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.quality"]], "quality (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.quality"]], "read() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.read"]], "read() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.read"]], "read_raw() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.read_raw"]], "resampled_to() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.resampled_to"]], "resampling_quality (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.resampling_quality"]], "reset() (pedalboard.io.streamresampler method)": [[7, "pedalboard.io.StreamResampler.reset"]], "samplerate (pedalboard.io.readableaudiofile property)": [[7, "pedalboard.io.ReadableAudioFile.samplerate"]], "samplerate (pedalboard.io.resampledreadableaudiofile property)": [[7, "pedalboard.io.ResampledReadableAudioFile.samplerate"]], "samplerate (pedalboard.io.writeableaudiofile property)": [[7, "pedalboard.io.WriteableAudioFile.samplerate"]], "seek() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.seek"]], "seek() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.seek"]], "seekable() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.seekable"]], "seekable() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.seekable"]], "source_sample_rate (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.source_sample_rate"]], "target_sample_rate (pedalboard.io.streamresampler property)": [[7, "pedalboard.io.StreamResampler.target_sample_rate"]], "tell() (pedalboard.io.readableaudiofile method)": [[7, "pedalboard.io.ReadableAudioFile.tell"]], "tell() (pedalboard.io.resampledreadableaudiofile method)": [[7, "pedalboard.io.ResampledReadableAudioFile.tell"]], "write() (pedalboard.io.writeableaudiofile method)": [[7, "pedalboard.io.WriteableAudioFile.write"]]}})
\ No newline at end of file
diff --git a/pedalboard/PluginContainer.h b/pedalboard/PluginContainer.h
index 137479c..2acccdd 100644
--- a/pedalboard/PluginContainer.h
+++ b/pedalboard/PluginContainer.h
@@ -88,7 +88,9 @@ inline void init_plugin_container(py::module &m) {
throw py::index_error("index out of range");
return s.getPlugins()[i];
},
- py::arg("index"))
+ py::arg("index"),
+ "Get a plugin by its index. Index may be negative. If the index is "
+ "out of range, an IndexError will be thrown.")
.def(
"__setitem__",
[](PluginContainer &s, int i, std::shared_ptr<Plugin> plugin) {
@@ -100,7 +102,9 @@ inline void init_plugin_container(py::module &m) {
throw py::index_error("index out of range");
s.getPlugins()[i] = plugin;
},
- py::arg("index"), py::arg("plugin"))
+ py::arg("index"), py::arg("plugin"),
+ "Replace a plugin at the specified index. Index may be negative. If "
+ "the index is out of range, an IndexError will be thrown.")
.def(
"__delitem__",
[](PluginContainer &s, int i) {
@@ -113,8 +117,12 @@ inline void init_plugin_container(py::module &m) {
auto &plugins = s.getPlugins();
plugins.erase(plugins.begin() + i);
},
- py::arg("index"))
- .def("__len__", [](PluginContainer &s) { return s.getPlugins().size(); })
+ py::arg("index"),
+ "Delete a plugin by its index. Index may be negative. If the index "
+ "is out of range, an IndexError will be thrown.")
+ .def(
+ "__len__", [](PluginContainer &s) { return s.getPlugins().size(); },
+ "Get the number of plugins in this container.")
.def(
"insert",
[](PluginContainer &s, int i, std::shared_ptr<Plugin> plugin) {
@@ -127,11 +135,14 @@ inline void init_plugin_container(py::module &m) {
auto &plugins = s.getPlugins();
plugins.insert(plugins.begin() + i, plugin);
},
- py::arg("index"), py::arg("plugin"))
- .def("append",
- [](PluginContainer &s, std::shared_ptr<Plugin> plugin) {
- s.getPlugins().push_back(plugin);
- })
+ py::arg("index"), py::arg("plugin"),
+ "Insert a plugin at the specified index.")
+ .def(
+ "append",
+ [](PluginContainer &s, std::shared_ptr<Plugin> plugin) {
+ s.getPlugins().push_back(plugin);
+ },
+ py::arg("plugin"), "Append a plugin to the end of this container.")
.def(
"remove",
[](PluginContainer &s, std::shared_ptr<Plugin> plugin) {
@@ -141,7 +152,7 @@ inline void init_plugin_container(py::module &m) {
throw py::value_error("remove(x): x not in list");
plugins.erase(position);
},
- py::arg("plugin"))
+ py::arg("plugin"), "Remove a plugin by its value.")
.def(
"__iter__",
[](PluginContainer &s) {
diff --git a/pedalboard/_pedalboard.py b/pedalboard/_pedalboard.py
index 75042ee..aa3f556 100644
--- a/pedalboard/_pedalboard.py
+++ b/pedalboard/_pedalboard.py
@@ -27,7 +27,16 @@ from pedalboard_native.utils import Chain # type: ignore
class Pedalboard(Chain):
"""
- A container for a chain of plugins, to use for processing audio.
+ A container for a series of :class:`Plugin` objects, to use for processing audio, like a
+ `guitar pedalboard <https://en.wikipedia.org/wiki/Guitar_pedalboard>`_.
+
+ :class:`Pedalboard` objects act like regular Python ``List`` objects,
+ but come with an additional :py:meth:`process` method (also aliased to ``__call__``),
+ allowing audio to be passed through the entire :class:`Pedalboard` object for processing::
+
+ my_pedalboard = Pedalboard()
+ my_pedalboard.append(Reverb())
+ output_audio = my_pedalboard(input_audio)
"""
def __init__(self, plugins: Optional[List[Plugin]] = None):
@@ -203,25 +212,30 @@ def get_text_for_raw_value(
class AudioProcessorParameter(object):
"""
- The C++ version of this class (`_AudioProcessorParameter`) is owned
- by the ExternalPlugin object and is not guaranteed to exist at the
- same memory address every time we might need it. This Python wrapper
- looks it up dynamically.
-
- VSTs and Audio Units don't always consistently give parameter values,
- types, or names - all we get is APIs that map float values on [0, 1]
- to strings, which may represent floats, strings, integers, enums, etc.
-
- AudioProcessorParameter exposes some attributes that can be
- implemented by plugins to give hints (i.e.: num_steps, allowed_values,
- is_discrete, etc) but not all plugins implement them properly.
-
- This method assigns additional properties to AudioProcessorParameter;
- we could do this in C++, but doing this in Python uses much less code
- and is (roughly) as performant as it should only run once per parameter.
+ A wrapper around various different parameters exposed by
+ :class:`VST3Plugin` or :class:`AudioUnitPlugin` instances.
+
+ :class:`AudioProcessorParameter` objects are rarely used directly,
+ and usually used via their implicit interface::
+
+ my_plugin = load_plugin("My Cool Audio Effect.vst3")
+ # Print all of the parameter names:
+ print(my_plugin.parameters.keys())
+ # ["mix", "delay_time_ms", "foobar"]
+ # Access each parameter as if it were just a Python attribute:
+ my_plugin.mix = 0.5
+ my_plugin.delay_time_ms = 400
+
+ .. note::
+ :class:`AudioProcessorParameter` tries to guess the range of
+ valid parameter values, as well as the type/unit of the parameter,
+ when instantiated. This guess may not always be accurate.
+ Raw control over the underlying parameter's value can be had by
+ accessing the :py:attr:`raw_value` attribute, which is always bounded
+ on [0, 1] and is passed directly to the underlying plugin object.
"""
- def __init__(self, plugin, parameter_name, search_steps: int = 1000):
+ def __init__(self, plugin: "ExternalPlugin", parameter_name: str, search_steps: int = 1000):
self.__plugin = plugin
self.__parameter_name = parameter_name
@@ -324,7 +338,12 @@ class AudioProcessorParameter(object):
@contextmanager
def __get_cpp_parameter(self):
- # Re-fetch the parameter by name every time, as it may have changed.
+ """
+ The C++ version of this class (`_AudioProcessorParameter`) is owned
+ by the ExternalPlugin object and is not guaranteed to exist at the
+ same memory address every time we might need it. This Python wrapper
+ looks it up dynamically.
+ """
_parameter = self.__plugin._get_parameter(self.__parameter_name)
if _parameter and _parameter.name == self.__parameter_name:
yield _parameter
@@ -337,7 +356,10 @@ class AudioProcessorParameter(object):
@property
def label(self) -> Optional[str]:
"""
- The units used by this parameter (i.e.: Hz, dB, etc).
+ 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.
"""
if hasattr(self, "_label") and self._label:
return self._label
@@ -349,7 +371,10 @@ class AudioProcessorParameter(object):
@property
def units(self) -> Optional[str]:
"""
- Alias for "label" - the units used by this parameter (i.e.: Hz, dB, etc).
+ 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.
"""
return self.label
@@ -671,7 +696,9 @@ try:
class VST3Plugin(_VST3Plugin, ExternalPlugin):
"""
A wrapper around third-party, non-Pedalboard audio effects
- plugins in Steinberg GmbH's VST3® format.
+ plugins in
+ `Steinberg GmbH's VST3® <https://en.wikipedia.org/wiki/Virtual_Studio_Technology>`_
+ format.
VST3® plugins are supported on macOS, Windows, and Linux.
However, VST3® plugin files are not cross-compatible with
@@ -705,7 +732,9 @@ try:
class AudioUnitPlugin(_AudioUnitPlugin, ExternalPlugin):
"""
A wrapper around third-party, non-Pedalboard audio effects
- plugins in Apple's Audio Unit format.
+ plugins in
+ `Apple's Audio Unit <https://en.wikipedia.org/wiki/Audio_Units>`_
+ format.
Audio Unit plugins are only supported on macOS. This class will be
unavailable on non-macOS platforms. Plugin files must be installed
diff --git a/pedalboard/plugins/Chain.h b/pedalboard/plugins/Chain.h
index d2824c1..af2ad2c 100644
--- a/pedalboard/plugins/Chain.h
+++ b/pedalboard/plugins/Chain.h
@@ -87,59 +87,25 @@ inline void init_chain(py::module &m) {
}),
py::arg("plugins"))
.def(py::init([]() { return new Chain({}); }))
- .def("__repr__",
- [](Chain &plugin) {
- std::ostringstream ss;
- ss << "<pedalboard.Chain with " << plugin.getPlugins().size()
- << " plugin";
- if (plugin.getPlugins().size() != 1) {
- ss << "s";
- }
- ss << ": [";
- for (int i = 0; i < plugin.getPlugins().size(); i++) {
- py::object nestedPlugin = py::cast(plugin.getPlugins()[i]);
- ss << nestedPlugin.attr("__repr__")();
- if (i < plugin.getPlugins().size() - 1) {
- ss << ", ";
- }
- }
- ss << "] at " << &plugin;
- ss << ">";
- return ss.str();
- })
- // If calling process() directly on Chain, pass the plugins immediately to
- // process() itself, as that will result in slightly faster performance.
- .def(
- "process",
- [](std::shared_ptr<Chain> self,
- const py::array_t<float, py::array::c_style> inputArray,
- double sampleRate, unsigned int bufferSize, bool reset) {
- return process(inputArray, sampleRate, self->getPlugins(),
- bufferSize, reset);
- },
- "Run a 32-bit floating point audio buffer through this plugin."
- "(Note: if calling this multiple times with multiple plugins, "
- "consider using pedalboard.process(...) instead.)",
- py::arg("input_array"), py::arg("sample_rate"),
- py::arg("buffer_size") = DEFAULT_BUFFER_SIZE, py::arg("reset") = true)
-
- .def(
- "process",
- [](std::shared_ptr<Chain> self,
- const py::array_t<double, py::array::c_style> inputArray,
- double sampleRate, unsigned int bufferSize, bool reset) {
- const py::array_t<float, py::array::c_style> float32InputArray =
- inputArray.attr("astype")("float32");
- return process(float32InputArray, sampleRate, self->getPlugins(),
- bufferSize, reset);
- },
- "Run a 64-bit floating point audio buffer through this plugin."
- "(Note: if calling this multiple times with multiple plugins, "
- "consider using pedalboard.process(...) instead.) The buffer "
- "will be converted to 32-bit for processing.",
- py::arg("input_array"), py::arg("sample_rate"),
- py::arg("buffer_size") = DEFAULT_BUFFER_SIZE,
- py::arg("reset") = true);
+ .def("__repr__", [](Chain &plugin) {
+ std::ostringstream ss;
+ ss << "<pedalboard.Chain with " << plugin.getPlugins().size()
+ << " plugin";
+ if (plugin.getPlugins().size() != 1) {
+ ss << "s";
+ }
+ ss << ": [";
+ for (int i = 0; i < plugin.getPlugins().size(); i++) {
+ py::object nestedPlugin = py::cast(plugin.getPlugins()[i]);
+ ss << nestedPlugin.attr("__repr__")();
+ if (i < plugin.getPlugins().size() - 1) {
+ ss << ", ";
+ }
+ }
+ ss << "] at " << &plugin;
+ ss << ">";
+ return ss.str();
+ });
}
} // namespace Pedalboard
\ No newline at end of file
diff --git a/pedalboard/python_bindings.cpp b/pedalboard/python_bindings.cpp
index 0a90c05..3c46d34 100644
--- a/pedalboard/python_bindings.cpp
+++ b/pedalboard/python_bindings.cpp
@@ -151,6 +151,12 @@ The ``reset`` flag determines if all of the plugins should be reset before
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``.
+
+.. note::
+ The :py:meth:`process` method can also be used via :py:meth:`__call__`;
+ i.e.: just calling this object like a function (``my_plugin(...)``) will
+ automatically invoke :py:meth:`process` with the same arguments.
+
)",
py::arg("input_array"), py::arg("sample_rate"),
py::arg("buffer_size") = DEFAULT_BUFFER_SIZE,
diff --git a/pedalboard/utils/__init__.pyi b/pedalboard/utils/__init__.pyi
deleted file mode 100644
index 2c1a6f8..0000000
--- a/pedalboard/utils/__init__.pyi
+++ /dev/null
@@ -1,52 +0,0 @@
-from __future__ import annotations
-import pedalboard_native.utils # type: ignore # type: ignore
-import pedalboard # type: ignore
-import typing
-from typing_extensions import Literal
-from enum import Enum
-import numpy
-import pedalboard_native # type: ignore # type: ignore
-import pedalboard # type: ignore
-
-_Shape = typing.Tuple[int, ...]
-
-__all__ = ["Chain", "Mix"]
-
-class Chain(pedalboard_native.PluginContainer, pedalboard_native.Plugin):
- """
- Run zero or more plugins as a plugin. Useful when used with the Mix plugin.
- """
-
- def __init__(self, plugins: typing.List[pedalboard_native.Plugin]) -> None: ...
- def __repr__(self) -> str: ...
- @typing.overload
- def process(
- self,
- input_array: numpy.ndarray[typing.Any, numpy.dtype[numpy.float32]],
- sample_rate: float,
- buffer_size: int = 8192,
- reset: bool = True,
- ) -> numpy.ndarray[typing.Any, numpy.dtype[numpy.float32]]:
- """
- Run a 32-bit floating point audio buffer through this plugin.(Note: if calling this multiple times with multiple plugins, consider using pedalboard.process(...) instead.)
-
- Run a 64-bit floating point audio buffer through this plugin.(Note: if calling this multiple times with multiple plugins, consider using pedalboard.process(...) instead.) The buffer will be converted to 32-bit for processing.
- """
- @typing.overload
- def process(
- self,
- input_array: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]],
- sample_rate: float,
- buffer_size: int = 8192,
- reset: bool = True,
- ) -> numpy.ndarray[typing.Any, numpy.dtype[numpy.float32]]: ...
- pass
-
-class Mix(pedalboard_native.PluginContainer, pedalboard_native.Plugin):
- """
- A utility plugin that allows running other plugins in parallel. All plugins provided will be mixed equally.
- """
-
- def __init__(self, plugins: typing.List[pedalboard_native.Plugin]) -> None: ...
- def __repr__(self) -> str: ...
- pass
diff --git a/pedalboard/version/__init__.pyi b/pedalboard/version/__init__.pyi
deleted file mode 100644
index 265f537..0000000
--- a/pedalboard/version/__init__.pyi
+++ /dev/null
@@ -1,12 +0,0 @@
-from __future__ import annotations
-import pedalboard.version
-import typing
-from typing_extensions import Literal
-from enum import Enum
-
-__all__ = ["MAJOR", "MINOR", "PATCH"]
-
-MAJOR = 0
-MINOR = 5
-PATCH = 5
-__version__ = "0.5.5"
diff --git a/pedalboard_native/README.md b/pedalboard_native/README.md
new file mode 100644
index 0000000..d31011c
--- /dev/null
+++ b/pedalboard_native/README.md
@@ -0,0 +1,6 @@
+Note: this directory contains only type hints for Pedalboard's native C++ bindings.
+The contents of this directory are automatically updated by running:
+
+```
+python3 -m scripts.generate_type_stubs_and_docs
+```
diff --git a/pedalboard/__init__.pyi b/pedalboard_native/__init__.pyi
similarity index 86%
rename from pedalboard/__init__.pyi
rename to pedalboard_native/__init__.pyi
index 3b708fd..da0cb90 100644
--- a/pedalboard/__init__.pyi
+++ b/pedalboard_native/__init__.pyi
@@ -2,9 +2,8 @@
For audio I/O classes (i.e.: reading and writing audio files), see ``pedalboard.io``."""
from __future__ import annotations
-import pedalboard_native as pedalboard # type: ignore
+import pedalboard_native
import typing
-from typing import List, Dict, Union, Optional
from typing_extensions import Literal
from enum import Enum
import numpy
@@ -78,12 +77,18 @@ class Plugin:
If calling ``process`` multiple times while processing the same audio file
or buffer, set ``reset`` to ``False``.
+ .. note::
+ The :py:meth:`process` method can also be used via :py:meth:`__call__`;
+ i.e.: just calling this object like a function (``my_plugin(...)``) will
+ automatically invoke :py:meth:`process` with the same arguments.
+
+
"""
def reset(self) -> 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.
"""
- __call__ = process
+ pass
class Chorus(Plugin):
"""
@@ -407,12 +412,12 @@ class LadderFilter(Plugin):
@resonance.setter
def resonance(self, arg1: float) -> None:
pass
- BPF12: Mode # value = <Mode.BPF12: 2>
- BPF24: Mode # value = <Mode.BPF24: 5>
- HPF12: Mode # value = <Mode.HPF12: 1>
- HPF24: Mode # value = <Mode.HPF24: 4>
- LPF12: Mode # value = <Mode.LPF12: 0>
- LPF24: Mode # value = <Mode.LPF24: 3>
+ BPF12: pedalboard_native.LadderFilter.Mode # value = <Mode.BPF12: 2>
+ BPF24: pedalboard_native.LadderFilter.Mode # value = <Mode.BPF24: 5>
+ HPF12: pedalboard_native.LadderFilter.Mode # value = <Mode.HPF12: 1>
+ HPF24: pedalboard_native.LadderFilter.Mode # value = <Mode.HPF24: 4>
+ LPF12: pedalboard_native.LadderFilter.Mode # value = <Mode.LPF12: 0>
+ LPF24: pedalboard_native.LadderFilter.Mode # value = <Mode.LPF24: 3>
pass
class Limiter(Plugin):
@@ -659,15 +664,36 @@ class PluginContainer(Plugin):
"""
def __contains__(self, plugin: Plugin) -> bool: ...
- def __delitem__(self, index: int) -> None: ...
- def __getitem__(self, index: int) -> Plugin: ...
+ def __delitem__(self, index: int) -> None:
+ """
+ Delete a plugin by its index. Index may be negative. If the index is out of range, an IndexError will be thrown.
+ """
+ def __getitem__(self, index: int) -> Plugin:
+ """
+ Get a plugin by its index. Index may be negative. If the index is out of range, an IndexError will be thrown.
+ """
def __init__(self, plugins: typing.List[Plugin]) -> None: ...
def __iter__(self) -> typing.Iterator: ...
- def __len__(self) -> int: ...
- def __setitem__(self, index: int, plugin: Plugin) -> None: ...
- def append(self, arg0: Plugin) -> None: ...
- def insert(self, index: int, plugin: Plugin) -> None: ...
- def remove(self, plugin: Plugin) -> None: ...
+ def __len__(self) -> int:
+ """
+ Get the number of plugins in this container.
+ """
+ def __setitem__(self, index: int, plugin: Plugin) -> None:
+ """
+ Replace a plugin at the specified index. Index may be negative. If the index is out of range, an IndexError will be thrown.
+ """
+ def append(self, plugin: Plugin) -> None:
+ """
+ Append a plugin to the end of this container.
+ """
+ def insert(self, index: int, plugin: Plugin) -> None:
+ """
+ Insert a plugin at the specified index.
+ """
+ def remove(self, plugin: Plugin) -> None:
+ """
+ Remove a plugin by its value.
+ """
pass
class Resample(Plugin):
@@ -701,9 +727,7 @@ class Resample(Plugin):
The highest quality and slowest resampling method, with no audible artifacts.
"""
def __init__(
- self,
- target_sample_rate: float = 8000.0,
- quality: Resample.Quality = pedalboard.Resample.Quality.WindowedSinc,
+ self, target_sample_rate: float = 8000.0, quality: Quality = Quality.WindowedSinc
) -> None: ...
def __repr__(self) -> str: ...
@property
@@ -730,11 +754,11 @@ class Resample(Plugin):
"""
The sample rate to resample the input audio to. This value may be a floating-point number, in which case a floating-point sampling rate will be used. Note that the output of this plugin will still be at the original sample rate; this is merely the sample rate used for quality reduction.
"""
- CatmullRom: pedalboard.Resample.Quality # value = <Quality.CatmullRom: 2>
- Lagrange: pedalboard.Resample.Quality # value = <Quality.Lagrange: 3>
- Linear: pedalboard.Resample.Quality # value = <Quality.Linear: 1>
- WindowedSinc: pedalboard.Resample.Quality # value = <Quality.WindowedSinc: 4>
- ZeroOrderHold: pedalboard.Resample.Quality # value = <Quality.ZeroOrderHold: 0>
+ CatmullRom: pedalboard_native.Resample.Quality # value = <Quality.CatmullRom: 2>
+ Lagrange: pedalboard_native.Resample.Quality # value = <Quality.Lagrange: 3>
+ Linear: pedalboard_native.Resample.Quality # value = <Quality.Linear: 1>
+ WindowedSinc: pedalboard_native.Resample.Quality # value = <Quality.WindowedSinc: 4>
+ ZeroOrderHold: pedalboard_native.Resample.Quality # value = <Quality.ZeroOrderHold: 0>
pass
class Reverb(Plugin):
@@ -899,37 +923,13 @@ class _AudioProcessorParameter:
"""
pass
-class ExternalPlugin(Plugin):
- def __init__(
- self,
- path_to_plugin_file: str,
- parameter_values: Dict[str, Union[str, int, float, bool]] = ...,
- plugin_name: Optional[str] = ...,
- ) -> None: ...
- @classmethod
- def get_plugin_names_for_file(cls, filename: str) -> List[str]: ...
- def show_editor(self) -> None: ...
- @property
- def name(self) -> str: ...
- def __set_initial_parameter_values__(
- self, parameter_values: Dict[str, Union[str, int, float, bool]] = ...
- ): ...
- @property
- def parameters(self) -> Dict[str, AudioProcessorParameter]: ...
- def __dir__(self): ...
- def __getattr__(self, name: str): ...
- def __setattr__(self, name: str, value): ...
-
-class AudioUnitPlugin(ExternalPlugin):
+class _AudioUnitPlugin(Plugin):
"""
A wrapper around any Apple Audio Unit audio effect plugin. Only available on macOS.
"""
def __init__(
- self,
- path_to_plugin_file: str,
- parameter_values: Dict[str, Union[str, int, float, bool]] = ...,
- plugin_name: Optional[str] = ...,
+ self, path_to_plugin_file: str, plugin_name: typing.Optional[str] = None
) -> None: ...
def __repr__(self) -> str: ...
def _get_parameter(self, arg0: str) -> _AudioProcessorParameter: ...
@@ -956,16 +956,13 @@ class AudioUnitPlugin(ExternalPlugin):
"""
pass
-class VST3Plugin(ExternalPlugin):
+class _VST3Plugin(Plugin):
"""
A wrapper around any Steinberg® VST3 audio effect plugin. Note that plugins must already support the operating system currently in use (i.e.: if you're running Linux but trying to open a VST that does not support Linux, this will fail).
"""
def __init__(
- self,
- path_to_plugin_file: str,
- parameter_values: Dict[str, Union[str, int, float, bool]] = ...,
- plugin_name: Optional[str] = ...,
+ self, path_to_plugin_file: str, plugin_name: typing.Optional[str] = None
) -> None: ...
def __repr__(self) -> str: ...
def _get_parameter(self, arg0: str) -> _AudioProcessorParameter: ...
@@ -989,6 +986,8 @@ class VST3Plugin(ExternalPlugin):
def name(self) -> str:
"""
The name of this plugin.
+
+
"""
pass
@@ -1016,73 +1015,12 @@ def process(
:meta private:
"""
-from pedalboard_native.utils import Mix as Mix, Chain as Chain
-from pedalboard.version import __version__ as __version__
-
-class Pedalboard(Chain):
- """
- Run zero or more plugins as a plugin, just like when using a real-life pedalboard.
- """
-
- def __init__(self, plugins: Optional[List[Plugin]] = ...) -> None: ...
-
-class AudioProcessorParameter:
- def __init__(self, plugin, parameter_name, search_steps: int = ...) -> None: ...
- @property
- def label(self) -> Optional[str]: ...
- @property
- def units(self) -> Optional[str]: ...
- def __getattr__(self, name: str): ...
- def __setattr__(self, name: str, value): ...
- def get_raw_value_for(self, new_value: Union[float, str, bool]) -> float: ...
-
-def load_plugin(
- path_to_plugin_file: str,
- parameter_values: Dict[str, Union[str, int, float, bool]] = ...,
- plugin_name: Union[str, None] = ...,
-) -> ExternalPlugin:
- """
- Load an audio plugin.
-
- Two plugin formats are supported:
- - VST3® format is supported on macOS, Windows, and Linux
- - Audio Units are supported on macOS
-
- Args:
- path_to_plugin_file (str): The path of a VST3® or Audio Unit plugin file or bundle.
-
- parameter_values (Dict[str, Union[str, int, float, bool]]):
- An optional dictionary of initial values to provide to the plugin
- after loading. Keys in this dictionary are expected to match the
- parameter names reported by the plugin, but normalized to strings
- that can be used as Python identifiers. (These are the same
- identifiers that are used as keys in the ``.parameters`` dictionary
- of a loaded plugin.)
-
- plugin_name (Optional[str]):
- An optional plugin name that can be used to load a specific plugin
- from a multi-plugin package. If a package is loaded but a
- ``plugin_name`` is not provided, an exception will be thrown.
-
- Returns:
- an instance of :class:`pedalboard.VST3Plugin` or :class:`pedalboard.AudioUnitPlugin`
-
- Throws:
- ``ImportError``: if the plugin cannot be found or loaded
-
- ``RuntimeError``: if the plugin file contains more than one plugin,
- but no ``plugin_name`` was provided
- """
- ...
-
class GSMFullRateCompressor(Plugin):
"""
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.
"""
- def __init__(
- self, quality: Resample.Quality = pedalboard.Resample.Quality.WindowedSinc
- ) -> None: ...
+ def __init__(self, quality: Resample.Quality = Resample.Quality.WindowedSinc) -> None: ...
def __repr__(self) -> str: ...
@property
def quality(self) -> Resample.Quality:
diff --git a/pedalboard_native/_internal/__init__.pyi b/pedalboard_native/_internal/__init__.pyi
new file mode 100644
index 0000000..174c448
--- /dev/null
+++ b/pedalboard_native/_internal/__init__.pyi
@@ -0,0 +1,58 @@
+from __future__ import annotations
+import pedalboard_native._internal
+import typing
+from typing_extensions import Literal
+from enum import Enum
+import pedalboard_native
+
+__all__ = [
+ "AddLatency",
+ "FixedSizeBlockTestPlugin",
+ "ForceMonoTestPlugin",
+ "PrimeWithSilenceTestPlugin",
+ "ResampleWithLatency",
+]
+
+class AddLatency(pedalboard_native.Plugin):
+ """
+ A dummy plugin that delays input audio for the given number of samples before passing it back to the output. Used internally to test Pedalboard's automatic latency compensation. Probably not useful as a real effect.
+ """
+
+ def __init__(self, samples: int = 44100) -> None: ...
+ pass
+
+class FixedSizeBlockTestPlugin(pedalboard_native.Plugin):
+ def __init__(self, expected_block_size: int = 160) -> None: ...
+ def __repr__(self) -> str: ...
+ pass
+
+class ForceMonoTestPlugin(pedalboard_native.Plugin):
+ def __repr__(self) -> str: ...
+ pass
+
+class PrimeWithSilenceTestPlugin(pedalboard_native.Plugin):
+ def __init__(self, expected_silent_samples: int = 160) -> None: ...
+ def __repr__(self) -> str: ...
+ pass
+
+class ResampleWithLatency(pedalboard_native.Plugin):
+ def __init__(
+ self,
+ target_sample_rate: float = 8000.0,
+ internal_latency: int = 1024,
+ quality: pedalboard_native.Resample.Quality = pedalboard_native.Resample.Quality.WindowedSinc,
+ ) -> None: ...
+ def __repr__(self) -> str: ...
+ @property
+ def quality(self) -> pedalboard_native.Resample.Quality:
+ """ """
+ @quality.setter
+ def quality(self, arg1: pedalboard_native.Resample.Quality) -> None:
+ pass
+ @property
+ def target_sample_rate(self) -> float:
+ """ """
+ @target_sample_rate.setter
+ def target_sample_rate(self, arg1: float) -> None:
+ pass
+ pass
diff --git a/pedalboard/io/__init__.pyi b/pedalboard_native/io/__init__.pyi
similarity index 97%
rename from pedalboard/io/__init__.pyi
rename to pedalboard_native/io/__init__.pyi
index d895e15..d805da9 100644
--- a/pedalboard/io/__init__.pyi
+++ b/pedalboard_native/io/__init__.pyi
@@ -2,8 +2,7 @@
*Introduced in v0.5.1.*"""
from __future__ import annotations
-import pedalboard_native.io # type: ignore # type: ignore
-import pedalboard # type: ignore
+import pedalboard_native.io
import typing
from typing_extensions import Literal
from enum import Enum
@@ -215,7 +214,7 @@ class ReadableAudioFile(AudioFile):
def resampled_to(
self,
target_sample_rate: float,
- quality: pedalboard.Resample.Quality = pedalboard.Resample.Quality.WindowedSinc,
+ quality: pedalboard_native.Resample.Quality = pedalboard_native.Resample.Quality.WindowedSinc,
) -> ResampledReadableAudioFile:
"""
Return a :class:`ResampledReadableAudioFile` that will automatically resample this :class:`ReadableAudioFile` to the provided `target_sample_rate`, using a constant amount of memory.
@@ -333,14 +332,14 @@ class ResampledReadableAudioFile(AudioFile):
self,
audio_file: ReadableAudioFile,
target_sample_rate: float,
- resampling_quality: pedalboard.Resample.Quality = pedalboard.Resample.Quality.WindowedSinc,
+ resampling_quality: pedalboard_native.Resample.Quality = pedalboard_native.Resample.Quality.WindowedSinc,
) -> None: ...
@staticmethod
def __new__(
cls: object,
audio_file: ReadableAudioFile,
target_sample_rate: float,
- resampling_quality: pedalboard.Resample.Quality = pedalboard.Resample.Quality.WindowedSinc,
+ resampling_quality: pedalboard_native.Resample.Quality = pedalboard_native.Resample.Quality.WindowedSinc,
) -> ResampledReadableAudioFile: ...
def __repr__(self) -> str: ...
def close(self) -> None:
@@ -422,7 +421,7 @@ class ResampledReadableAudioFile(AudioFile):
"""
@property
- def resampling_quality(self) -> pedalboard.Resample.Quality:
+ def resampling_quality(self) -> pedalboard_native.Resample.Quality:
"""
The resampling algorithm used to resample from the original file's sample rate to the ``target_sample_rate``.
@@ -451,7 +450,7 @@ class StreamResampler:
source_sample_rate: float,
target_sample_rate: float,
num_channels: int,
- quality: pedalboard.Resample.Quality = pedalboard.Resample.Quality.WindowedSinc,
+ quality: pedalboard_native.Resample.Quality = pedalboard_native.Resample.Quality.WindowedSinc,
) -> None:
"""
Create a new StreamResampler, capable of resampling a potentially-unbounded audio stream with a constant amount of memory. The source sample rate, target sample rate, quality, or number of channels cannot be changed once the resampler is instantiated.
@@ -482,7 +481,7 @@ class StreamResampler:
"""
@property
- def quality(self) -> pedalboard.Resample.Quality:
+ def quality(self) -> pedalboard_native.Resample.Quality:
"""
The resampling algorithm used by this resampler.
diff --git a/pedalboard_native/utils/__init__.pyi b/pedalboard_native/utils/__init__.pyi
new file mode 100644
index 0000000..12d591e
--- /dev/null
+++ b/pedalboard_native/utils/__init__.pyi
@@ -0,0 +1,30 @@
+from __future__ import annotations
+import pedalboard_native.utils
+import typing
+from typing_extensions import Literal
+from enum import Enum
+import pedalboard_native
+
+__all__ = ["Chain", "Mix"]
+
+class Chain(pedalboard_native.PluginContainer, pedalboard_native.Plugin):
+ """
+ Run zero or more plugins as a plugin. Useful when used with the Mix plugin.
+ """
+
+ @typing.overload
+ @typing.overload
+ def __init__(self, plugins: typing.List[pedalboard_native.Plugin]) -> None: ...
+ def __repr__(self) -> str: ...
+ pass
+
+class Mix(pedalboard_native.PluginContainer, pedalboard_native.Plugin):
+ """
+ A utility plugin that allows running other plugins in parallel. All plugins provided will be mixed equally.
+ """
+
+ @typing.overload
+ @typing.overload
+ def __init__(self, plugins: typing.List[pedalboard_native.Plugin]) -> None: ...
+ def __repr__(self) -> str: ...
+ pass
diff --git a/scripts/generate_type_stubs_and_docs.py b/scripts/generate_type_stubs_and_docs.py
index c200c64..e3a895a 100644
--- a/scripts/generate_type_stubs_and_docs.py
+++ b/scripts/generate_type_stubs_and_docs.py
@@ -1,4 +1,5 @@
import os
+import re
import sys
import argparse
import inspect
@@ -6,20 +7,111 @@ import typing
import shutil
import difflib
import importlib
+import pathlib
import traceback
-import subprocess
from tempfile import TemporaryDirectory
from contextlib import contextmanager
-from typing import List
+from typing import Dict, List
+from pybind11_stubgen import ClassStubsGenerator, StubsGenerator
+from pybind11_stubgen import main as pybind11_stubgen_main
+import mypy.stubtest
from mypy.stubtest import test_stubs, parse_options as mypy_parse_options
import sphinx.ext.autodoc.importer
from sphinx.cmd.build import main as sphinx_build_main
+from scripts.postprocess_type_hints import main as postprocess_type_hints_main
MAX_DIFF_LINE_LENGTH = 150
+SPHINX_REPLACEMENTS = {
+ # Pretend that the `pedalboard_native` package just does not exist:
+ r"pedalboard_native\.": r"pedalboard.",
+ # Remove any "self: <foo>," lines:
+ (
+ r'<em class="sig-param"><span class="n"><span class="pre">self'
+ r'</span></span><span class="p"><span class="pre">:.*?</em>, '
+ ): r"",
+ # Remove any "(self: <foo>)" lines too:
+ (
+ r'<em class="sig-param"><span class="n"><span class="pre">self</span>'
+ r'</span><span class="p"><span class="pre">:.*?</em><span class="sig-paren">\)</span>'
+ ): r'<span class="sig-paren">)</span>',
+ # Sometimes Sphinx fully-qualifies names, other times it doesn't. Here are some special cases:
+ r'<span class="pre">pedalboard\.Plugin</span>': r'<span class="pre">Plugin</span>',
+}
+
+
+def patch_mypy_stubtest():
+ def patched_verify_metaclass(*args, **kwargs):
+ # Just ignore metaclass mismatches entirely:
+ return []
+
+ mypy.stubtest._verify_metaclass = patched_verify_metaclass
+
+
+def patch_pybind11_stubgen():
+ """
+ Patch ``pybind11_stubgen`` to generate more ergonomic code for Enum-like classes.
+ This generates a subclass of :class:``Enum`` for each Pybind11-generated Enum,
+ which is not strictly correct, but produces much nicer documentation and allows
+ for a much more Pythonic API.
+ """
+
+ original_class_stubs_generator_new = ClassStubsGenerator.__new__
+
+ class EnumClassStubsGenerator(StubsGenerator):
+ def __init__(self, klass):
+ self.klass = klass
+ assert inspect.isclass(klass)
+ assert klass.__name__.isidentifier()
+ assert hasattr(klass, "__entries")
+
+ self.doc_string = None
+ self.enum_names = []
+ self.enum_values = []
+ self.enum_docstrings = []
+
+ def get_involved_modules_names(self):
+ return []
+
+ def parse(self):
+ self.doc_string = self.klass.__doc__ or ""
+ self.doc_string = self.doc_string.split("Members:")[0]
+ for name, (value_object, docstring) in getattr(self.klass, "__entries").items():
+ self.enum_names.append(name)
+ self.enum_values.append(value_object.value)
+ self.enum_docstrings.append(docstring)
+
+ def to_lines(self):
+ result = [
+ "class {class_name}(Enum):{doc_string}".format(
+ class_name=self.klass.__name__,
+ doc_string="\n" + self.format_docstring(self.doc_string)
+ if self.doc_string
+ else "",
+ ),
+ ]
+ for (name, value, docstring) in sorted(
+ list(zip(self.enum_names, self.enum_values, self.enum_docstrings)),
+ key=lambda x: x[1],
+ ):
+ result.append(f" {name} = {value} # fmt: skip")
+ result.append(f"{self.format_docstring(docstring)}")
+ if not self.enum_names:
+ result.append(self.indent("pass"))
+ return result
+
+ def patched_class_stubs_generator_new(cls, klass, *args, **kwargs):
+ if hasattr(klass, "__entries"):
+ return EnumClassStubsGenerator(klass, *args, **kwargs)
+ else:
+ return original_class_stubs_generator_new(cls)
+
+ ClassStubsGenerator.__new__ = patched_class_stubs_generator_new
+
+
def import_stub(stubs_path: str, module_name: str) -> typing.Any:
"""
Import a stub file (.pyi) as a regular Python module.
@@ -40,52 +132,26 @@ def import_stub(stubs_path: str, module_name: str) -> typing.Any:
sys.path_hooks.pop(0)
-def patch_sphinx(module_names_to_combine: typing.Set[str]):
+def patch_sphinx_to_read_pyi():
"""
Sphinx doesn't know how to read .pyi files, but we use .pyi files as our
"source of truth" for the public API that we expose to IDEs and our documentation.
- This patch tells Sphinx how to read .pyi files, and goes one step further to
- combine both our "fake" module from our .pyi files and any real Python code
- in our regular modules.
+ This patch tells Sphinx how to read .pyi files, using them to replace their .py
+ counterparts.
"""
old_import_module = sphinx.ext.autodoc.importer.import_module
def patch_import_module(modname: str, *args, **kwargs) -> typing.Any:
if modname in sys.modules:
return sys.modules[modname]
- if modname in module_names_to_combine:
- try:
- pyi_module = import_stub(".", modname)
- except Exception as e:
- print(f"Failed to import stub module: {e}")
- traceback.print_exc()
- raise
- # Remove the stub module from the module cache:
- temp_module_holding_area = {}
- for module_name in list(sys.modules.keys()):
- if module_name.split(".")[0] in module_names_to_combine:
- temp_module_holding_area[module_name] = sys.modules[module_name]
- del sys.modules[module_name]
- try:
- regular_module = importlib.import_module(modname, None)
- except Exception as e:
- print(f"Failed to import regular module: {e}")
- raise
- for x in dir(regular_module):
- if (
- not hasattr(pyi_module, x)
- and not inspect.ismodule(getattr(regular_module, x))
- and not x.startswith("_")
- ):
- setattr(pyi_module, x, getattr(regular_module, x))
- getattr(pyi_module, "__all__").append(x)
- sys.modules.update(temp_module_holding_area)
-
- # The sort order of __all__ is used by Sphinx:
- getattr(pyi_module, "__all__").sort()
-
- return pyi_module
- return old_import_module(modname, *args, **kwargs)
+ try:
+ return import_stub(".", modname)
+ except ImportError:
+ return old_import_module(modname, *args, **kwargs)
+ except Exception as e:
+ print(f"Failed to import stub module: {e}")
+ traceback.print_exc()
+ raise
sphinx.ext.autodoc.importer.import_module = patch_import_module
@@ -136,6 +202,22 @@ def glob_matches(filename: str, globs: List[str]) -> bool:
return False
+def postprocess_sphinx_output(directory: str, renames: Dict[str, str]):
+ """
+ I've spent 7 hours of my time this weekend fighting with Sphinx.
+ Rather than find the "correct" way to fix this, I'm just going to
+ overwrite the HTML output with good old find-and-replace.
+ """
+ for html_path in pathlib.Path(directory).rglob("*.html"):
+ html_contents = html_path.read_text()
+ for find, replace in renames.items():
+ results = re.findall(find, html_contents)
+ if results:
+ html_contents = re.sub(find, replace, html_contents)
+ with open(html_path, "w") as f:
+ f.write(html_contents)
+
+
def main():
parser = argparse.ArgumentParser(
description="Generate type stub files (.pyi) and Sphinx documentation for Pedalboard."
@@ -172,12 +254,42 @@ def main():
)
args = parser.parse_args()
- patch_sphinx(module_names_to_combine={"pedalboard", "pedalboard.io"})
+ patch_mypy_stubtest()
+ patch_pybind11_stubgen()
+ patch_sphinx_to_read_pyi()
if not args.skip_regenerating_type_hints:
- with TemporaryDirectory() as tempdir, isolated_imports({"pedalboard", "pedalboard.io"}):
- print("Generating type stubs from pure-Python code...")
- subprocess.check_call(["stubgen", "-o", tempdir, "pedalboard/_pedalboard.py"])
+ with isolated_imports(
+ {
+ "pedalboard",
+ "pedalboard.io",
+ "pedalboard_native",
+ "pedalboard_native.io",
+ "pedalboard_native.utils",
+ }
+ ):
+ # print("Generating type stubs from pure-Python code...")
+ # subprocess.check_call(["stubgen", "-o", tempdir, "pedalboard/_pedalboard.py"])
+
+ # Generate .pyi stubs files from Pedalboard's native (Pybind11) source.
+ # Documentation will be copied from the Pybind11 docstrings, and these stubs
+ # files will be used as the "source of truth" for both IDE autocompletion
+ # and Sphinx documentation.
+ print("Generating type stubs from native code...")
+ pybind11_stubgen_main(["-o", "pedalboard_native", "pedalboard_native", "--no-setup-py"])
+
+ # Move type hints out of pedalboard_native/something_else/*:
+ native_dir = pathlib.Path("pedalboard_native")
+ native_subdir = [f for f in native_dir.glob("*") if "stubs" in f.name][0]
+ shutil.copytree(native_subdir, native_dir, dirs_exist_ok=True)
+ shutil.rmtree(native_subdir)
+
+ # Post-process the type hints generaetd by pybind11_stubgen; we can't patch
+ # everything easily, so we do string manipulation after-the-fact and run ``black``.
+ print("Postprocessing generated type hints...")
+ postprocess_type_hints_main(
+ ["pedalboard_native", "pedalboard_native"] + (["--check"] if args.check else [])
+ )
# Run mypy.stubtest to ensure that the results are correct and nothing got missed:
if sys.version_info > (3, 6):
@@ -195,15 +307,20 @@ def main():
)
# Why is this necessary? I don't know, but without it, things fail.
- print("Importing numpy to ensure a successful Pedalboard import...")
+ print("Importing numpy to ensure a successful Pedalboard stub import...")
import numpy # noqa
+ print("Importing .pyi files for our native modules...")
+ for modname in ["pedalboard_native", "pedalboard_native.io", "pedalboard_native.utils"]:
+ import_stub(".", modname)
+
print("Running Sphinx...")
if args.check:
missing_files = []
mismatched_files = []
with TemporaryDirectory() as tempdir:
- sphinx_build_main(["-b", "html", args.docs_input_dir, tempdir])
+ sphinx_build_main(["-b", "html", args.docs_input_dir, tempdir, "-v", "-v", "-v"])
+ postprocess_sphinx_output(tempdir, SPHINX_REPLACEMENTS)
remove_non_public_files(tempdir)
for (dirpath, _dirnames, filenames) in os.walk(tempdir):
@@ -254,6 +371,7 @@ def main():
print("Done! Generated type stubs and documentation are valid.")
else:
sphinx_build_main(["-b", "html", args.docs_input_dir, args.docs_output_dir])
+ postprocess_sphinx_output(args.docs_output_dir, SPHINX_REPLACEMENTS)
remove_non_public_files(args.docs_output_dir)
print(f"Done! Commit the contents of `{args.docs_output_dir}` to Git.")
diff --git a/scripts/postprocess_type_hints.py b/scripts/postprocess_type_hints.py
new file mode 100644
index 0000000..719b0c4
--- /dev/null
+++ b/scripts/postprocess_type_hints.py
@@ -0,0 +1,188 @@
+"""
+This script is intended to postprocess type hint (.pyi) files produced by pybind11-stubgen.
+
+A number of changes must be made to produce valid type hint files out-of-the-box.
+Think of this as a more intelligent (or less intelligent) application of `git patch`.
+"""
+
+import os
+import io
+import re
+import difflib
+from pathlib import Path
+from collections import defaultdict
+import black
+import argparse
+
+REPO_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
+
+OMIT_FILES = []
+
+# Any lines containing any of these substrings will be omitted from the pedalboard_native stubs:
+OMIT_LINES_CONTAINING = [
+ "installed_plugins = [",
+ "typing._GenericAlias",
+ "typing._VariadicGenericAlias",
+ "typing._SpecialForm",
+ "__annotations__: dict",
+ "_AVAILABLE_PLUGIN_CLASSES: list",
+]
+
+REPLACEMENTS = [
+ # object is a superclass of `str`, which would make these declarations ambiguous:
+ ("file_like: object", "file_like: typing.BinaryIO"),
+ # "r" is the default file open/reading mode:
+ ("mode: str = 'r'", r'mode: Literal["r"] = "r"'),
+ # ... but when using "w", "w" needs to be specified explicitly (no default):
+ ("mode: str = 'w'", r'mode: Literal["w"]'),
+ # ndarrays need to be corrected as well:
+ (r"numpy\.ndarray\[(.*?)\]", r"numpy.ndarray[typing.Any, numpy.dtype[\1]]"),
+ # None of our enums are properly detected by pybind11-stubgen:
+ (
+ # For Python 3.6 compatibility:
+ r"import typing",
+ "\n".join(
+ ["import typing", "from typing_extensions import Literal", "from enum import Enum"]
+ ),
+ ),
+ # None of our enums are properly detected by pybind11-stubgen. These are brittle hacks:
+ (r"0, quality: Resample\.Quality", "0, quality: Quality"),
+ (r"self, quality: Resample\.Quality = Quality", "self, quality: Resample.Quality = Resample.Quality"),
+ (r"pedalboard_native\.Resample\.Quality = Quality", "pedalboard_native.Resample.Quality = pedalboard_native.Resample.Quality"),
+
+ # Remove type hints in docstrings, added unnecessarily by pybind11-stubgen
+ (r".*?:type:.*$", ""),
+ # MyPy chokes on classes that contain both __new__ and __init__.
+ # Remove all bare, arg-free inits:
+ (r"def __init__\(self\) -> None: ...", ""),
+]
+
+REMOVE_INDENTED_BLOCKS_STARTING_WITH = [
+ # TODO(psobot): Add a conditional to _AudioUnitPlugin
+ # to ensure type stubs only show up on macOS:
+ # "class _AudioUnitPlugin(Plugin):"
+]
+
+# .pyi files usually don't care about dependent types being present in order in the file;
+# but if we want to use Sphinx, our Python files need to be both lexically and semantically
+# valid as regular Python files. So...
+INDENTED_BLOCKS_TO_MOVE_TO_END = ["class GSMFullRateCompressor"]
+
+LINES_TO_IGNORE_FOR_MATCH = {"from __future__ import annotations"}
+
+
+def stub_files_match(a: str, b: str) -> bool:
+ a = "".join(
+ [x for x in a.split("\n") if x.strip() and x.strip() not in LINES_TO_IGNORE_FOR_MATCH]
+ )
+ b = "".join(
+ [x for x in b.split("\n") if x.strip() and x.strip() not in LINES_TO_IGNORE_FOR_MATCH]
+ )
+ return a == b
+
+
+def main(args=None):
+ parser = argparse.ArgumentParser(
+ description="Post-process type hint files produced by pybind11-stubgen for Pedalboard."
+ )
+ parser.add_argument(
+ "source_directory",
+ default=os.path.join(REPO_ROOT, "pybind11-stubgen-output"),
+ )
+ parser.add_argument(
+ "target_directory",
+ default=os.path.join(REPO_ROOT, "pedalboard"),
+ )
+ parser.add_argument(
+ "--check",
+ action="store_true",
+ help=(
+ "Return a non-zero exit code if files on disk don't match what this script would"
+ " generate."
+ ),
+ )
+ args = parser.parse_args(args)
+
+ output_file_to_source_files = defaultdict(list)
+ for source_path in Path(args.source_directory).rglob("*.pyi"):
+ output_file_to_source_files[str(source_path)].append(str(source_path))
+
+ for output_file_name, source_files in output_file_to_source_files.items():
+ os.makedirs(os.path.dirname(output_file_name), exist_ok=True)
+
+ print(f"Writing stub file {output_file_name}...")
+
+ file_contents = io.StringIO()
+ end_of_file_contents = io.StringIO()
+ for source_file in source_files:
+ module_name = output_file_name.replace("__init__.pyi", "").replace("/", ".").rstrip(".")
+ with open(source_file) as f:
+ in_excluded_indented_block = False
+ in_moved_indented_block = False
+ for line in f:
+ if all(x not in line for x in OMIT_LINES_CONTAINING):
+ if any(line.startswith(x) for x in REMOVE_INDENTED_BLOCKS_STARTING_WITH):
+ in_excluded_indented_block = True
+ continue
+ elif any(line.startswith(x) for x in INDENTED_BLOCKS_TO_MOVE_TO_END):
+ in_moved_indented_block = True
+ elif line.strip() and not line.startswith(" "):
+ in_excluded_indented_block = False
+ in_moved_indented_block = False
+
+ if in_excluded_indented_block:
+ continue
+
+ for _tuple in REPLACEMENTS:
+ if len(_tuple) == 2:
+ find, replace = _tuple
+ only_in_module = None
+ else:
+ find, replace, only_in_module = _tuple
+ if only_in_module and only_in_module != module_name:
+ continue
+ results = re.findall(find, line)
+ if results:
+ line = re.sub(find, replace, line)
+
+ if in_moved_indented_block:
+ end_of_file_contents.write(line)
+ else:
+ file_contents.write(line)
+ print(f"\tRead {f.tell():,} bytes of stubs from {source_file}.")
+
+ # Append end-of-file contents at the end:
+ file_contents.write("\n")
+ file_contents.write(end_of_file_contents.getvalue())
+
+ # Run black:
+ try:
+ output = black.format_file_contents(
+ file_contents.getvalue(),
+ fast=False,
+ mode=black.FileMode(is_pyi=True, line_length=100),
+ )
+ except black.report.NothingChanged:
+ output = file_contents.getvalue()
+
+ if args.check:
+ with open(output_file_name, "r") as f:
+ existing = f.read()
+ if not stub_files_match(existing, output):
+ error = f"File that would be generated ({output_file_name}) "
+ error += "does not match existing file!\n"
+ error += f"Existing file had {len(existing):,} bytes, "
+ error += f"expected {len(output):,} bytes.\nDiff was:\n"
+ diff = difflib.context_diff(existing.split("\n"), output.split("\n"))
+ error += "\n".join([x.strip() for x in diff])
+ raise ValueError(error)
+ else:
+ with open(output_file_name, "w") as o:
+ o.write(output)
+ print(f"\tWrote {o.tell():,} bytes of stubs to {output_file_name}.")
+
+ print("Done!")
+
+
+if __name__ == "__main__":
+ main()
diff --git a/setup.py b/setup.py
index c864be3..41be440 100644
--- a/setup.py
+++ b/setup.py
@@ -332,9 +332,10 @@ setup(
],
ext_modules=[pedalboard_cpp],
install_requires=['numpy'],
- packages=['pedalboard', 'pedalboard.io'],
+ packages=['pedalboard', 'pedalboard.io', 'pedalboard_native'],
package_data={
- 'pedalboard': ['py.typed', '*.pyi', '**/*.pyi']
+ 'pedalboard': ['py.typed', '*.pyi', '**/*.pyi'],
+ 'pedalboard_native': ['py.typed', '*.pyi', '**/*.pyi']
},
cmdclass={"build_ext": BuildC_CxxExtensions},
)