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.

717 lines
97KB

  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/DistrhoInfo.hpp Source File</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. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="headertitle">
  67. <div class="title">DistrhoInfo.hpp</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  71. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
  72. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright (C) 2012-2019 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>
  73. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  74. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
  75. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
  76. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>
  77. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  78. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
  79. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
  80. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
  81. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
  82. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
  83. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
  84. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div>
  85. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
  86. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifdef DOXYGEN</span></div>
  87. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
  88. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;src/DistrhoDefines.h&quot;</span></div>
  89. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
  90. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;START_NAMESPACE_DISTRHO</div>
  91. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
  92. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>
  93. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * Intro */</span></div>
  94. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"></span> </div>
  95. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">/**</span></div>
  96. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> @mainpage DISTRHO %Plugin Framework</span></div>
  97. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"></span> </div>
  98. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> DISTRHO %Plugin Framework (or @b DPF for short)</span></div>
  99. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> is a plugin framework designed to make development of new plugins an easy and enjoyable task.@n</span></div>
  100. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> It allows developers to create plugins with custom UIs using a simple C++ API.@n</span></div>
  101. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> The framework facilitates exporting various different plugin formats from the same code-base.</span></div>
  102. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"></span> </div>
  103. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> DPF can build for LADSPA, DSSI, LV2 and VST2 formats.@n</span></div>
  104. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"> A JACK/Standalone mode is also available, allowing you to quickly test plugins.</span></div>
  105. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span> </div>
  106. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> @section Macros</span></div>
  107. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"> You start by creating a &quot;DistrhoPluginInfo.h&quot; file describing the plugin via macros, see @ref PluginMacros.@n</span></div>
  108. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> This file is included in the main DPF code to select which features to activate for each plugin format.</span></div>
  109. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"></span> </div>
  110. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"> For example, a plugin (with %UI) that use states will require LV2 hosts to support Atom and Worker extensions for</span></div>
  111. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> message passing from the %UI to the plugin.@n</span></div>
  112. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"> If your plugin does not make use of states, the Worker extension is not set as a required feature.</span></div>
  113. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"></span> </div>
  114. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> @section Plugin</span></div>
  115. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> The next step is to create your plugin code by subclassing DPF&#39;s Plugin class.@n</span></div>
  116. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> You need to pass the number of parameters in the constructor and also the number of programs and states, if any.</span></div>
  117. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"></span> </div>
  118. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> Here&#39;s an example of an audio plugin that simply mutes the host output:</span></div>
  119. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> @code</span></div>
  120. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> class MutePlugin : public Plugin</span></div>
  121. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> {</span></div>
  122. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> public:</span><span class="comment"></span></div>
  123. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> /**</span></div>
  124. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"> Plugin class constructor.</span></div>
  125. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> */</span></div>
  126. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; MutePlugin()</div>
  127. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; : <a class="code" href="classPlugin.html">Plugin</a>(0, 0, 0) <span class="comment">// 0 parameters, 0 programs and 0 states</span></div>
  128. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; {</div>
  129. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div>
  130. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
  131. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">protected</span>:</div>
  132. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  133. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"> * Information */</span></div>
  134. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"></span> </div>
  135. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"> /**</span></div>
  136. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> Get the plugin label.</span></div>
  137. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"> This label is a short restricted name consisting of only _, a-z, A-Z and 0-9 characters.</span></div>
  138. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"> */</span></div>
  139. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getLabel()<span class="keyword"> const override</span></div>
  140. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="keyword"> </span>{</div>
  141. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;Mute&quot;</span>;</div>
  142. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div>
  143. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"></span> </div>
  144. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"> /**</span></div>
  145. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment"> Get the plugin author/maker.</span></div>
  146. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment"> */</span></div>
  147. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getMaker()<span class="keyword"> const override</span></div>
  148. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="keyword"> </span>{</div>
  149. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>
  150. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
  151. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"></span> </div>
  152. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> /**</span></div>
  153. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> Get the plugin license name (a single line of text).</span></div>
  154. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"> For commercial plugins this should return some short copyright information.</span></div>
  155. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> */</span></div>
  156. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getLicense()<span class="keyword"> const override</span></div>
  157. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="keyword"> </span>{</div>
  158. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>
  159. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
  160. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"></span> </div>
  161. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"> /**</span></div>
  162. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment"> Get the plugin version, in hexadecimal.</span></div>
  163. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment"> */</span></div>
  164. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; uint32_t getVersion()<span class="keyword"> const override</span></div>
  165. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="keyword"> </span>{</div>
  166. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> d_version(1, 0, 0);</div>
  167. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; }</div>
  168. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment"></span> </div>
  169. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment"> /**</span></div>
  170. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment"> Get the plugin unique Id.</span></div>
  171. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment"> This value is used by LADSPA, DSSI and VST plugin formats.</span></div>
  172. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment"> */</span></div>
  173. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; int64_t getUniqueId()<span class="keyword"> const override</span></div>
  174. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="keyword"> </span>{</div>
  175. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <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>
  176. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; }</div>
  177. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
  178. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  179. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> * This example has no parameters, so skip parameter stuff */</span></div>
  180. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
  181. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordtype">void</span> initParameter(uint32_t, <a class="code" href="structParameter.html">Parameter</a>&amp;)<span class="keyword"> override </span>{}</div>
  182. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">float</span> getParameterValue(uint32_t)<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> 0.0f; }</div>
  183. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordtype">void</span> setParameterValue(uint32_t, <span class="keywordtype">float</span>)<span class="keyword"> override </span>{}</div>
  184. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
  185. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  186. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment"> * Audio/MIDI Processing */</span></div>
  187. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment"></span> </div>
  188. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment"> /**</span></div>
  189. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment"> Run/process function for plugins without MIDI input.</span></div>
  190. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> NOTE: Some parameters might be null if there are no audio inputs or outputs.</span></div>
  191. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment"> */</span></div>
  192. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">void</span> run(<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>
  193. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;<span class="keyword"> </span>{</div>
  194. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="comment">// get the left and right audio outputs</span></div>
  195. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordtype">float</span>* <span class="keyword">const</span> outL = outputs[0];</div>
  196. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordtype">float</span>* <span class="keyword">const</span> outR = outputs[1];</div>
  197. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
  198. <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="comment">// mute audio</span></div>
  199. <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; std::memset(outL, 0, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)*frames);</div>
  200. <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; std::memset(outR, 0, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)*frames);</div>
  201. <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; }</div>
  202. <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div>
  203. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; };</div>
  204. <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">@end</span>code</div>
  205. <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
  206. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; See the <a class="code" href="classPlugin.html">Plugin</a> <span class="keyword">class </span>for more information and to understand what each function does.</div>
  207. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
  208. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; @section Parameters</div>
  209. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; A plugin is nothing without parameters.@n</div>
  210. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; In DPF parameters can be inputs or outputs.@n</div>
  211. <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; They have hints to describe how they behave plus a name and a symbol identifying them.@n</div>
  212. <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; Parameters also have &#39;ranges&#39; – a minimum, maximum and default value.</div>
  213. <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; </div>
  214. <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; Input parameters are &quot;read-only&quot;: the plugin can read them but not change them.</div>
  215. <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; (the exception being when changing programs, more on that below)@n</div>
  216. <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; It&#39;s the host responsibility to save, restore and set input parameters.</div>
  217. <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
  218. <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; Output parameters can be changed at anytime by the plugin.@n</div>
  219. <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; The host will simply read their values and not change them.</div>
  220. <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; </div>
  221. <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; Here&#39;s an example of an audio plugin that has 1 input parameter:</div>
  222. <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; @code</div>
  223. <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keyword">class </span>GainPlugin : <span class="keyword">public</span> <a class="code" href="classPlugin.html">Plugin</a></div>
  224. <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; {</div>
  225. <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <span class="keyword">public</span>:<span class="comment"></span></div>
  226. <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="comment"> /**</span></div>
  227. <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="comment"> Plugin class constructor.</span></div>
  228. <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="comment"> You must set all parameter values to their defaults, matching ParameterRanges::def.</span></div>
  229. <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="comment"> */</span></div>
  230. <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; GainPlugin()</div>
  231. <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; : <a class="code" href="classPlugin.html">Plugin</a>(1, 0, 0), <span class="comment">// 1 parameter, 0 programs and 0 states</span></div>
  232. <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; fGain(1.0f)</div>
  233. <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; {</div>
  234. <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; }</div>
  235. <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; </div>
  236. <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keyword">protected</span>:</div>
  237. <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  238. <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;<span class="comment"> * Information */</span></div>
  239. <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; </div>
  240. <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getLabel()<span class="keyword"> const override</span></div>
  241. <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="keyword"> </span>{</div>
  242. <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;Gain&quot;</span>;</div>
  243. <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; }</div>
  244. <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; </div>
  245. <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getMaker()<span class="keyword"> const override</span></div>
  246. <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="keyword"> </span>{</div>
  247. <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>
  248. <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; }</div>
  249. <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; </div>
  250. <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getLicense()<span class="keyword"> const override</span></div>
  251. <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;<span class="keyword"> </span>{</div>
  252. <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>
  253. <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; }</div>
  254. <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; </div>
  255. <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; uint32_t getVersion()<span class="keyword"> const override</span></div>
  256. <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;<span class="keyword"> </span>{</div>
  257. <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keywordflow">return</span> d_version(1, 0, 0);</div>
  258. <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; }</div>
  259. <div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; </div>
  260. <div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; int64_t getUniqueId()<span class="keyword"> const override</span></div>
  261. <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;<span class="keyword"> </span>{</div>
  262. <div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <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>
  263. <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; }</div>
  264. <div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; </div>
  265. <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  266. <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;<span class="comment"> * Init */</span></div>
  267. <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;<span class="comment"></span> </div>
  268. <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;<span class="comment"> /**</span></div>
  269. <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;<span class="comment"> Initialize a parameter.</span></div>
  270. <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;<span class="comment"> This function will be called once, shortly after the plugin is created.</span></div>
  271. <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;<span class="comment"> */</span></div>
  272. <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; <span class="keywordtype">void</span> initParameter(uint32_t index, <a class="code" href="structParameter.html">Parameter</a>&amp; parameter)<span class="keyword"> override</span></div>
  273. <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;<span class="keyword"> </span>{</div>
  274. <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <span class="comment">// we only have one parameter so we can skip checking the index</span></div>
  275. <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; </div>
  276. <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; parameter.<a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a> = <a class="code" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a>;</div>
  277. <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a> = <span class="stringliteral">&quot;Gain&quot;</span>;</div>
  278. <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a> = <span class="stringliteral">&quot;gain&quot;</span>;</div>
  279. <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a> = 0.0f;</div>
  280. <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a> = 2.0f;</div>
  281. <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a> = 1.0f;</div>
  282. <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; }</div>
  283. <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; </div>
  284. <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  285. <div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;<span class="comment"> * Internal data */</span></div>
  286. <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160;<span class="comment"></span> </div>
  287. <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;<span class="comment"> /**</span></div>
  288. <div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;<span class="comment"> Get the current value of a parameter.</span></div>
  289. <div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160;<span class="comment"> */</span></div>
  290. <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; <span class="keywordtype">float</span> getParameterValue(uint32_t index)<span class="keyword"> const override</span></div>
  291. <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;<span class="keyword"> </span>{</div>
  292. <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; <span class="comment">// same as before, ignore index check</span></div>
  293. <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; </div>
  294. <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keywordflow">return</span> fGain;</div>
  295. <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; }</div>
  296. <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;<span class="comment"></span> </div>
  297. <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;<span class="comment"> /**</span></div>
  298. <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;<span class="comment"> Change a parameter value.</span></div>
  299. <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;<span class="comment"> */</span></div>
  300. <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; <span class="keywordtype">void</span> setParameterValue(uint32_t index, <span class="keywordtype">float</span> value)<span class="keyword"> override</span></div>
  301. <div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;<span class="keyword"> </span>{</div>
  302. <div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; <span class="comment">// same as before, ignore index check</span></div>
  303. <div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; </div>
  304. <div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; fGain = value;</div>
  305. <div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; }</div>
  306. <div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; </div>
  307. <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  308. <div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;<span class="comment"> * Audio/MIDI Processing */</span></div>
  309. <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; </div>
  310. <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; <span class="keywordtype">void</span> run(<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>
  311. <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;<span class="keyword"> </span>{</div>
  312. <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; <span class="comment">// get the mono input and output</span></div>
  313. <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> in = inputs[0];</div>
  314. <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> out = outputs[0];</div>
  315. <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; </div>
  316. <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; <span class="comment">// apply gain against all samples</span></div>
  317. <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; <span class="keywordflow">for</span> (uint32_t i=0; i &lt; frames; ++i)</div>
  318. <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; out[i] = in[i] * fGain;</div>
  319. <div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; }</div>
  320. <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; </div>
  321. <div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160; <span class="keyword">private</span>:</div>
  322. <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; <span class="keywordtype">float</span> fGain;</div>
  323. <div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; };</div>
  324. <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; <span class="keyword">@end</span>code</div>
  325. <div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; </div>
  326. <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; See the <a class="code" href="structParameter.html">Parameter</a> <span class="keyword">struct </span>for more information about parameters.</div>
  327. <div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; </div>
  328. <div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160; @section Programs</div>
  329. <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160; Programs in DPF refer to plugin-side presets (usually called &quot;factory presets&quot;),</div>
  330. <div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160; an initial set of presets provided by plugin authors included in the actual plugin.</div>
  331. <div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160; </div>
  332. <div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; To use programs you must first enable them by setting @ref <a class="code" href="group__PluginMacros.html#gad95e24b17f196260cee15255fdb5b677">DISTRHO_PLUGIN_WANT_PROGRAMS</a> to 1 in your DistrhoPluginInfo.h file.@n</div>
  333. <div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; When enabled you&#39;ll need to override 2 new function in your plugin code,</div>
  334. <div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160; <a class="code" href="classPlugin.html">Plugin</a>::initProgramName(uint32_t, String&amp;) and <a class="code" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">Plugin::loadProgram</a>(uint32_t).</div>
  335. <div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160; </div>
  336. <div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160; Here&#39;s an example of a plugin with a &quot;default&quot; program:</div>
  337. <div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160; @code</div>
  338. <div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; <span class="keyword">class </span>PluginWithPresets : <span class="keyword">public</span> <a class="code" href="classPlugin.html">Plugin</a></div>
  339. <div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160; {</div>
  340. <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160; <span class="keyword">public</span>:</div>
  341. <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160; PluginWithPresets()</div>
  342. <div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160; : <a class="code" href="classPlugin.html">Plugin</a>(2, 1, 0), <span class="comment">// 2 parameters, 1 program and 0 states</span></div>
  343. <div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160; fGainL(1.0f),</div>
  344. <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160; fGainR(1.0f),</div>
  345. <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160; {</div>
  346. <div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160; }</div>
  347. <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160; </div>
  348. <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; <span class="keyword">protected</span>:</div>
  349. <div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  350. <div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160;<span class="comment"> * Information */</span></div>
  351. <div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; </div>
  352. <div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getLabel()<span class="keyword"> const override</span></div>
  353. <div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;<span class="keyword"> </span>{</div>
  354. <div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;Prog&quot;</span>;</div>
  355. <div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160; }</div>
  356. <div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; </div>
  357. <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getMaker()<span class="keyword"> const override</span></div>
  358. <div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;<span class="keyword"> </span>{</div>
  359. <div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>
  360. <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; }</div>
  361. <div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; </div>
  362. <div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getLicense()<span class="keyword"> const override</span></div>
  363. <div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<span class="keyword"> </span>{</div>
  364. <div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>
  365. <div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160; }</div>
  366. <div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; </div>
  367. <div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; uint32_t getVersion()<span class="keyword"> const override</span></div>
  368. <div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;<span class="keyword"> </span>{</div>
  369. <div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; <span class="keywordflow">return</span> d_version(1, 0, 0);</div>
  370. <div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160; }</div>
  371. <div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160; </div>
  372. <div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160; int64_t getUniqueId()<span class="keyword"> const override</span></div>
  373. <div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;<span class="keyword"> </span>{</div>
  374. <div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; <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>
  375. <div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160; }</div>
  376. <div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160; </div>
  377. <div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  378. <div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;<span class="comment"> * Init */</span></div>
  379. <div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;<span class="comment"></span> </div>
  380. <div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;<span class="comment"> /**</span></div>
  381. <div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160;<span class="comment"> Initialize a parameter.</span></div>
  382. <div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160;<span class="comment"> This function will be called once, shortly after the plugin is created.</span></div>
  383. <div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;<span class="comment"> */</span></div>
  384. <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; <span class="keywordtype">void</span> initParameter(uint32_t index, <a class="code" href="structParameter.html">Parameter</a>&amp; parameter)<span class="keyword"> override</span></div>
  385. <div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;<span class="keyword"> </span>{</div>
  386. <div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160; parameter.<a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a> = <a class="code" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a>;</div>
  387. <div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a> = 0.0f;</div>
  388. <div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160; parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a> = 2.0f;</div>
  389. <div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; parameter.<a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a> = 1.0f;</div>
  390. <div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160; </div>
  391. <div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160; <span class="keywordflow">switch</span> (index)</div>
  392. <div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; {</div>
  393. <div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; <span class="keywordflow">case</span> 0;</div>
  394. <div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a> = <span class="stringliteral">&quot;Gain Right&quot;</span>;</div>
  395. <div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a> = <span class="stringliteral">&quot;gainR&quot;</span>;</div>
  396. <div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; <span class="keywordflow">break</span>;</div>
  397. <div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <span class="keywordflow">case</span> 1;</div>
  398. <div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; parameter.<a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a> = <span class="stringliteral">&quot;Gain Left&quot;</span>;</div>
  399. <div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; parameter.<a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a> = <span class="stringliteral">&quot;gainL&quot;</span>;</div>
  400. <div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; <span class="keywordflow">break</span>;</div>
  401. <div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; }</div>
  402. <div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; }</div>
  403. <div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;<span class="comment"></span> </div>
  404. <div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;<span class="comment"> /**</span></div>
  405. <div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;<span class="comment"> Set the name of the program @a index.</span></div>
  406. <div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;<span class="comment"> This function will be called once, shortly after the plugin is created.</span></div>
  407. <div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160;<span class="comment"> */</span></div>
  408. <div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; <span class="keywordtype">void</span> initProgramName(uint32_t index, <a class="code" href="classString.html">String</a>&amp; programName)</div>
  409. <div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160; {</div>
  410. <div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160; <span class="keywordflow">switch</span>(index)</div>
  411. <div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; {</div>
  412. <div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160; <span class="keywordflow">case</span> 0:</div>
  413. <div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160; programName = <span class="stringliteral">&quot;Default&quot;</span>;</div>
  414. <div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160; <span class="keywordflow">break</span>;</div>
  415. <div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160; }</div>
  416. <div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160; }</div>
  417. <div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; </div>
  418. <div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  419. <div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;<span class="comment"> * Internal data */</span></div>
  420. <div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;<span class="comment"></span> </div>
  421. <div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;<span class="comment"> /**</span></div>
  422. <div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;<span class="comment"> Get the current value of a parameter.</span></div>
  423. <div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;<span class="comment"> */</span></div>
  424. <div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160; <span class="keywordtype">float</span> getParameterValue(uint32_t index)<span class="keyword"> const override</span></div>
  425. <div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160;<span class="keyword"> </span>{</div>
  426. <div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160; <span class="keywordflow">switch</span> (index)</div>
  427. <div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160; {</div>
  428. <div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160; <span class="keywordflow">case</span> 0;</div>
  429. <div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160; <span class="keywordflow">return</span> fGainL;</div>
  430. <div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160; <span class="keywordflow">case</span> 1;</div>
  431. <div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160; <span class="keywordflow">return</span> fGainR;</div>
  432. <div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160; }</div>
  433. <div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160; }</div>
  434. <div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160;<span class="comment"></span> </div>
  435. <div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160;<span class="comment"> /**</span></div>
  436. <div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;<span class="comment"> Change a parameter value.</span></div>
  437. <div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;<span class="comment"> */</span></div>
  438. <div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160; <span class="keywordtype">void</span> setParameterValue(uint32_t index, <span class="keywordtype">float</span> value)<span class="keyword"> override</span></div>
  439. <div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160;<span class="keyword"> </span>{</div>
  440. <div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160; <span class="keywordflow">switch</span> (index)</div>
  441. <div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160; {</div>
  442. <div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160; <span class="keywordflow">case</span> 0;</div>
  443. <div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160; fGainL = value;</div>
  444. <div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160; <span class="keywordflow">break</span>;</div>
  445. <div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160; <span class="keywordflow">case</span> 1;</div>
  446. <div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160; fGainR = value;</div>
  447. <div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160; <span class="keywordflow">break</span>;</div>
  448. <div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160; }</div>
  449. <div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160; }</div>
  450. <div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160;<span class="comment"></span> </div>
  451. <div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160;<span class="comment"> /**</span></div>
  452. <div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160;<span class="comment"> Load a program.</span></div>
  453. <div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160;<span class="comment"> */</span></div>
  454. <div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160; <span class="keywordtype">void</span> loadProgram(uint32_t index)</div>
  455. <div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160; {</div>
  456. <div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160; <span class="keywordflow">switch</span>(index)</div>
  457. <div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160; {</div>
  458. <div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160; <span class="keywordflow">case</span> 0:</div>
  459. <div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160; fGainL = 1.0f;</div>
  460. <div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160; fGainR = 1.0f;</div>
  461. <div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160; <span class="keywordflow">break</span>;</div>
  462. <div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160; }</div>
  463. <div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160; }</div>
  464. <div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160; </div>
  465. <div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160; <span class="comment">/* ----------------------------------------------------------------------------------------</span></div>
  466. <div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160;<span class="comment"> * Audio/MIDI Processing */</span></div>
  467. <div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160; </div>
  468. <div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160; <span class="keywordtype">void</span> run(<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>
  469. <div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;<span class="keyword"> </span>{</div>
  470. <div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160; <span class="comment">// get the left and right audio buffers</span></div>
  471. <div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> inL = inputs[0];</div>
  472. <div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> inR = inputs[0];</div>
  473. <div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160; <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> outL = outputs[0];</div>
  474. <div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160; <span class="comment">/* */</span> <span class="keywordtype">float</span>* <span class="keyword">const</span> outR = outputs[0];</div>
  475. <div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160; </div>
  476. <div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160; <span class="comment">// apply gain against all samples</span></div>
  477. <div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; <span class="keywordflow">for</span> (uint32_t i=0; i &lt; frames; ++i)</div>
  478. <div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160; {</div>
  479. <div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160; outL[i] = inL[i] * fGainL;</div>
  480. <div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160; outR[i] = inR[i] * fGainR;</div>
  481. <div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160; }</div>
  482. <div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160; }</div>
  483. <div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160; </div>
  484. <div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160; <span class="keyword">private</span>:</div>
  485. <div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160; <span class="keywordtype">float</span> fGainL, fGainR;</div>
  486. <div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160; };</div>
  487. <div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160; <span class="keyword">@end</span>code</div>
  488. <div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160; </div>
  489. <div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160; This is a work-in-progress documentation page. States, MIDI, Latency, Time-Position and <a class="code" href="classUI.html">UI</a> are still TODO.</div>
  490. <div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;*/</div>
  491. <div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160; </div>
  492. <div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;<span class="preprocessor">#if 0</span></div>
  493. <div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160; @section States</div>
  494. <div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160; describe them</div>
  495. <div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160; </div>
  496. <div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160; @section MIDI</div>
  497. <div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160; describe them</div>
  498. <div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160; </div>
  499. <div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; @section Latency</div>
  500. <div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; describe it</div>
  501. <div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160; </div>
  502. <div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160; @section Time-Position</div>
  503. <div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160; describe it</div>
  504. <div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160; </div>
  505. <div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160; @section <a class="code" href="classUI.html">UI</a></div>
  506. <div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160; describe them</div>
  507. <div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160;<span class="preprocessor">#endif</span></div>
  508. <div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160; </div>
  509. <div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>
  510. <div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160;<span class="comment"> * Plugin Macros */</span></div>
  511. <div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160;<span class="comment"></span> </div>
  512. <div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160;<span class="comment">/**</span></div>
  513. <div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160;<span class="comment"> @defgroup PluginMacros Plugin Macros</span></div>
  514. <div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160;<span class="comment"></span> </div>
  515. <div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160;<span class="comment"> C Macros that describe your plugin. (defined in the &quot;DistrhoPluginInfo.h&quot; file)</span></div>
  516. <div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160;<span class="comment"></span> </div>
  517. <div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160;<span class="comment"> With these macros you can tell the host what features your plugin requires.@n</span></div>
  518. <div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160;<span class="comment"> Depending on which macros you enable, new functions will be available to call and/or override.</span></div>
  519. <div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160;<span class="comment"></span> </div>
  520. <div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160;<span class="comment"> All values are either integer or strings.@n</span></div>
  521. <div class="line"><a name="l00452"></a><span class="lineno"> 452</span>&#160;<span class="comment"> For boolean-like values 1 means &#39;on&#39; and 0 means &#39;off&#39;.</span></div>
  522. <div class="line"><a name="l00453"></a><span class="lineno"> 453</span>&#160;<span class="comment"></span> </div>
  523. <div class="line"><a name="l00454"></a><span class="lineno"> 454</span>&#160;<span class="comment"> The values defined in this group are for documentation purposes only.@n</span></div>
  524. <div class="line"><a name="l00455"></a><span class="lineno"> 455</span>&#160;<span class="comment"> All macros are disabled by default.</span></div>
  525. <div class="line"><a name="l00456"></a><span class="lineno"> 456</span>&#160;<span class="comment"></span> </div>
  526. <div class="line"><a name="l00457"></a><span class="lineno"> 457</span>&#160;<span class="comment"> Only 4 macros are required, they are:</span></div>
  527. <div class="line"><a name="l00458"></a><span class="lineno"> 458</span>&#160;<span class="comment"> - @ref DISTRHO_PLUGIN_NAME</span></div>
  528. <div class="line"><a name="l00459"></a><span class="lineno"> 459</span>&#160;<span class="comment"> - @ref DISTRHO_PLUGIN_NUM_INPUTS</span></div>
  529. <div class="line"><a name="l00460"></a><span class="lineno"> 460</span>&#160;<span class="comment"> - @ref DISTRHO_PLUGIN_NUM_OUTPUTS</span></div>
  530. <div class="line"><a name="l00461"></a><span class="lineno"> 461</span>&#160;<span class="comment"> - @ref DISTRHO_PLUGIN_URI</span></div>
  531. <div class="line"><a name="l00462"></a><span class="lineno"> 462</span>&#160;<span class="comment"> @{</span></div>
  532. <div class="line"><a name="l00463"></a><span class="lineno"> 463</span>&#160;<span class="comment"> */</span></div>
  533. <div class="line"><a name="l00464"></a><span class="lineno"> 464</span>&#160;<span class="comment"></span> </div>
  534. <div class="line"><a name="l00465"></a><span class="lineno"> 465</span>&#160;<span class="comment">/**</span></div>
  535. <div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160;<span class="comment"> The plugin name.@n</span></div>
  536. <div class="line"><a name="l00467"></a><span class="lineno"> 467</span>&#160;<span class="comment"> This is used to identify your plugin before a Plugin instance can be created.</span></div>
  537. <div class="line"><a name="l00468"></a><span class="lineno"> 468</span>&#160;<span class="comment"> @note This macro is required.</span></div>
  538. <div class="line"><a name="l00469"></a><span class="lineno"> 469</span>&#160;<span class="comment"> */</span></div>
  539. <div class="line"><a name="l00470"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4"> 470</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_NAME &quot;Plugin Name&quot;</span></div>
  540. <div class="line"><a name="l00471"></a><span class="lineno"> 471</span>&#160;<span class="comment"></span> </div>
  541. <div class="line"><a name="l00472"></a><span class="lineno"> 472</span>&#160;<span class="comment">/**</span></div>
  542. <div class="line"><a name="l00473"></a><span class="lineno"> 473</span>&#160;<span class="comment"> Number of audio inputs the plugin has.</span></div>
  543. <div class="line"><a name="l00474"></a><span class="lineno"> 474</span>&#160;<span class="comment"> @note This macro is required.</span></div>
  544. <div class="line"><a name="l00475"></a><span class="lineno"> 475</span>&#160;<span class="comment"> */</span></div>
  545. <div class="line"><a name="l00476"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga5f4f3d9a5dc3c23882d158e636319998"> 476</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_NUM_INPUTS 2</span></div>
  546. <div class="line"><a name="l00477"></a><span class="lineno"> 477</span>&#160;<span class="comment"></span> </div>
  547. <div class="line"><a name="l00478"></a><span class="lineno"> 478</span>&#160;<span class="comment">/**</span></div>
  548. <div class="line"><a name="l00479"></a><span class="lineno"> 479</span>&#160;<span class="comment"> Number of audio outputs the plugin has.</span></div>
  549. <div class="line"><a name="l00480"></a><span class="lineno"> 480</span>&#160;<span class="comment"> @note This macro is required.</span></div>
  550. <div class="line"><a name="l00481"></a><span class="lineno"> 481</span>&#160;<span class="comment"> */</span></div>
  551. <div class="line"><a name="l00482"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca"> 482</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_NUM_OUTPUTS 2</span></div>
  552. <div class="line"><a name="l00483"></a><span class="lineno"> 483</span>&#160;<span class="comment"></span> </div>
  553. <div class="line"><a name="l00484"></a><span class="lineno"> 484</span>&#160;<span class="comment">/**</span></div>
  554. <div class="line"><a name="l00485"></a><span class="lineno"> 485</span>&#160;<span class="comment"> The plugin URI when exporting in LV2 format.</span></div>
  555. <div class="line"><a name="l00486"></a><span class="lineno"> 486</span>&#160;<span class="comment"> @note This macro is required.</span></div>
  556. <div class="line"><a name="l00487"></a><span class="lineno"> 487</span>&#160;<span class="comment"> */</span></div>
  557. <div class="line"><a name="l00488"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8"> 488</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_URI &quot;urn:distrho:name&quot;</span></div>
  558. <div class="line"><a name="l00489"></a><span class="lineno"> 489</span>&#160;<span class="comment"></span> </div>
  559. <div class="line"><a name="l00490"></a><span class="lineno"> 490</span>&#160;<span class="comment">/**</span></div>
  560. <div class="line"><a name="l00491"></a><span class="lineno"> 491</span>&#160;<span class="comment"> Whether the plugin has a custom %UI.</span></div>
  561. <div class="line"><a name="l00492"></a><span class="lineno"> 492</span>&#160;<span class="comment"> @see DISTRHO_UI_USE_NANOVG</span></div>
  562. <div class="line"><a name="l00493"></a><span class="lineno"> 493</span>&#160;<span class="comment"> @see UI</span></div>
  563. <div class="line"><a name="l00494"></a><span class="lineno"> 494</span>&#160;<span class="comment"> */</span></div>
  564. <div class="line"><a name="l00495"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gacf8a1af679c09637ba0bdc5f4f8e37dd"> 495</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_HAS_UI 1</span></div>
  565. <div class="line"><a name="l00496"></a><span class="lineno"> 496</span>&#160;<span class="comment"></span> </div>
  566. <div class="line"><a name="l00497"></a><span class="lineno"> 497</span>&#160;<span class="comment">/**</span></div>
  567. <div class="line"><a name="l00498"></a><span class="lineno"> 498</span>&#160;<span class="comment"> Whether the plugin processing is realtime-safe.@n</span></div>
  568. <div class="line"><a name="l00499"></a><span class="lineno"> 499</span>&#160;<span class="comment"> TODO - list rtsafe requirements</span></div>
  569. <div class="line"><a name="l00500"></a><span class="lineno"> 500</span>&#160;<span class="comment"> */</span></div>
  570. <div class="line"><a name="l00501"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga82546dd199fcea338b113f2f6da84ced"> 501</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_IS_RT_SAFE 1</span></div>
  571. <div class="line"><a name="l00502"></a><span class="lineno"> 502</span>&#160;<span class="comment"></span> </div>
  572. <div class="line"><a name="l00503"></a><span class="lineno"> 503</span>&#160;<span class="comment">/**</span></div>
  573. <div class="line"><a name="l00504"></a><span class="lineno"> 504</span>&#160;<span class="comment"> Whether the plugin is a synth.@n</span></div>
  574. <div class="line"><a name="l00505"></a><span class="lineno"> 505</span>&#160;<span class="comment"> @ref DISTRHO_PLUGIN_WANT_MIDI_INPUT is automatically enabled when this is too.</span></div>
  575. <div class="line"><a name="l00506"></a><span class="lineno"> 506</span>&#160;<span class="comment"> @see DISTRHO_PLUGIN_WANT_MIDI_INPUT</span></div>
  576. <div class="line"><a name="l00507"></a><span class="lineno"> 507</span>&#160;<span class="comment"> */</span></div>
  577. <div class="line"><a name="l00508"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga854bde6b6fdb0d47182149dbab0fed72"> 508</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_IS_SYNTH 1</span></div>
  578. <div class="line"><a name="l00509"></a><span class="lineno"> 509</span>&#160;<span class="comment"></span> </div>
  579. <div class="line"><a name="l00510"></a><span class="lineno"> 510</span>&#160;<span class="comment">/**</span></div>
  580. <div class="line"><a name="l00511"></a><span class="lineno"> 511</span>&#160;<span class="comment"> Enable direct access between the %UI and plugin code.</span></div>
  581. <div class="line"><a name="l00512"></a><span class="lineno"> 512</span>&#160;<span class="comment"> @see UI::getPluginInstancePointer()</span></div>
  582. <div class="line"><a name="l00513"></a><span class="lineno"> 513</span>&#160;<span class="comment"> @note DO NOT USE THIS UNLESS STRICTLY NECESSARY!!</span></div>
  583. <div class="line"><a name="l00514"></a><span class="lineno"> 514</span>&#160;<span class="comment"> Try to avoid it at all costs!</span></div>
  584. <div class="line"><a name="l00515"></a><span class="lineno"> 515</span>&#160;<span class="comment"> */</span></div>
  585. <div class="line"><a name="l00516"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gac6873a3950f52f3fde8e386af63b69a1"> 516</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_DIRECT_ACCESS 0</span></div>
  586. <div class="line"><a name="l00517"></a><span class="lineno"> 517</span>&#160;<span class="comment"></span> </div>
  587. <div class="line"><a name="l00518"></a><span class="lineno"> 518</span>&#160;<span class="comment">/**</span></div>
  588. <div class="line"><a name="l00519"></a><span class="lineno"> 519</span>&#160;<span class="comment"> Whether the plugin introduces latency during audio or midi processing.</span></div>
  589. <div class="line"><a name="l00520"></a><span class="lineno"> 520</span>&#160;<span class="comment"> @see Plugin::setLatency(uint32_t)</span></div>
  590. <div class="line"><a name="l00521"></a><span class="lineno"> 521</span>&#160;<span class="comment"> */</span></div>
  591. <div class="line"><a name="l00522"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gad6b0ebf10e048f4742f29735da4d4930"> 522</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_LATENCY 1</span></div>
  592. <div class="line"><a name="l00523"></a><span class="lineno"> 523</span>&#160;<span class="comment"></span> </div>
  593. <div class="line"><a name="l00524"></a><span class="lineno"> 524</span>&#160;<span class="comment">/**</span></div>
  594. <div class="line"><a name="l00525"></a><span class="lineno"> 525</span>&#160;<span class="comment"> Whether the plugin wants MIDI input.@n</span></div>
  595. <div class="line"><a name="l00526"></a><span class="lineno"> 526</span>&#160;<span class="comment"> This is automatically enabled if @ref DISTRHO_PLUGIN_IS_SYNTH is true.</span></div>
  596. <div class="line"><a name="l00527"></a><span class="lineno"> 527</span>&#160;<span class="comment"> */</span></div>
  597. <div class="line"><a name="l00528"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gadf2e2eb7550e4116001c816adfb04a70"> 528</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_MIDI_INPUT 1</span></div>
  598. <div class="line"><a name="l00529"></a><span class="lineno"> 529</span>&#160;<span class="comment"></span> </div>
  599. <div class="line"><a name="l00530"></a><span class="lineno"> 530</span>&#160;<span class="comment">/**</span></div>
  600. <div class="line"><a name="l00531"></a><span class="lineno"> 531</span>&#160;<span class="comment"> Whether the plugin wants MIDI output.</span></div>
  601. <div class="line"><a name="l00532"></a><span class="lineno"> 532</span>&#160;<span class="comment"> @see Plugin::writeMidiEvent(const MidiEvent&amp;)</span></div>
  602. <div class="line"><a name="l00533"></a><span class="lineno"> 533</span>&#160;<span class="comment"> */</span></div>
  603. <div class="line"><a name="l00534"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga548522eb91344a45841a5a95ff4f8073"> 534</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_MIDI_OUTPUT 1</span></div>
  604. <div class="line"><a name="l00535"></a><span class="lineno"> 535</span>&#160;<span class="comment"></span> </div>
  605. <div class="line"><a name="l00536"></a><span class="lineno"> 536</span>&#160;<span class="comment">/**</span></div>
  606. <div class="line"><a name="l00537"></a><span class="lineno"> 537</span>&#160;<span class="comment"> Whether the plugin wants to change its own parameter inputs.@n</span></div>
  607. <div class="line"><a name="l00538"></a><span class="lineno"> 538</span>&#160;<span class="comment"> Not all hosts or plugin formats support this,</span></div>
  608. <div class="line"><a name="l00539"></a><span class="lineno"> 539</span>&#160;<span class="comment"> so Plugin::canRequestParameterValueChanges() can be used to query support at runtime.</span></div>
  609. <div class="line"><a name="l00540"></a><span class="lineno"> 540</span>&#160;<span class="comment"> @see Plugin::requestParameterValueChange(uint32_t, float)</span></div>
  610. <div class="line"><a name="l00541"></a><span class="lineno"> 541</span>&#160;<span class="comment"> */</span></div>
  611. <div class="line"><a name="l00542"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga5a33bc5567795bdbbaab32313fabc652"> 542</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST 1</span></div>
  612. <div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160;<span class="comment"></span> </div>
  613. <div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160;<span class="comment">/**</span></div>
  614. <div class="line"><a name="l00545"></a><span class="lineno"> 545</span>&#160;<span class="comment"> Whether the plugin provides its own internal programs.</span></div>
  615. <div class="line"><a name="l00546"></a><span class="lineno"> 546</span>&#160;<span class="comment"> @see Plugin::initProgramName(uint32_t, String&amp;)</span></div>
  616. <div class="line"><a name="l00547"></a><span class="lineno"> 547</span>&#160;<span class="comment"> @see Plugin::loadProgram(uint32_t)</span></div>
  617. <div class="line"><a name="l00548"></a><span class="lineno"> 548</span>&#160;<span class="comment"> */</span></div>
  618. <div class="line"><a name="l00549"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gad95e24b17f196260cee15255fdb5b677"> 549</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_PROGRAMS 1</span></div>
  619. <div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160;<span class="comment"></span> </div>
  620. <div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160;<span class="comment">/**</span></div>
  621. <div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160;<span class="comment"> Whether the plugin uses internal non-parameter data.</span></div>
  622. <div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160;<span class="comment"> @see Plugin::initState(uint32_t, String&amp;, String&amp;)</span></div>
  623. <div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160;<span class="comment"> @see Plugin::setState(const char*, const char*)</span></div>
  624. <div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160;<span class="comment"> */</span></div>
  625. <div class="line"><a name="l00556"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga255f43cc0997af8b56abcca260c875e0"> 556</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_STATE 1</span></div>
  626. <div class="line"><a name="l00557"></a><span class="lineno"> 557</span>&#160;<span class="comment"></span> </div>
  627. <div class="line"><a name="l00558"></a><span class="lineno"> 558</span>&#160;<span class="comment">/**</span></div>
  628. <div class="line"><a name="l00559"></a><span class="lineno"> 559</span>&#160;<span class="comment"> Whether the plugin implements the full state API.</span></div>
  629. <div class="line"><a name="l00560"></a><span class="lineno"> 560</span>&#160;<span class="comment"> When this macro is enabled, the plugin must implement a new getState(const char* key) function, which the host calls when saving its session/project.</span></div>
  630. <div class="line"><a name="l00561"></a><span class="lineno"> 561</span>&#160;<span class="comment"> This is useful for plugins that have custom internal values not exposed to the host as key-value state pairs or parameters.</span></div>
  631. <div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160;<span class="comment"> Most simple effects and synths will not need this.</span></div>
  632. <div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160;<span class="comment"> @note this macro is automatically enabled if a plugin has programs and state, as the key-value state pairs need to be updated when the current program changes.</span></div>
  633. <div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160;<span class="comment"> @see Plugin::getState(const char*)</span></div>
  634. <div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160;<span class="comment"> */</span></div>
  635. <div class="line"><a name="l00566"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gac022d3d0a8782d632d7a801bc9cf721e"> 566</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_FULL_STATE 1</span></div>
  636. <div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160;<span class="comment"></span> </div>
  637. <div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160;<span class="comment">/**</span></div>
  638. <div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160;<span class="comment"> Whether the plugin wants time position information from the host.</span></div>
  639. <div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160;<span class="comment"> @see Plugin::getTimePosition()</span></div>
  640. <div class="line"><a name="l00571"></a><span class="lineno"> 571</span>&#160;<span class="comment"> */</span></div>
  641. <div class="line"><a name="l00572"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga496610b956d931b1940d07da48d123f2"> 572</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_TIMEPOS 1</span></div>
  642. <div class="line"><a name="l00573"></a><span class="lineno"> 573</span>&#160;<span class="comment"></span> </div>
  643. <div class="line"><a name="l00574"></a><span class="lineno"> 574</span>&#160;<span class="comment">/**</span></div>
  644. <div class="line"><a name="l00575"></a><span class="lineno"> 575</span>&#160;<span class="comment"> Whether the %UI uses a custom toolkit implementation based on OpenGL.@n</span></div>
  645. <div class="line"><a name="l00576"></a><span class="lineno"> 576</span>&#160;<span class="comment"> When enabled, the macros @ref DISTRHO_UI_CUSTOM_INCLUDE_PATH and @ref DISTRHO_UI_CUSTOM_WIDGET_TYPE are required.</span></div>
  646. <div class="line"><a name="l00577"></a><span class="lineno"> 577</span>&#160;<span class="comment"> */</span></div>
  647. <div class="line"><a name="l00578"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga5bcd1ce31e47a617de4c32fbf85e44ca"> 578</a></span>&#160;<span class="preprocessor">#define DISTRHO_UI_USE_CUSTOM 1</span></div>
  648. <div class="line"><a name="l00579"></a><span class="lineno"> 579</span>&#160;<span class="comment"></span> </div>
  649. <div class="line"><a name="l00580"></a><span class="lineno"> 580</span>&#160;<span class="comment">/**</span></div>
  650. <div class="line"><a name="l00581"></a><span class="lineno"> 581</span>&#160;<span class="comment"> The include path to the header file used by the custom toolkit implementation.</span></div>
  651. <div class="line"><a name="l00582"></a><span class="lineno"> 582</span>&#160;<span class="comment"> This path must be relative to dpf/distrho/DistrhoUI.hpp</span></div>
  652. <div class="line"><a name="l00583"></a><span class="lineno"> 583</span>&#160;<span class="comment"> @see DISTRHO_UI_USE_CUSTOM</span></div>
  653. <div class="line"><a name="l00584"></a><span class="lineno"> 584</span>&#160;<span class="comment"> */</span></div>
  654. <div class="line"><a name="l00585"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gaf978778ddb34e3663a5c0bd128067e10"> 585</a></span>&#160;<span class="preprocessor">#define DISTRHO_UI_CUSTOM_INCLUDE_PATH</span></div>
  655. <div class="line"><a name="l00586"></a><span class="lineno"> 586</span>&#160;<span class="comment"></span> </div>
  656. <div class="line"><a name="l00587"></a><span class="lineno"> 587</span>&#160;<span class="comment">/**</span></div>
  657. <div class="line"><a name="l00588"></a><span class="lineno"> 588</span>&#160;<span class="comment"> The top-level-widget typedef to use for the custom toolkit.</span></div>
  658. <div class="line"><a name="l00589"></a><span class="lineno"> 589</span>&#160;<span class="comment"> This widget class MUST be a subclass of DGL TopLevelWindow class.</span></div>
  659. <div class="line"><a name="l00590"></a><span class="lineno"> 590</span>&#160;<span class="comment"> It is recommended that you keep this widget class inside the DGL namespace,</span></div>
  660. <div class="line"><a name="l00591"></a><span class="lineno"> 591</span>&#160;<span class="comment"> and define widget type as e.g. DGL_NAMESPACE::MyCustomTopLevelWidget.</span></div>
  661. <div class="line"><a name="l00592"></a><span class="lineno"> 592</span>&#160;<span class="comment"> @see DISTRHO_UI_USE_CUSTOM</span></div>
  662. <div class="line"><a name="l00593"></a><span class="lineno"> 593</span>&#160;<span class="comment"> */</span></div>
  663. <div class="line"><a name="l00594"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gaf6377f757b9796bd37f7be4e605ccd4a"> 594</a></span>&#160;<span class="preprocessor">#define DISTRHO_UI_CUSTOM_WIDGET_TYPE</span></div>
  664. <div class="line"><a name="l00595"></a><span class="lineno"> 595</span>&#160;<span class="comment"></span> </div>
  665. <div class="line"><a name="l00596"></a><span class="lineno"> 596</span>&#160;<span class="comment">/**</span></div>
  666. <div class="line"><a name="l00597"></a><span class="lineno"> 597</span>&#160;<span class="comment"> Whether the %UI uses NanoVG for drawing instead of the default raw OpenGL calls.@n</span></div>
  667. <div class="line"><a name="l00598"></a><span class="lineno"> 598</span>&#160;<span class="comment"> When enabled your %UI instance will subclass @ref NanoWidget instead of @ref Widget.</span></div>
  668. <div class="line"><a name="l00599"></a><span class="lineno"> 599</span>&#160;<span class="comment"> */</span></div>
  669. <div class="line"><a name="l00600"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gad49e79936a2aa5afa089cbc051426ccd"> 600</a></span>&#160;<span class="preprocessor">#define DISTRHO_UI_USE_NANOVG 1</span></div>
  670. <div class="line"><a name="l00601"></a><span class="lineno"> 601</span>&#160;<span class="comment"></span> </div>
  671. <div class="line"><a name="l00602"></a><span class="lineno"> 602</span>&#160;<span class="comment">/**</span></div>
  672. <div class="line"><a name="l00603"></a><span class="lineno"> 603</span>&#160;<span class="comment"> Whether the %UI is resizable to any size by the user.@n</span></div>
  673. <div class="line"><a name="l00604"></a><span class="lineno"> 604</span>&#160;<span class="comment"> By default this is false, and resizing is only allowed under the plugin UI control,@n</span></div>
  674. <div class="line"><a name="l00605"></a><span class="lineno"> 605</span>&#160;<span class="comment"> Enabling this options makes it possible for the user to resize the plugin UI at anytime.</span></div>
  675. <div class="line"><a name="l00606"></a><span class="lineno"> 606</span>&#160;<span class="comment"> @see UI::setGeometryConstraints(uint, uint, bool, bool)</span></div>
  676. <div class="line"><a name="l00607"></a><span class="lineno"> 607</span>&#160;<span class="comment"> */</span></div>
  677. <div class="line"><a name="l00608"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gabadb9d9ba7f479df39b3963ee60b7a4b"> 608</a></span>&#160;<span class="preprocessor">#define DISTRHO_UI_USER_RESIZABLE 1</span></div>
  678. <div class="line"><a name="l00609"></a><span class="lineno"> 609</span>&#160;<span class="comment"></span> </div>
  679. <div class="line"><a name="l00610"></a><span class="lineno"> 610</span>&#160;<span class="comment">/**</span></div>
  680. <div class="line"><a name="l00611"></a><span class="lineno"> 611</span>&#160;<span class="comment"> The %UI URI when exporting in LV2 format.@n</span></div>
  681. <div class="line"><a name="l00612"></a><span class="lineno"> 612</span>&#160;<span class="comment"> By default this is set to @ref DISTRHO_PLUGIN_URI with &quot;#UI&quot; as suffix.</span></div>
  682. <div class="line"><a name="l00613"></a><span class="lineno"> 613</span>&#160;<span class="comment"> */</span></div>
  683. <div class="line"><a name="l00614"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga420a88022da249b9f38a6046998dbd7c"> 614</a></span>&#160;<span class="preprocessor">#define DISTRHO_UI_URI DISTRHO_PLUGIN_URI &quot;#UI&quot;</span></div>
  684. <div class="line"><a name="l00615"></a><span class="lineno"> 615</span>&#160;<span class="comment"></span> </div>
  685. <div class="line"><a name="l00616"></a><span class="lineno"> 616</span>&#160;<span class="comment">/** @} */</span></div>
  686. <div class="line"><a name="l00617"></a><span class="lineno"> 617</span>&#160; </div>
  687. <div class="line"><a name="l00618"></a><span class="lineno"> 618</span>&#160;<span class="comment">// -----------------------------------------------------------------------------------------------------------</span></div>
  688. <div class="line"><a name="l00619"></a><span class="lineno"> 619</span>&#160; </div>
  689. <div class="line"><a name="l00620"></a><span class="lineno"> 620</span>&#160;END_NAMESPACE_DISTRHO</div>
  690. <div class="line"><a name="l00621"></a><span class="lineno"> 621</span>&#160; </div>
  691. <div class="line"><a name="l00622"></a><span class="lineno"> 622</span>&#160;<span class="preprocessor">#endif // DOXYGEN</span></div>
  692. </div><!-- fragment --></div><!-- contents -->
  693. <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>
  694. <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>
  695. <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>
  696. <div class="ttc" id="aclassUI_html"><div class="ttname"><a href="classUI.html">UI</a></div><div class="ttdef"><b>Definition:</b> DistrhoUI.hpp:67</div></div>
  697. <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>
  698. <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>
  699. <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>
  700. <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>
  701. <div class="ttc" id="agroup__PluginMacros_html_gad95e24b17f196260cee15255fdb5b677"><div class="ttname"><a href="group__PluginMacros.html#gad95e24b17f196260cee15255fdb5b677">DISTRHO_PLUGIN_WANT_PROGRAMS</a></div><div class="ttdeci">#define DISTRHO_PLUGIN_WANT_PROGRAMS</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:549</div></div>
  702. <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>
  703. <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>
  704. <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>
  705. <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>
  706. <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>
  707. <!-- start footer part -->
  708. <hr class="footer"/><address class="footer"><small>
  709. Generated on Tue Jun 15 2021 12:29:15 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  710. <img class="footer" src="doxygen.png" alt="doxygen"/>
  711. </a> 1.8.17
  712. </small></address>
  713. </body>
  714. </html>