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.
398 Commits
7 Branches
59MB
Tree: e82edc537a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e82edc537a'
${ noResults }
DPF/index.html

467 lines
42KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>

  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.17 -->

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

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

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

  36. /* @license-end */

  37. </script>

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

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

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

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

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

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

  45. });

  46. /* @license-end */</script>

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

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

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

  50. <div id="MSearchSelectWindow"

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

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

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

  54. </div>

  55. 

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

  57. <div id="MSearchResultsWindow">

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

  59.         name="MSearchResults" id="MSearchResults">

  60. </iframe>

  61. </div>

  62. 

  63. <div class="PageDoc"><div class="header">

  64.   <div class="headertitle">

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

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

  67. <div class="contents">

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

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

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

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

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

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

  74. Macros</h1>

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

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

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

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

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

  80. Plugin</h1>

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

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

  83. <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>

  84. <div class="line">{</div>

  85. <div class="line"><span class="keyword">public</span>:<span class="comment"></span></div>

  86. <div class="line"><span class="comment">  /**</span></div>

  87. <div class="line"><span class="comment">     Plugin class constructor.</span></div>

  88. <div class="line"><span class="comment">   */</span></div>

  89. <div class="line">   MutePlugin()</div>

  90. <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>

  91. <div class="line">   {</div>

  92. <div class="line">   }</div>

  93. <div class="line"> </div>

  94. <div class="line"><span class="keyword">protected</span>:</div>

  95. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  96. <div class="line"><span class="comment">   * Information */</span></div>

  97. <div class="line"><span class="comment"></span> </div>

  98. <div class="line"><span class="comment">  /**</span></div>

  99. <div class="line"><span class="comment">     Get the plugin label.</span></div>

  100. <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>

  101. <div class="line"><span class="comment">   */</span></div>

  102. <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>

  103. <div class="line"><span class="keyword">   </span>{</div>

  104. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;Mute&quot;</span>;</div>

  105. <div class="line">   }</div>

  106. <div class="line"><span class="comment"></span> </div>

  107. <div class="line"><span class="comment">  /**</span></div>

  108. <div class="line"><span class="comment">     Get the plugin author/maker.</span></div>

  109. <div class="line"><span class="comment">   */</span></div>

  110. <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>

  111. <div class="line"><span class="keyword">   </span>{</div>

  112. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>

  113. <div class="line">   }</div>

  114. <div class="line"><span class="comment"></span> </div>

  115. <div class="line"><span class="comment">  /**</span></div>

  116. <div class="line"><span class="comment">     Get the plugin license name (a single line of text).</span></div>

  117. <div class="line"><span class="comment">     For commercial plugins this should return some short copyright information.</span></div>

  118. <div class="line"><span class="comment">   */</span></div>

  119. <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>

  120. <div class="line"><span class="keyword">   </span>{</div>

  121. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>

  122. <div class="line">   }</div>

  123. <div class="line"><span class="comment"></span> </div>

  124. <div class="line"><span class="comment">  /**</span></div>

  125. <div class="line"><span class="comment">     Get the plugin version, in hexadecimal.</span></div>

  126. <div class="line"><span class="comment">   */</span></div>

  127. <div class="line">   uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>()<span class="keyword"> const override</span></div>

  128. <div class="line"><span class="keyword">   </span>{</div>

  129. <div class="line">       <span class="keywordflow">return</span> d_version(1, 0, 0);</div>

  130. <div class="line">   }</div>

  131. <div class="line"><span class="comment"></span> </div>

  132. <div class="line"><span class="comment">  /**</span></div>

  133. <div class="line"><span class="comment">     Get the plugin unique Id.</span></div>

  134. <div class="line"><span class="comment">     This value is used by LADSPA, DSSI and VST plugin formats.</span></div>

  135. <div class="line"><span class="comment">   */</span></div>

  136. <div class="line">   int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>()<span class="keyword"> const override</span></div>

  137. <div class="line"><span class="keyword">   </span>{</div>

  138. <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>

  139. <div class="line">   }</div>

  140. <div class="line"> </div>

  141. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  142. <div class="line"><span class="comment">   * This example has no parameters, so skip parameter stuff */</span></div>

  143. <div class="line"> </div>

  144. <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>

  145. <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>

  146. <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>

  147. <div class="line"> </div>

  148. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  149. <div class="line"><span class="comment">   * Audio/MIDI Processing */</span></div>

  150. <div class="line"><span class="comment"></span> </div>

  151. <div class="line"><span class="comment">  /**</span></div>

  152. <div class="line"><span class="comment">     Run/process function for plugins without MIDI input.</span></div>

  153. <div class="line"><span class="comment">     NOTE: Some parameters might be null if there are no audio inputs or outputs.</span></div>

  154. <div class="line"><span class="comment">   */</span></div>

  155. <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>

  156. <div class="line"><span class="keyword">   </span>{</div>

  157. <div class="line">       <span class="comment">// get the left and right audio outputs</span></div>

  158. <div class="line">       <span class="keywordtype">float</span>* <span class="keyword">const</span> outL = outputs[0];</div>

  159. <div class="line">       <span class="keywordtype">float</span>* <span class="keyword">const</span> outR = outputs[1];</div>

  160. <div class="line"> </div>

  161. <div class="line">       <span class="comment">// mute audio</span></div>

  162. <div class="line">       std::memset(outL, 0, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)*frames);</div>

  163. <div class="line">       std::memset(outR, 0, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)*frames);</div>

  164. <div class="line">   }</div>

  165. <div class="line"> </div>

  166. <div class="line">};</div>

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

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

  169. Parameters</h1>

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

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

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

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

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

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

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

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

  178. <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>

  179. <div class="line">{</div>

  180. <div class="line"><span class="keyword">public</span>:<span class="comment"></span></div>

  181. <div class="line"><span class="comment">  /**</span></div>

  182. <div class="line"><span class="comment">     Plugin class constructor.</span></div>

  183. <div class="line"><span class="comment">     You must set all parameter values to their defaults, matching ParameterRanges::def.</span></div>

  184. <div class="line"><span class="comment">   */</span></div>

  185. <div class="line">   GainPlugin()</div>

  186. <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>

  187. <div class="line">         fGain(1.0f)</div>

  188. <div class="line">   {</div>

  189. <div class="line">   }</div>

  190. <div class="line"> </div>

  191. <div class="line"><span class="keyword">protected</span>:</div>

  192. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  193. <div class="line"><span class="comment">   * Information */</span></div>

  194. <div class="line"> </div>

  195. <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>

  196. <div class="line"><span class="keyword">   </span>{</div>

  197. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;Gain&quot;</span>;</div>

  198. <div class="line">   }</div>

  199. <div class="line"> </div>

  200. <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>

  201. <div class="line"><span class="keyword">   </span>{</div>

  202. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>

  203. <div class="line">   }</div>

  204. <div class="line"> </div>

  205. <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>

  206. <div class="line"><span class="keyword">   </span>{</div>

  207. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>

  208. <div class="line">   }</div>

  209. <div class="line"> </div>

  210. <div class="line">   uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>()<span class="keyword"> const override</span></div>

  211. <div class="line"><span class="keyword">   </span>{</div>

  212. <div class="line">       <span class="keywordflow">return</span> d_version(1, 0, 0);</div>

  213. <div class="line">   }</div>

  214. <div class="line"> </div>

  215. <div class="line">   int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>()<span class="keyword"> const override</span></div>

  216. <div class="line"><span class="keyword">   </span>{</div>

  217. <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>

  218. <div class="line">   }</div>

  219. <div class="line"> </div>

  220. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  221. <div class="line"><span class="comment">   * Init */</span></div>

  222. <div class="line"><span class="comment"></span> </div>

  223. <div class="line"><span class="comment">  /**</span></div>

  224. <div class="line"><span class="comment">     Initialize a parameter.</span></div>

  225. <div class="line"><span class="comment">     This function will be called once, shortly after the plugin is created.</span></div>

  226. <div class="line"><span class="comment">   */</span></div>

  227. <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>

  228. <div class="line"><span class="keyword">   </span>{</div>

  229. <div class="line">       <span class="comment">// we only have one parameter so we can skip checking the index</span></div>

  230. <div class="line"> </div>

  231. <div class="line">       parameter.<a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a>      = <a class="code" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a>;</div>

  232. <div class="line">       parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>       = <span class="stringliteral">&quot;Gain&quot;</span>;</div>

  233. <div class="line">       parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a>     = <span class="stringliteral">&quot;gain&quot;</span>;</div>

  234. <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>

  235. <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>

  236. <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>

  237. <div class="line">   }</div>

  238. <div class="line"> </div>

  239. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  240. <div class="line"><span class="comment">   * Internal data */</span></div>

  241. <div class="line"><span class="comment"></span> </div>

  242. <div class="line"><span class="comment">  /**</span></div>

  243. <div class="line"><span class="comment">     Get the current value of a parameter.</span></div>

  244. <div class="line"><span class="comment">   */</span></div>

  245. <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>

  246. <div class="line"><span class="keyword">   </span>{</div>

  247. <div class="line">       <span class="comment">// same as before, ignore index check</span></div>

  248. <div class="line"> </div>

  249. <div class="line">       <span class="keywordflow">return</span> fGain;</div>

  250. <div class="line">   }</div>

  251. <div class="line"><span class="comment"></span> </div>

  252. <div class="line"><span class="comment">  /**</span></div>

  253. <div class="line"><span class="comment">     Change a parameter value.</span></div>

  254. <div class="line"><span class="comment">   */</span></div>

  255. <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>

  256. <div class="line"><span class="keyword">   </span>{</div>

  257. <div class="line">       <span class="comment">// same as before, ignore index check</span></div>

  258. <div class="line"> </div>

  259. <div class="line">       fGain = value;</div>

  260. <div class="line">   }</div>

  261. <div class="line"> </div>

  262. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  263. <div class="line"><span class="comment">   * Audio/MIDI Processing */</span></div>

  264. <div class="line"> </div>

  265. <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>

  266. <div class="line"><span class="keyword">   </span>{</div>

  267. <div class="line">       <span class="comment">// get the mono input and output</span></div>

  268. <div class="line">       <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> in  = inputs[0];</div>

  269. <div class="line">       <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> out = outputs[0];</div>

  270. <div class="line"> </div>

  271. <div class="line">       <span class="comment">// apply gain against all samples</span></div>

  272. <div class="line">       <span class="keywordflow">for</span> (uint32_t i=0; i &lt; frames; ++i)</div>

  273. <div class="line">           out[i] = in[i] * fGain;</div>

  274. <div class="line">   }</div>

  275. <div class="line"> </div>

  276. <div class="line"><span class="keyword">private</span>:</div>

  277. <div class="line">   <span class="keywordtype">float</span> fGain;</div>

  278. <div class="line">};</div>

  279. </div><!-- fragment --><p>See the <a class="el" href="structParameter.html">Parameter</a> struct for more information about parameters.</p>

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

  281. Programs</h1>

  282. <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>

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

  284. 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>

  285. <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>

  286. <div class="line">{</div>

  287. <div class="line"><span class="keyword">public</span>:</div>

  288. <div class="line">   PluginWithPresets()</div>

  289. <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>

  290. <div class="line">         fGainL(1.0f),</div>

  291. <div class="line">         fGainR(1.0f),</div>

  292. <div class="line">   {</div>

  293. <div class="line">   }</div>

  294. <div class="line"> </div>

  295. <div class="line"><span class="keyword">protected</span>:</div>

  296. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  297. <div class="line"><span class="comment">   * Information */</span></div>

  298. <div class="line"> </div>

  299. <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>

  300. <div class="line"><span class="keyword">   </span>{</div>

  301. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;Prog&quot;</span>;</div>

  302. <div class="line">   }</div>

  303. <div class="line"> </div>

  304. <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>

  305. <div class="line"><span class="keyword">   </span>{</div>

  306. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>

  307. <div class="line">   }</div>

  308. <div class="line"> </div>

  309. <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>

  310. <div class="line"><span class="keyword">   </span>{</div>

  311. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>

  312. <div class="line">   }</div>

  313. <div class="line"> </div>

  314. <div class="line">   uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>()<span class="keyword"> const override</span></div>

  315. <div class="line"><span class="keyword">   </span>{</div>

  316. <div class="line">       <span class="keywordflow">return</span> d_version(1, 0, 0);</div>

  317. <div class="line">   }</div>

  318. <div class="line"> </div>

  319. <div class="line">   int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>()<span class="keyword"> const override</span></div>

  320. <div class="line"><span class="keyword">   </span>{</div>

  321. <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>

  322. <div class="line">   }</div>

  323. <div class="line"> </div>

  324. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  325. <div class="line"><span class="comment">   * Init */</span></div>

  326. <div class="line"><span class="comment"></span> </div>

  327. <div class="line"><span class="comment">  /**</span></div>

  328. <div class="line"><span class="comment">     Initialize a parameter.</span></div>

  329. <div class="line"><span class="comment">     This function will be called once, shortly after the plugin is created.</span></div>

  330. <div class="line"><span class="comment">   */</span></div>

  331. <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>

  332. <div class="line"><span class="keyword">   </span>{</div>

  333. <div class="line">       parameter.<a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a>      = <a class="code" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a>;</div>

  334. <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>

  335. <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>

  336. <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>

  337. <div class="line"> </div>

  338. <div class="line">       <span class="keywordflow">switch</span> (index)</div>

  339. <div class="line">       {</div>

  340. <div class="line">       <span class="keywordflow">case</span> 0;</div>

  341. <div class="line">           parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>   = <span class="stringliteral">&quot;Gain Right&quot;</span>;</div>

  342. <div class="line">           parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a> = <span class="stringliteral">&quot;gainR&quot;</span>;</div>

  343. <div class="line">           <span class="keywordflow">break</span>;</div>

  344. <div class="line">       <span class="keywordflow">case</span> 1;</div>

  345. <div class="line">           parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>   = <span class="stringliteral">&quot;Gain Left&quot;</span>;</div>

  346. <div class="line">           parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a> = <span class="stringliteral">&quot;gainL&quot;</span>;</div>

  347. <div class="line">           <span class="keywordflow">break</span>;</div>

  348. <div class="line">       }</div>

  349. <div class="line">   }</div>

  350. <div class="line"><span class="comment"></span> </div>

  351. <div class="line"><span class="comment">   /**</span></div>

  352. <div class="line"><span class="comment">       Set the name of the program @a index.</span></div>

  353. <div class="line"><span class="comment">       This function will be called once, shortly after the plugin is created.</span></div>

  354. <div class="line"><span class="comment">     */</span></div>

  355. <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>

  356. <div class="line">   {</div>

  357. <div class="line">       <span class="keywordflow">switch</span>(index)</div>

  358. <div class="line">       {</div>

  359. <div class="line">       <span class="keywordflow">case</span> 0:</div>

  360. <div class="line">           programName = <span class="stringliteral">&quot;Default&quot;</span>;</div>

  361. <div class="line">           <span class="keywordflow">break</span>;</div>

  362. <div class="line">       }</div>

  363. <div class="line">   }</div>

  364. <div class="line"> </div>

  365. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  366. <div class="line"><span class="comment">   * Internal data */</span></div>

  367. <div class="line"><span class="comment"></span> </div>

  368. <div class="line"><span class="comment">  /**</span></div>

  369. <div class="line"><span class="comment">     Get the current value of a parameter.</span></div>

  370. <div class="line"><span class="comment">   */</span></div>

  371. <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>

  372. <div class="line"><span class="keyword">   </span>{</div>

  373. <div class="line">       <span class="keywordflow">switch</span> (index)</div>

  374. <div class="line">       {</div>

  375. <div class="line">       <span class="keywordflow">case</span> 0;</div>

  376. <div class="line">           <span class="keywordflow">return</span> fGainL;</div>

  377. <div class="line">       <span class="keywordflow">case</span> 1;</div>

  378. <div class="line">           <span class="keywordflow">return</span> fGainR;</div>

  379. <div class="line">       }</div>

  380. <div class="line">   }</div>

  381. <div class="line"><span class="comment"></span> </div>

  382. <div class="line"><span class="comment">  /**</span></div>

  383. <div class="line"><span class="comment">     Change a parameter value.</span></div>

  384. <div class="line"><span class="comment">   */</span></div>

  385. <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>

  386. <div class="line"><span class="keyword">   </span>{</div>

  387. <div class="line">       <span class="keywordflow">switch</span> (index)</div>

  388. <div class="line">       {</div>

  389. <div class="line">       <span class="keywordflow">case</span> 0;</div>

  390. <div class="line">           fGainL = value;</div>

  391. <div class="line">           <span class="keywordflow">break</span>;</div>

  392. <div class="line">       <span class="keywordflow">case</span> 1;</div>

  393. <div class="line">           fGainR = value;</div>

  394. <div class="line">           <span class="keywordflow">break</span>;</div>

  395. <div class="line">       }</div>

  396. <div class="line">   }</div>

  397. <div class="line"><span class="comment"></span> </div>

  398. <div class="line"><span class="comment">  /**</span></div>

  399. <div class="line"><span class="comment">     Load a program.</span></div>

  400. <div class="line"><span class="comment">   */</span></div>

  401. <div class="line">   <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">loadProgram</a>(uint32_t index)</div>

  402. <div class="line">   {</div>

  403. <div class="line">       <span class="keywordflow">switch</span>(index)</div>

  404. <div class="line">       {</div>

  405. <div class="line">       <span class="keywordflow">case</span> 0:</div>

  406. <div class="line">           fGainL = 1.0f;</div>

  407. <div class="line">           fGainR = 1.0f;</div>

  408. <div class="line">           <span class="keywordflow">break</span>;</div>

  409. <div class="line">       }</div>

  410. <div class="line">   }</div>

  411. <div class="line"> </div>

  412. <div class="line">  <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>

  413. <div class="line"><span class="comment">   * Audio/MIDI Processing */</span></div>

  414. <div class="line"> </div>

  415. <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>

  416. <div class="line"><span class="keyword">   </span>{</div>

  417. <div class="line">       <span class="comment">// get the left and right audio buffers</span></div>

  418. <div class="line">       <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> inL  = inputs[0];</div>

  419. <div class="line">       <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> inR  = inputs[0];</div>

  420. <div class="line">       <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> outL = outputs[0];</div>

  421. <div class="line">       <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> outR = outputs[0];</div>

  422. <div class="line"> </div>

  423. <div class="line">       <span class="comment">// apply gain against all samples</span></div>

  424. <div class="line">       <span class="keywordflow">for</span> (uint32_t i=0; i &lt; frames; ++i)</div>

  425. <div class="line">       {</div>

  426. <div class="line">           outL[i] = inL[i] * fGainL;</div>

  427. <div class="line">           outR[i] = inR[i] * fGainR;</div>

  428. <div class="line">       }</div>

  429. <div class="line">   }</div>

  430. <div class="line"> </div>

  431. <div class="line"><span class="keyword">private</span>:</div>

  432. <div class="line">   <span class="keywordtype">float</span> fGainL, fGainR;</div>

  433. <div class="line">};</div>

  434. </div><!-- fragment --><p>This is a work-in-progress documentation page. States, MIDI, Latency, Time-Position and <a class="el" href="classUI.html">UI</a> are still TODO. </p>

  435. </div></div><!-- PageDoc -->

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

  437. <div class="ttc" id="aclassPlugin_html_abae540dd93caf4834270358a8aad334a"><div class="ttname"><a href="classPlugin.html#abae540dd93caf4834270358a8aad334a">Plugin::getVersion</a></div><div class="ttdeci">virtual uint32_t getVersion() const =0</div></div>

  438. <div class="ttc" id="aclassString_html"><div class="ttname"><a href="classString.html">String</a></div><div class="ttdef"><b>Definition:</b> String.hpp:30</div></div>

  439. <div class="ttc" id="aclassPlugin_html_a2d1da98c90568bb4547662bc4f02c31f"><div class="ttname"><a href="classPlugin.html#a2d1da98c90568bb4547662bc4f02c31f">Plugin::getParameterValue</a></div><div class="ttdeci">virtual float getParameterValue(uint32_t index) const =0</div></div>

  440. <div class="ttc" id="astructParameter_html_a2d0c81e4fb8fad18d920ef6ecd4a64db"><div class="ttname"><a href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">Parameter::ranges</a></div><div class="ttdeci">ParameterRanges ranges</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:491</div></div>

  441. <div class="ttc" id="astructParameter_html"><div class="ttname"><a href="structParameter.html">Parameter</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:445</div></div>

  442. <div class="ttc" id="aclassPlugin_html_a955832840de786a7a22798f0ef451c5d"><div class="ttname"><a href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">Plugin::getMaker</a></div><div class="ttdeci">virtual const char * getMaker() const =0</div></div>

  443. <div class="ttc" id="aclassPlugin_html_ab629f35c60406d6f2c0b9d530e67cf09"><div class="ttname"><a href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">Plugin::loadProgram</a></div><div class="ttdeci">virtual void loadProgram(uint32_t index)=0</div></div>

  444. <div class="ttc" id="aclassPlugin_html_a54d66af3111541b7c118f9749ef0231b"><div class="ttname"><a href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">Plugin::initProgramName</a></div><div class="ttdeci">virtual void initProgramName(uint32_t index, String &amp;programName)=0</div></div>

  445. <div class="ttc" id="aclassPlugin_html_a00f7945c16149db6845fbcc2af729f4f"><div class="ttname"><a href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">Plugin::getLabel</a></div><div class="ttdeci">virtual const char * getLabel() const =0</div></div>

  446. <div class="ttc" id="astructParameterRanges_html_aa0aba68115bcfff25c35b2da2f7aed4c"><div class="ttname"><a href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">ParameterRanges::def</a></div><div class="ttdeci">float def</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:249</div></div>

  447. <div class="ttc" id="astructParameter_html_ae63c1fcfb20e320bada1f58c04ff18da"><div class="ttname"><a href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">Parameter::name</a></div><div class="ttdeci">String name</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:457</div></div>

  448. <div class="ttc" id="aclassPlugin_html_a5b0ec59527a1c2f4b01f17fc8c18ea8b"><div class="ttname"><a href="classPlugin.html#a5b0ec59527a1c2f4b01f17fc8c18ea8b">Plugin::initParameter</a></div><div class="ttdeci">virtual void initParameter(uint32_t index, Parameter &amp;parameter)=0</div></div>

  449. <div class="ttc" id="astructParameter_html_a3e546efd8dbd0d77351208b670719468"><div class="ttname"><a href="structParameter.html#a3e546efd8dbd0d77351208b670719468">Parameter::symbol</a></div><div class="ttdeci">String symbol</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:472</div></div>

  450. <div class="ttc" id="aclassPlugin_html_a686a3c92a376a185d6fd97efd59125d1"><div class="ttname"><a href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">Plugin::getLicense</a></div><div class="ttdeci">virtual const char * getLicense() const =0</div></div>

  451. <div class="ttc" id="aclassPlugin_html_ad6ff8c80227d5ceebd40b96f3be29a66"><div class="ttname"><a href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">Plugin::getUniqueId</a></div><div class="ttdeci">virtual int64_t getUniqueId() const =0</div></div>

  452. <div class="ttc" id="aclassPlugin_html"><div class="ttname"><a href="classPlugin.html">Plugin</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:802</div></div>

  453. <div class="ttc" id="aclassPlugin_html_a0a969c78f8455ac6ba65fa42e8c498f6"><div class="ttname"><a href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">Plugin::run</a></div><div class="ttdeci">virtual void run(const float **inputs, float **outputs, uint32_t frames, const MidiEvent *midiEvents, uint32_t midiEventCount)=0</div></div>

  454. <div class="ttc" id="aclassPlugin_html_a6911a881fabb9eca9daf0eadbaad8599"><div class="ttname"><a href="classPlugin.html#a6911a881fabb9eca9daf0eadbaad8599">Plugin::setParameterValue</a></div><div class="ttdeci">virtual void setParameterValue(uint32_t index, float value)=0</div></div>

  455. <div class="ttc" id="agroup__ParameterHints_html_ga04161ef926442aa08ae7aa6847078ad9"><div class="ttname"><a href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a></div><div class="ttdeci">static const uint32_t kParameterIsAutomable</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:90</div></div>

  456. <div class="ttc" id="astructParameterRanges_html_a175c78c905c598df929a4450e4d2a2a0"><div class="ttname"><a href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">ParameterRanges::max</a></div><div class="ttdeci">float max</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:259</div></div>

  457. <div class="ttc" id="astructParameterRanges_html_a63c40988463a8ace9d0e9e55a00f3c7b"><div class="ttname"><a href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">ParameterRanges::min</a></div><div class="ttdeci">float min</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:254</div></div>

  458. <div class="ttc" id="astructParameter_html_a397fb977f0c6cbec31df4f141ca3f5b3"><div class="ttname"><a href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">Parameter::hints</a></div><div class="ttdeci">uint32_t hints</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:450</div></div>

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

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

  461. Generated on Mon Jun 14 2021 12:30:38 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  463. </a> 1.8.17

  464. </small></address>

  465. </body>

  466. </html>