DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
388 Commits
7 Branches
55MB
Tree: e3626bbcdf
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e3626bbcdf'
${ noResults }
DPF/index.html

121 lines
36KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.13"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: DISTRHO Plugin Framework</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">DISTRHO Plugin Framework

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.8.13 -->

  33. <script type="text/javascript">

  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  35. </script>

  36. <script type="text/javascript" src="menudata.js"></script>

  37. <script type="text/javascript" src="menu.js"></script>

  38. <script type="text/javascript">

  39. $(function() {

  40.   initMenu('',true,false,'search.php','Search');

  41.   $(document).ready(function() { init_search(); });

  42. });

  43. </script>

  44. <div id="main-nav"></div>

  45. </div><!-- top -->

  46. <!-- window showing the filter options -->

  47. <div id="MSearchSelectWindow"

  48.      onmouseover="return searchBox.OnSearchSelectShow()"

  49.      onmouseout="return searchBox.OnSearchSelectHide()"

  50.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  51. </div>

  52. 

  53. <!-- iframe showing the search results (closed by default) -->

  54. <div id="MSearchResultsWindow">

  55. <iframe src="javascript:void(0)" frameborder="0" 

  56.         name="MSearchResults" id="MSearchResults">

  57. </iframe>

  58. </div>

  59. 

  60. <div class="header">

  61.   <div class="headertitle">

  62. <div class="title">DISTRHO Plugin Framework </div>  </div>

  63. </div><!--header-->

  64. <div class="contents">

  65. <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 />

  66. It allows developers to create plugins with custom UIs using a simple C++ API.<br />

  67. The framework facilitates exporting various different plugin formats from the same code-base.</p>

  68. <p>DPF can build for LADSPA, DSSI, LV2 and VST2 formats.<br />

  69. A JACK/Standalone mode is also available, allowing you to quickly test plugins.</p>

  70. <h1><a class="anchor" id="Macros"></a>

  71. Macros</h1>

  72. <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 />

  73. This file is included in the main DPF code to select which features to activate for each plugin format.</p>

  74. <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 />

  75. If your plugin does not make use of states, the Worker extension is not set as a required feature.</p>

  76. <h1><a class="anchor" id="Plugin"></a>

  77. Plugin</h1>

  78. <p>The next step is to create your plugin code by subclassing DPF's <a class="el" href="classPlugin.html">Plugin</a> class.<br />

  79. You need to pass the number of parameters in the constructor and also the number of programs and states, if any.</p>

  80. <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">   */</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> d_version(1, 0, 0);</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> d_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>

  81. <h1><a class="anchor" id="Parameters"></a>

  82. Parameters</h1>

  83. <p>A plugin is nothing without parameters.<br />

  84. In DPF parameters can be inputs or outputs.<br />

  85. They have hints to describe how they behave plus a name and a symbol identifying them.<br />

  86. Parameters also have 'ranges' – a minimum, maximum and default value.</p>

  87. <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 />

  88. It's the host responsibility to save, restore and set input parameters.</p>

  89. <p>Output parameters can be changed at anytime by the plugin.<br />

  90. The host will simply read their values and not change them.</p>

  91. <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;Gain&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> d_version(1, 0, 0);</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> d_cconst(<span class="charliteral">&#39;G&#39;</span>, <span class="charliteral">&#39;a&#39;</span>, <span class="charliteral">&#39;i&#39;</span>, <span class="charliteral">&#39;n&#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">       parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a> = 0.0f;</div><div class="line">       parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a> = 2.0f;</div><div class="line">       parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a> = 1.0f;</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 class="line"><span class="keyword">private</span>:</div><div class="line">   <span class="keywordtype">float</span> fGain;</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>

  92. <h1><a class="anchor" id="Programs"></a>

  93. Programs</h1>

  94. <p>Programs in DPF refer to plugin-side presets (usually called "factory presets"), an initial set of presets provided by plugin authors included in the actual plugin.</p>

  95. <p>To use programs you must first enable them by setting <a class="el" href="group__PluginMacros.html#gad95e24b17f196260cee15255fdb5b677">DISTRHO_PLUGIN_WANT_PROGRAMS</a> to 1 in your DistrhoPluginInfo.h file.<br />

  96. When enabled you'll need to override 2 new function in your plugin code, <a class="el" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">Plugin::initProgramName(uint32_t, String&amp;)</a> and <a class="el" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">Plugin::loadProgram(uint32_t)</a>.</p>

  97. <p>Here's an example of a plugin with a "default" program: </p><div class="fragment"><div class="line"><span class="keyword">class </span>PluginWithPresets : <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>:</div><div class="line">   PluginWithPresets()</div><div class="line">       : <a class="code" href="classPlugin.html">Plugin</a>(2, 1, 0), <span class="comment">// 2 parameters, 1 program and 0 states</span></div><div class="line">         fGainL(1.0f),</div><div class="line">         fGainR(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;Prog&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> d_version(1, 0, 0);</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> d_cconst(<span class="charliteral">&#39;P&#39;</span>, <span class="charliteral">&#39;r&#39;</span>, <span class="charliteral">&#39;o&#39;</span>, <span class="charliteral">&#39;g&#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">       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#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a> = 0.0f;</div><div class="line">       parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a> = 2.0f;</div><div class="line">       parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a> = 1.0f;</div><div class="line"></div><div class="line">       <span class="keywordflow">switch</span> (index)</div><div class="line">       {</div><div class="line">       <span class="keywordflow">case</span> 0;</div><div class="line">           parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>   = <span class="stringliteral">&quot;Gain Right&quot;</span>;</div><div class="line">           parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a> = <span class="stringliteral">&quot;gainR&quot;</span>;</div><div class="line">           <span class="keywordflow">break</span>;</div><div class="line">       <span class="keywordflow">case</span> 1;</div><div class="line">           parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>   = <span class="stringliteral">&quot;Gain Left&quot;</span>;</div><div class="line">           parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a> = <span class="stringliteral">&quot;gainL&quot;</span>;</div><div class="line">           <span class="keywordflow">break</span>;</div><div class="line">       }</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">       Set the name of the program @a index.</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#a54d66af3111541b7c118f9749ef0231b">initProgramName</a>(uint32_t index, <a class="code" href="classString.html">String</a>&amp; programName)</div><div class="line">   {</div><div class="line">       <span class="keywordflow">switch</span>(index)</div><div class="line">       {</div><div class="line">       <span class="keywordflow">case</span> 0:</div><div class="line">           programName = <span class="stringliteral">&quot;Default&quot;</span>;</div><div class="line">           <span class="keywordflow">break</span>;</div><div class="line">       }</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="keywordflow">switch</span> (index)</div><div class="line">       {</div><div class="line">       <span class="keywordflow">case</span> 0;</div><div class="line">           <span class="keywordflow">return</span> fGainL;</div><div class="line">       <span class="keywordflow">case</span> 1;</div><div class="line">           <span class="keywordflow">return</span> fGainR;</div><div class="line">       }</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="keywordflow">switch</span> (index)</div><div class="line">       {</div><div class="line">       <span class="keywordflow">case</span> 0;</div><div class="line">           fGainL = value;</div><div class="line">           <span class="keywordflow">break</span>;</div><div class="line">       <span class="keywordflow">case</span> 1;</div><div class="line">           fGainR = value;</div><div class="line">           <span class="keywordflow">break</span>;</div><div class="line">       }</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">     Load a program.</span></div><div class="line"><span class="comment">   */</span></div><div class="line">   <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">loadProgram</a>(uint32_t index)</div><div class="line">   {</div><div class="line">       <span class="keywordflow">switch</span>(index)</div><div class="line">       {</div><div class="line">       <span class="keywordflow">case</span> 0:</div><div class="line">           fGainL = 1.0f;</div><div class="line">           fGainR = 1.0f;</div><div class="line">           <span class="keywordflow">break</span>;</div><div class="line">       }</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 left and right audio buffers</span></div><div class="line">       <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> inL  = inputs[0];</div><div class="line">       <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> inR  = inputs[0];</div><div class="line">       <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> outL = outputs[0];</div><div class="line">       <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> outR = 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">       {</div><div class="line">           outL[i] = inL[i] * fGainL;</div><div class="line">           outR[i] = inR[i] * fGainR;</div><div class="line">       }</div><div class="line">   }</div><div class="line"></div><div class="line"><span class="keyword">private</span>:</div><div class="line">   <span class="keywordtype">float</span> fGainL, fGainR;</div><div class="line">};</div></div><!-- fragment --><h1><a class="anchor" id="States"></a>

  98. States</h1>

  99. <p>describe them</p>

  100. <h1><a class="anchor" id="MIDI"></a>

  101. MIDI</h1>

  102. <p>describe them</p>

  103. <h1><a class="anchor" id="Latency"></a>

  104. Latency</h1>

  105. <p>describe it</p>

  106. <h1><a class="anchor" id="Time-Position"></a>

  107. Time-Position</h1>

  108. <p>describe it</p>

  109. <h1><a class="anchor" id="UI"></a>

  110. UI</h1>

  111. <p>describe them </p>

  112. </div></div><!-- contents -->

  113. <!-- start footer part -->

  114. <hr class="footer"/><address class="footer"><small>

  115. Generated on Mon Aug 13 2018 06:29:25 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  116. <img class="footer" src="doxygen.png" alt="doxygen"/>

  117. </a> 1.8.13

  118. </small></address>

  119. </body>

  120. </html>