DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>DISTRHO Plugin Framework: DISTRHO Plugin Framework</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">DISTRHO Plugin Framework </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>DISTRHO Plugin Framework (or <b>DPF</b> for short) is a plugin framework designed to make development of new plugins an easy and enjoyable task.<br />
It allows developers to create plugins with custom UIs using a simple C++ API.<br />
The framework facilitates exporting various different plugin formats from the same code-base.</p>
<p>DPF can build for LADSPA, DSSI, LV2 and VST2 formats.<br />
A JACK/Standalone mode is also available, allowing you to quickly test plugins.</p>
<h1><a class="anchor" id="Macros"></a>
Macros</h1>
<p>You start by creating a "DistrhoPluginInfo.h" file describing the plugin via macros, see <a class="el" href="group__PluginMacros.html">Plugin Macros</a>.<br />
This file is included in the main DPF code to select which features to activate for each plugin format.</p>
<p>For example, a plugin (with UI) that use states will require LV2 hosts to support Atom and Worker extensions for message passing from the UI to the plugin.<br />
If your plugin does not make use of states, the Worker extension is not set as a required feature.</p>
<h1><a class="anchor" id="Plugin"></a>
Plugin</h1>
<p>The next step is to create your plugin code by subclassing DPF's <a class="el" href="classPlugin.html">Plugin</a> class.<br />
You need to pass the number of parameters in the constructor and also the number of programs and states, if any.</p>
<p>Here's an example of an audio plugin that simply mutes the host output: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MutePlugin : <span class="keyword">public</span> <a class="code" href="classPlugin.html">Plugin</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Plugin class constructor.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   MutePlugin()</div>
<div class="line">       : <a class="code" href="classPlugin.html">Plugin</a>(0, 0, 0) <span class="comment">// 0 parameters, 0 programs and 0 states</span></div>
<div class="line">   {</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line"><span class="keyword">protected</span>:</div>
<div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
<div class="line"><span class="comment">   * Information */</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Get the plugin label.</span></div>
<div class="line"><span class="comment">     This label is a short restricted name consisting of only _, a-z, A-Z and 0-9 characters.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">getLabel</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;Mute&quot;</span>;</div>
<div class="line">   }</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Get the plugin author/maker.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">getMaker</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>
<div class="line">   }</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Get the plugin license name (a single line of text).</span></div>
<div class="line"><span class="comment">     For commercial plugins this should return some short copyright information.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">getLicense</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>
<div class="line">   }</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Get the plugin version, in hexadecimal.</span></div>
<div class="line"><span class="comment">     TODO format to be defined</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> 0x1000;</div>
<div class="line">   }</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Get the plugin unique Id.</span></div>
<div class="line"><span class="comment">     This value is used by LADSPA, DSSI and VST plugin formats.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> cconst(<span class="charliteral">&#39;M&#39;</span>, <span class="charliteral">&#39;u&#39;</span>, <span class="charliteral">&#39;t&#39;</span>, <span class="charliteral">&#39;e&#39;</span>);</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
<div class="line"><span class="comment">   * This example has no parameters, so skip parameter stuff */</span></div>
<div class="line"></div>
<div class="line">   <span class="keywordtype">void</span>  <a class="code" href="classPlugin.html#a5b0ec59527a1c2f4b01f17fc8c18ea8b">initParameter</a>(uint32_t, <a class="code" href="structParameter.html">Parameter</a>&amp;)<span class="keyword"> override </span>{}</div>
<div class="line">   <span class="keywordtype">float</span> <a class="code" href="classPlugin.html#a2d1da98c90568bb4547662bc4f02c31f">getParameterValue</a>(uint32_t)<span class="keyword"> const   override </span>{ <span class="keywordflow">return</span> 0.0f; }</div>
<div class="line">   <span class="keywordtype">void</span>  <a class="code" href="classPlugin.html#a6911a881fabb9eca9daf0eadbaad8599">setParameterValue</a>(uint32_t, <span class="keywordtype">float</span>)<span class="keyword">  override </span>{}</div>
<div class="line"></div>
<div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
<div class="line"><span class="comment">   * Audio/MIDI Processing */</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Run/process function for plugins without MIDI input.</span></div>
<div class="line"><span class="comment">     NOTE: Some parameters might be null if there are no audio inputs or outputs.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>**, <span class="keywordtype">float</span>** outputs, uint32_t frames)<span class="keyword"> override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="comment">// get the left and right audio outputs</span></div>
<div class="line">       <span class="keywordtype">float</span>* <span class="keyword">const</span> outL = outputs[0];</div>
<div class="line">       <span class="keywordtype">float</span>* <span class="keyword">const</span> outR = outputs[1];</div>
<div class="line"></div>
<div class="line">       <span class="comment">// mute audio</span></div>
<div class="line">       std::memset(outL, 0, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)*frames);</div>
<div class="line">       std::memset(outR, 0, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)*frames);</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">};</div>
</div><!-- fragment --><p>See the <a class="el" href="classPlugin.html">Plugin</a> class for more information and to understand what each function does.</p>
<h1><a class="anchor" id="Parameters"></a>
Parameters</h1>
<p>A plugin is nothing without parameters.<br />
In DPF parameters can be inputs or outputs.<br />
They have hints to describe how they behave plus a name and a symbol identifying them.<br />
Parameters also have 'ranges' – a minimum, maximum and default value.</p>
<p>Input parameters are "read-only": the plugin can read them but not change them. (the exception being when changing programs, more on that below)<br />
It's the host responsibility to save, restore and set input parameters.</p>
<p>Output parameters can be changed at anytime by the plugin.<br />
The host will simply read their values and not change them.</p>
<p>Here's an example of an audio plugin that has 1 input parameter: </p><div class="fragment"><div class="line"><span class="keyword">class </span>GainPlugin : <span class="keyword">public</span> <a class="code" href="classPlugin.html">Plugin</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Plugin class constructor.</span></div>
<div class="line"><span class="comment">     You must set all parameter values to their defaults, matching ParameterRanges::def.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   GainPlugin()</div>
<div class="line">       : <a class="code" href="classPlugin.html">Plugin</a>(1, 0, 0), <span class="comment">// 1 parameter, 0 programs and 0 states</span></div>
<div class="line">         fGain(1.0f)</div>
<div class="line">   {</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line"><span class="keyword">protected</span>:</div>
<div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
<div class="line"><span class="comment">   * Information */</span></div>
<div class="line"></div>
<div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">getLabel</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;Mute&quot;</span>;</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">getMaker</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">getLicense</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">   uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> 0x1000;</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">   int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>()<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="keywordflow">return</span> cconst(<span class="charliteral">&#39;M&#39;</span>, <span class="charliteral">&#39;u&#39;</span>, <span class="charliteral">&#39;t&#39;</span>, <span class="charliteral">&#39;e&#39;</span>);</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
<div class="line"><span class="comment">   * Init */</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Initialize a parameter.</span></div>
<div class="line"><span class="comment">     This function will be called once, shortly after the plugin is created.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a5b0ec59527a1c2f4b01f17fc8c18ea8b">initParameter</a>(uint32_t index, <a class="code" href="structParameter.html">Parameter</a>&amp; parameter)<span class="keyword"> override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="comment">// we only have one parameter so we can skip checking the index</span></div>
<div class="line"></div>
<div class="line">       parameter.<a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a>  = <a class="code" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a>;</div>
<div class="line">       parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>   = <span class="stringliteral">&quot;Gain&quot;</span>;</div>
<div class="line">       parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a> = <span class="stringliteral">&quot;gain&quot;</span>;</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
<div class="line"><span class="comment">   * Internal data */</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Get the current value of a parameter.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   <span class="keywordtype">float</span> <a class="code" href="classPlugin.html#a2d1da98c90568bb4547662bc4f02c31f">getParameterValue</a>(uint32_t index)<span class="keyword"> const override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="comment">// same as before, ignore index check</span></div>
<div class="line"></div>
<div class="line">       <span class="keywordflow">return</span> fGain;</div>
<div class="line">   }</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">  /**</span></div>
<div class="line"><span class="comment">     Change a parameter value.</span></div>
<div class="line"><span class="comment">   */</span></div>
<div class="line">   <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a6911a881fabb9eca9daf0eadbaad8599">setParameterValue</a>(uint32_t index, <span class="keywordtype">float</span> value)<span class="keyword"> override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="comment">// same as before, ignore index check</span></div>
<div class="line"></div>
<div class="line">       fGain = value;</div>
<div class="line">   }</div>
<div class="line"></div>
<div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
<div class="line"><span class="comment">   * Audio/MIDI Processing */</span></div>
<div class="line"></div>
<div class="line">   <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>**, <span class="keywordtype">float</span>** outputs, uint32_t frames)<span class="keyword"> override</span></div>
<div class="line"><span class="keyword">   </span>{</div>
<div class="line">       <span class="comment">// get the mono input and output</span></div>
<div class="line">       <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> in  = inputs[0];</div>
<div class="line">       <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> out = outputs[0];</div>
<div class="line"></div>
<div class="line">       <span class="comment">// apply gain against all samples</span></div>
<div class="line">       <span class="keywordflow">for</span> (uint32_t i=0; i &lt; frames; ++i)</div>
<div class="line">           out[i] = in[i] * fGain;</div>
<div class="line">   }</div>
<div class="line">};</div>
</div><!-- fragment --><p>See the <a class="el" href="structParameter.html">Parameter</a> struct for more information about parameters.</p>
<h1><a class="anchor" id="Programs"></a>
Programs</h1>
<p>describe them</p>
<h1><a class="anchor" id="States"></a>
States</h1>
<p>describe them</p>
<h1><a class="anchor" id="MIDI"></a>
MIDI</h1>
<p>describe them</p>
<h1><a class="anchor" id="Latency"></a>
Latency</h1>
<p>describe it</p>
<h1><a class="anchor" id="Time-Position"></a>
Time-Position</h1>
<p>describe it</p>
<h1><a class="anchor" id="UI"></a>
UI</h1>
<p>describe them </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Apr 26 2015 15:47:57 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>