diff options
Diffstat (limited to 'doc/classes/ladspa.html')
| -rw-r--r-- | doc/classes/ladspa.html | 298 |
1 files changed, 298 insertions, 0 deletions
diff --git a/doc/classes/ladspa.html b/doc/classes/ladspa.html new file mode 100644 index 0000000..846b65b --- /dev/null +++ b/doc/classes/ladspa.html @@ -0,0 +1,298 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>Melisma modules</title> + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<p><a href="/melisma-modules">Back to repository</a></p> +<br/> +<h1>Melisma modules</h1> + + +<ul> + <li><a href="../index.html">Index</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Functions">Functions</a></li> +<li><a href="#Methods">Methods</a></li> +</ul> + + +<h2>Classes</h2> +<ul class="nowrap"> + <li><a href="../classes/buffer.html">buffer</a></li> + <li><a href="../classes/delay.html">delay</a></li> + <li><a href="../classes/gain.html">gain</a></li> + <li><a href="../classes/interp.html">interp</a></li> + <li><strong>ladspa</strong></li> + <li><a href="../classes/mixer.html">mixer</a></li> + <li><a href="../classes/nullsink.html">nullsink</a></li> + <li><a href="../classes/oscil.html">oscil</a></li> + <li><a href="../classes/pan.html">pan</a></li> + <li><a href="../classes/playback.html">playback</a></li> + <li><a href="../classes/sample.html">sample</a></li> + <li><a href="../classes/serial.html">serial</a></li> + <li><a href="../classes/timer.html">timer</a></li> +</ul> +<h2>Modules</h2> +<ul class="nowrap"> + <li><a href="../modules/biquad.html">biquad</a></li> + <li><a href="../modules/expression.html">expression</a></li> + <li><a href="../modules/fs.html">fs</a></li> + <li><a href="../modules/keycallback.html">keycallback</a></li> + <li><a href="../modules/udp.html">udp</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Class <code>ladspa</code></h1> +<p>LADSPA plugin support.</p> +<p> + + + +<pre> +<span class="keyword">local</span> mladspa = <span class="global">require</span> <span class="string">'melisma.ladspa'</span> + +<span class="keyword">local</span> spec = <span class="string">'caps.so:Plate'</span> +<span class="keyword">local</span> info = mladspa.<span class="function-name">info</span>(spec) + +<span class="global">print</span>(<span class="string">'name:'</span>,info.name) +<span class="global">print</span>(<span class="string">'maker:'</span>,info.maker) + +<span class="keyword">local</span> input = ... +<span class="keyword">local</span> plate = mladspa.<span class="global">load</span>(spec,input) + +plate:<span class="function-name">control</span>(<span class="number">1</span>,<span class="number">1</span>) + +<span class="keyword">local</span> left = plate:<span class="function-name">out</span>(<span class="number">6</span>) +<span class="keyword">local</span> right = plate:<span class="function-name">out</span>(<span class="number">7</span>) +</pre> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#ladspa.info">ladspa.info(spec)</a></td> + <td class="summary">Get information about a specific plugin.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ladspa.lib_info">ladspa.lib_info(path)</a></td> + <td class="summary">List plugins in the specified plugin library.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ladspa.load">ladspa.load(spec, ...)</a></td> + <td class="summary">Load a ladspa plugin.</td> + </tr> +</table> +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#ladspa:control">ladspa:control(i, v)</a></td> + <td class="summary">Set the value of an input control port.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ladspa:out">ladspa:out(i)</a></td> + <td class="summary">Get the audio output port at the specified index.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + Methods + <dl class="function"> + <dt> + <a name = "ladspa.info"></a> + <strong>ladspa.info(spec)</strong> + </dt> + <dd> + Get information about a specific plugin. </p> + +<p>Plugin specifications are written in the format <code><path>:<plugin></code>, +where <code><path></code> is the full name of the plugin library +(e.g. <code>caps.so</code>), and <code><plugin></code> is the name or label of the plugin. +If <code><path></code> is not an absolute path, the library is searched for +first in the current directory, then in <code>LADSPA_PATH</code>.</p> + +<p>This can be used to generate more ergonomic plugin interfaces. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">spec</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span> + Plugin specification. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span> + Plugin information. + </ol> + + + + +</dd> + <dt> + <a name = "ladspa.lib_info"></a> + <strong>ladspa.lib_info(path)</strong> + </dt> + <dd> + List plugins in the specified plugin library. </p> + +<p>If <code>path</code> is not an absolute path, the library is searched for +first in the current directory, then in <code>LADSPA_PATH</code>. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">path</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span> + Path to plugin library. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span> + List of short plugin descriptions. + </ol> + + + + +</dd> + <dt> + <a name = "ladspa.load"></a> + <strong>ladspa.load(spec, ...)</strong> + </dt> + <dd> + Load a ladspa plugin. </p> + +<p>Input signals are connected to the plugins audio input ports in the +order that they are declared. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">spec</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span> + Plugin specification. + </li> + <li><span class="parameter">...</span> + <span class="types"><span class="type">channel</span></span> + Input signals. + </li> + </ul> + + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "ladspa:control"></a> + <strong>ladspa:control(i, v)</strong> + </dt> + <dd> + Set the value of an input control port. </p> + +<p>Ports are indexed based on the order they are declared by the plugin. +This also means the indices of control ports are not necessarily consecutive. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">i</span> + <span class="types"><span class="type">integer</span></span> + One-based port index. + </li> + <li><span class="parameter">v</span> + <span class="types"><span class="type">number</span></span> + New control port value. + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "ladspa:out"></a> + <strong>ladspa:out(i)</strong> + </dt> + <dd> + Get the audio output port at the specified index. </p> + +<p>Ports are indexed based on the order they are declared by the plugin. +This also means the indices of audio ports are not necessarily consecutive. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">i</span> + <span class="types"><span class="type">integer</span></span> + One-based port index. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><span class="type">channel</span></span> + Audio output at specified index. + </ol> + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> +<i style="float:right;">Last updated 1980-01-01 00:00:00 </i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> |