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

1457 lines
253KB
Raw Blame History 

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

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

  3. <head>

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

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

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

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

  8. <title>DISTRHO Plugin Framework: distrho/DistrhoPlugin.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.9.1 -->

  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','.html');

  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. 

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

  56. <div id="MSearchResultsWindow">

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

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. <div id="nav-path" class="navpath">

  63.   <ul>

  64. <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li>  </ul>

  65. </div>

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

  67. <div class="header">

  68.   <div class="headertitle">

  69. <div class="title">DistrhoPlugin.hpp</div>  </div>

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

  71. <div class="contents">

  72. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>

  73. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>

  74. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright (C) 2012-2022 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>

  75. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>

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

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

  78. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>

  79. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>

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

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

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

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

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

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

  86. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>

  87. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>

  88. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef DISTRHO_PLUGIN_HPP_INCLUDED</span></div>

  89. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_HPP_INCLUDED</span></div>

  90. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>

  91. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;extra/String.hpp&quot;</span></div>

  92. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;extra/LeakDetector.hpp&quot;</span></div>

  93. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &quot;src/DistrhoPluginChecks.h&quot;</span></div>

  94. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; </div>

  95. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<a class="code" href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div>

  96. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160; </div>

  97. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  98. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * Audio Port Hints */</span></div>

  99. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"></span> </div>

  100. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">/**</span></div>

  101. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">   @defgroup AudioPortHints Audio Port Hints</span></div>

  102. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"></span> </div>

  103. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">   Various audio port hints.</span></div>

  104. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">   @see AudioPort::hints</span></div>

  105. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">   @{</span></div>

  106. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> */</span></div>

  107. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"></span> </div>

  108. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">/**</span></div>

  109. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">   Audio port can be used as control voltage (LV2 and JACK standalone only).</span></div>

  110. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment"> */</span></div>

  111. <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="group__AudioPortHints.html#ga92c8a0135d1b6dacd22df25295c15ff3">   40</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__AudioPortHints.html#ga92c8a0135d1b6dacd22df25295c15ff3">kAudioPortIsCV</a> = 0x1;</div>

  112. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span> </div>

  113. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">/**</span></div>

  114. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">   Audio port should be used as sidechan (LV2 and VST3 only).</span></div>

  115. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">   This hint should not be used with CV style ports.</span></div>

  116. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">   @note non-sidechain audio ports must exist in the plugin if this flag is set.</span></div>

  117. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> */</span></div>

  118. <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__AudioPortHints.html#gafbf1a5255d0a19f35ae21480ab2c7433">   47</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__AudioPortHints.html#gafbf1a5255d0a19f35ae21480ab2c7433">kAudioPortIsSidechain</a> = 0x2;</div>

  119. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"></span> </div>

  120. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">/**</span></div>

  121. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">   CV port has bipolar range (-1 to +1, or -5 to +5 if scaled).</span></div>

  122. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">   This is merely a hint to tell the host what value range to expect.</span></div>

  123. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> */</span></div>

  124. <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__AudioPortHints.html#ga7133899b77b31caa1eae3fe77409e69e">   53</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__AudioPortHints.html#ga7133899b77b31caa1eae3fe77409e69e">kCVPortHasBipolarRange</a> = 0x10;</div>

  125. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"></span> </div>

  126. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">/**</span></div>

  127. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">   CV port has negative unipolar range (-1 to 0, or -10 to 0 if scaled).</span></div>

  128. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">   This is merely a hint to tell the host what value range to expect.</span></div>

  129. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> */</span></div>

  130. <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__AudioPortHints.html#gafa444d8a3d5244e107c2ddb19f60105d">   59</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__AudioPortHints.html#gafa444d8a3d5244e107c2ddb19f60105d">kCVPortHasNegativeUnipolarRange</a> = 0x20;</div>

  131. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"></span> </div>

  132. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">/**</span></div>

  133. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">   CV port has positive unipolar range (0 to +1, or 0 to +10 if scaled).</span></div>

  134. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">   This is merely a hint to tell the host what value range to expect.</span></div>

  135. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> */</span></div>

  136. <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="group__AudioPortHints.html#ga0919fac232ec9c6999057b09d54e3919">   65</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__AudioPortHints.html#ga0919fac232ec9c6999057b09d54e3919">kCVPortHasPositiveUnipolarRange</a> = 0x40;</div>

  137. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"></span> </div>

  138. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">/**</span></div>

  139. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment">   CV port has scaled range to match real values (-5 to +5v bipolar, +/-10 to 0v unipolar).</span></div>

  140. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment">   One other range flag is required if this flag is set.</span></div>

  141. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"></span> </div>

  142. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">   When enabled, this makes the port a mod:CVPort, compatible with the MOD Devices platform.</span></div>

  143. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"> */</span></div>

  144. <div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="group__AudioPortHints.html#gae36eb55fe0813af0dd6cdfe4f7baae97">   73</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__AudioPortHints.html#gae36eb55fe0813af0dd6cdfe4f7baae97">kCVPortHasScaledRange</a> = 0x80;</div>

  145. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"></span> </div>

  146. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">/** @} */</span></div>

  147. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160; </div>

  148. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  149. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> * Parameter Hints */</span></div>

  150. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"></span> </div>

  151. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">/**</span></div>

  152. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">   @defgroup ParameterHints Parameter Hints</span></div>

  153. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"></span> </div>

  154. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">   Various parameter hints.</span></div>

  155. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">   @see Parameter::hints</span></div>

  156. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">   @{</span></div>

  157. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> */</span></div>

  158. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"></span> </div>

  159. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">/**</span></div>

  160. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">   Parameter is automatable (real-time safe).</span></div>

  161. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">   @see Plugin::setParameterValue(uint32_t, float)</span></div>

  162. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"> */</span></div>

  163. <div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#ga6d39267b105c2d8dfc82a810c5e8a061">   92</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__ParameterHints.html#ga6d39267b105c2d8dfc82a810c5e8a061">kParameterIsAutomatable</a> = 0x01;</div>

  164. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"></span> </div>

  165. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">/** It was a typo, sorry.. */</span></div>

  166. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;kParameterIsAutomatable&quot;</span>)</div>

  167. <div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">   96</a></span>&#160;static const uint32_t <a class="code" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a> = <a class="code" href="group__ParameterHints.html#ga6d39267b105c2d8dfc82a810c5e8a061">kParameterIsAutomatable</a>;</div>

  168. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"></span> </div>

  169. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment">/**</span></div>

  170. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment">   Parameter value is boolean.@n</span></div>

  171. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">   It&#39;s always at either minimum or maximum value.</span></div>

  172. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> */</span></div>

  173. <div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">  102</a></span>&#160;static const uint32_t <a class="code" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a> = 0x02;</div>

  174. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"></span> </div>

  175. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment">/**</span></div>

  176. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment">   Parameter value is integer.</span></div>

  177. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> */</span></div>

  178. <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#ga76a82c93efe6ad728c9f0cb4ef33a2b9">  107</a></span>&#160;static const uint32_t <a class="code" href="group__ParameterHints.html#ga76a82c93efe6ad728c9f0cb4ef33a2b9">kParameterIsInteger</a> = 0x04;</div>

  179. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"></span> </div>

  180. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment">/**</span></div>

  181. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment">   Parameter value is logarithmic.</span></div>

  182. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> */</span></div>

  183. <div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#gabc539ecbfe420246a33f93aed32b8a3b">  112</a></span>&#160;static const uint32_t <a class="code" href="group__ParameterHints.html#gabc539ecbfe420246a33f93aed32b8a3b">kParameterIsLogarithmic</a> = 0x08;</div>

  184. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"></span> </div>

  185. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">/**</span></div>

  186. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">   Parameter is of output type.@n</span></div>

  187. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment">   When unset, parameter is assumed to be of input type.</span></div>

  188. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"></span> </div>

  189. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment">   Parameter inputs are changed by the host and typically should not be changed by the plugin.@n</span></div>

  190. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment">   One exception is when changing programs, see Plugin::loadProgram().@n</span></div>

  191. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">   The other exception is with parameter change requests, see Plugin::requestParameterValueChange().@n</span></div>

  192. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment">   Outputs are changed by the plugin and never modified by the host.</span></div>

  193. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"></span> </div>

  194. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment">   If you are targetting VST2, make sure to order your parameters so that all inputs are before any outputs.</span></div>

  195. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> */</span></div>

  196. <div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#ga0a3633c93e8589f4b3e6124bb97ad8d4">  125</a></span>&#160;static const uint32_t <a class="code" href="group__ParameterHints.html#ga0a3633c93e8589f4b3e6124bb97ad8d4">kParameterIsOutput</a> = 0x10;</div>

  197. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"></span> </div>

  198. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">/**</span></div>

  199. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment">   Parameter value is a trigger.@n</span></div>

  200. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">   This means the value resets back to its default after each process/run call.@n</span></div>

  201. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment">   Cannot be used for output parameters.</span></div>

  202. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment"></span> </div>

  203. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">   @note Only officially supported under LV2. For other formats DPF simulates the behaviour.</span></div>

  204. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">*/</span></div>

  205. <div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#ga068de47c587411c9e91ef09f7d800884">  134</a></span>&#160;static const uint32_t <a class="code" href="group__ParameterHints.html#ga068de47c587411c9e91ef09f7d800884">kParameterIsTrigger</a> = 0x20 | <a class="code" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a>;</div>

  206. <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"></span> </div>

  207. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">/** @} */</span></div>

  208. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160; </div>

  209. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  210. <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> * State Hints */</span></div>

  211. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"></span> </div>

  212. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment">/**</span></div>

  213. <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">   @defgroup StateHints State Hints</span></div>

  214. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"></span> </div>

  215. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment">   Various state hints.</span></div>

  216. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment">   @see State::hints</span></div>

  217. <div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment">   @{</span></div>

  218. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> */</span></div>

  219. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"></span> </div>

  220. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment">/**</span></div>

  221. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment">   State is visible and readable by hosts that support string-type plugin parameters.</span></div>

  222. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment"> */</span></div>

  223. <div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="group__StateHints.html#gacbcc437321d85ca23d692b68802a0165">  152</a></span>&#160;static const uint32_t <a class="code" href="group__StateHints.html#gacbcc437321d85ca23d692b68802a0165">kStateIsHostReadable</a> = 0x01;</div>

  224. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"></span> </div>

  225. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment">/**</span></div>

  226. <div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment">   State is writable by the host, allowing users to arbitrarily change the state.@n</span></div>

  227. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment">   For obvious reasons a writable state is also readable by the host.</span></div>

  228. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"> */</span></div>

  229. <div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="group__StateHints.html#ga57437781c616c82bcb9e409433b7f16d">  158</a></span>&#160;static const uint32_t <a class="code" href="group__StateHints.html#ga57437781c616c82bcb9e409433b7f16d">kStateIsHostWritable</a> = 0x02 | <a class="code" href="group__StateHints.html#gacbcc437321d85ca23d692b68802a0165">kStateIsHostReadable</a>;</div>

  230. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"></span> </div>

  231. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">/**</span></div>

  232. <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">   State is a filename path instead of a regular string.@n</span></div>

  233. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">   The readable and writable hints are required for filenames to work, and thus are automatically set.</span></div>

  234. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment"> */</span></div>

  235. <div class="line"><a name="l00164"></a><span class="lineno"><a class="line" href="group__StateHints.html#gaea57e1af2af673c2647757335d2d3751">  164</a></span>&#160;static const uint32_t <a class="code" href="group__StateHints.html#gaea57e1af2af673c2647757335d2d3751">kStateIsFilenamePath</a> = 0x04 | <a class="code" href="group__StateHints.html#ga57437781c616c82bcb9e409433b7f16d">kStateIsHostWritable</a>;</div>

  236. <div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"></span> </div>

  237. <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment">/**</span></div>

  238. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment">   State is a base64 encoded string.</span></div>

  239. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment"> */</span></div>

  240. <div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="group__StateHints.html#gad07fa3f1fd8ca36e94f75518d9d3d29e">  169</a></span>&#160;static const uint32_t <a class="code" href="group__StateHints.html#gad07fa3f1fd8ca36e94f75518d9d3d29e">kStateIsBase64Blob</a> = 0x08;</div>

  241. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment"></span> </div>

  242. <div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment">/**</span></div>

  243. <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment">   State is for Plugin/DSP side only, meaning there is never a need to notify the UI when it changes.</span></div>

  244. <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment"> */</span></div>

  245. <div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="group__StateHints.html#ga1e7299b8d4c8c1fc57bceef2b87fe057">  174</a></span>&#160;static const uint32_t <a class="code" href="group__StateHints.html#ga1e7299b8d4c8c1fc57bceef2b87fe057">kStateIsOnlyForDSP</a> = 0x10;</div>

  246. <div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"></span> </div>

  247. <div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment">/**</span></div>

  248. <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment">   State is for UI side only.@n</span></div>

  249. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment">   If the DSP and UI are separate and the UI is not available, this property won&#39;t be saved.</span></div>

  250. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"> */</span></div>

  251. <div class="line"><a name="l00180"></a><span class="lineno"><a class="line" href="group__StateHints.html#ga7d960ebb437726e25066b5e38b4a4843">  180</a></span>&#160;static const uint32_t <a class="code" href="group__StateHints.html#ga7d960ebb437726e25066b5e38b4a4843">kStateIsOnlyForUI</a> = 0x20;</div>

  252. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"></span> </div>

  253. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment">/** @} */</span></div>

  254. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160; </div>

  255. <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  256. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="comment"> * Base Plugin structs */</span></div>

  257. <div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="comment"></span> </div>

  258. <div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment">/**</span></div>

  259. <div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment">   @defgroup BasePluginStructs Base Plugin Structs</span></div>

  260. <div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">   @{</span></div>

  261. <div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment"> */</span></div>

  262. <div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment"></span> </div>

  263. <div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment">/**</span></div>

  264. <div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment">   Parameter designation.@n</span></div>

  265. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment">   Allows a parameter to be specially designated for a task, like bypass.</span></div>

  266. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment"></span> </div>

  267. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment">   Each designation is unique, there must be only one parameter that uses it.@n</span></div>

  268. <div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment">   The use of designated parameters is completely optional.</span></div>

  269. <div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment"></span> </div>

  270. <div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment">   @note Designated parameters have strict ranges.</span></div>

  271. <div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment">   @see ParameterRanges::adjustForDesignation()</span></div>

  272. <div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment"> */</span></div>

  273. <div class="line"><a name="l00202"></a><span class="lineno"><a class="line" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">  202</a></span>&#160;enum <a class="code" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> {<span class="comment"></span></div>

  274. <div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="comment">   /**</span></div>

  275. <div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment">     Null or unset designation.</span></div>

  276. <div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="comment">    */</span></div>

  277. <div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">  206</a></span>&#160;    <a class="code" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a> = 0,</div>

  278. <div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment"></span> </div>

  279. <div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment">   /**</span></div>

  280. <div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;<span class="comment">     Bypass designation.@n</span></div>

  281. <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="comment">     When on (&gt; 0.5f), it means the plugin must run in a bypassed state.</span></div>

  282. <div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;<span class="comment">    */</span></div>

  283. <div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;    <a class="code" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">kParameterDesignationBypass</a> = 1</div>

  284. <div class="line"><a name="l00213"></a><span class="lineno"><a class="line" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">  213</a></span>&#160;};</div>

  285. <div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="comment"></span> </div>

  286. <div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment">/**</span></div>

  287. <div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment">   Predefined Port Groups Ids.</span></div>

  288. <div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment"></span> </div>

  289. <div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;<span class="comment">   This enumeration provides a few commonly used groups for convenient use in plugins.</span></div>

  290. <div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment">   For preventing conflicts with user code, negative values are used here.</span></div>

  291. <div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;<span class="comment">   When rolling your own port groups, you MUST start their group ids from 0 and they MUST be sequential.</span></div>

  292. <div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;<span class="comment"></span> </div>

  293. <div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;<span class="comment">   @see PortGroup</span></div>

  294. <div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment"> */</span></div>

  295. <div class="line"><a name="l00224"></a><span class="lineno"><a class="line" href="group__BasePluginStructs.html#ga177ca6eb2528109ec4a130a643e8c70a">  224</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="group__BasePluginStructs.html#ga177ca6eb2528109ec4a130a643e8c70a">PredefinedPortGroupsIds</a> {<span class="comment"></span></div>

  296. <div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment">   /**</span></div>

  297. <div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment">     Null or unset port group.</span></div>

  298. <div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment">    */</span></div>

  299. <div class="line"><a name="l00228"></a><span class="lineno"><a class="line" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaea27aed9948a2aaf4978941c96df3932">  228</a></span>&#160;    <a class="code" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaea27aed9948a2aaf4978941c96df3932">kPortGroupNone</a> = (uint32_t)-1,</div>

  300. <div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="comment"></span> </div>

  301. <div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;<span class="comment">   /**</span></div>

  302. <div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;<span class="comment">     A single channel audio group.</span></div>

  303. <div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment">    */</span></div>

  304. <div class="line"><a name="l00233"></a><span class="lineno"><a class="line" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aa0f890fe6310b119745b6c6cb409c5fe9">  233</a></span>&#160;    <a class="code" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aa0f890fe6310b119745b6c6cb409c5fe9">kPortGroupMono</a> = (uint32_t)-2,</div>

  305. <div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="comment"></span> </div>

  306. <div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;<span class="comment">   /**</span></div>

  307. <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;<span class="comment">     A 2-channel discrete stereo audio group,</span></div>

  308. <div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="comment">     where the 1st audio port is the left channel and the 2nd port is the right channel.</span></div>

  309. <div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;<span class="comment">    */</span></div>

  310. <div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;    <a class="code" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaeefc1b206ffdedf67376156cf6e5d114">kPortGroupStereo</a> = (uint32_t)-3</div>

  311. <div class="line"><a name="l00240"></a><span class="lineno"><a class="line" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaeefc1b206ffdedf67376156cf6e5d114">  240</a></span>&#160;};</div>

  312. <div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment"></span> </div>

  313. <div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="comment">/**</span></div>

  314. <div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment">   Audio Port.</span></div>

  315. <div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;<span class="comment"></span> </div>

  316. <div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;<span class="comment">   Can be used as CV port by specifying kAudioPortIsCV in hints,@n</span></div>

  317. <div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;<span class="comment">   but this is only supported in LV2 and JACK standalone formats.</span></div>

  318. <div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;<span class="comment"> */</span></div>

  319. <div class="line"><a name="l00248"></a><span class="lineno"><a class="line" href="structAudioPort.html">  248</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structAudioPort.html">AudioPort</a> {<span class="comment"></span></div>

  320. <div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;<span class="comment">   /**</span></div>

  321. <div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;<span class="comment">      Hints describing this audio port.</span></div>

  322. <div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;<span class="comment">      @see AudioPortHints</span></div>

  323. <div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;<span class="comment">    */</span></div>

  324. <div class="line"><a name="l00253"></a><span class="lineno"><a class="line" href="structAudioPort.html#af93f38f9ef48ea14544adf32e4b1e513">  253</a></span>&#160;    uint32_t <a class="code" href="structAudioPort.html#af93f38f9ef48ea14544adf32e4b1e513">hints</a>;</div>

  325. <div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;<span class="comment"></span> </div>

  326. <div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment">   /**</span></div>

  327. <div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment">      The name of this audio port.@n</span></div>

  328. <div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment">      An audio port name can contain any character, but hosts might have a hard time with non-ascii ones.@n</span></div>

  329. <div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;<span class="comment">      The name doesn&#39;t have to be unique within a plugin instance, but it&#39;s recommended.</span></div>

  330. <div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;<span class="comment">    */</span></div>

  331. <div class="line"><a name="l00260"></a><span class="lineno"><a class="line" href="structAudioPort.html#adb3b58f79131b653d6b2adfa3ea07e5c">  260</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structAudioPort.html#adb3b58f79131b653d6b2adfa3ea07e5c">name</a>;</div>

  332. <div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;<span class="comment"></span> </div>

  333. <div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;<span class="comment">   /**</span></div>

  334. <div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;<span class="comment">      The symbol of this audio port.@n</span></div>

  335. <div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;<span class="comment">      An audio port symbol is a short restricted name used as a machine and human readable identifier.@n</span></div>

  336. <div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;<span class="comment">      The first character must be one of _, a-z or A-Z and subsequent characters can be from _, a-z, A-Z and 0-9.</span></div>

  337. <div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;<span class="comment">      @note Audio port and parameter symbols MUST be unique within a plugin instance.</span></div>

  338. <div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;<span class="comment">    */</span></div>

  339. <div class="line"><a name="l00268"></a><span class="lineno"><a class="line" href="structAudioPort.html#af2bda30f97a1b63cbeb9f11f718d3d30">  268</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structAudioPort.html#af2bda30f97a1b63cbeb9f11f718d3d30">symbol</a>;</div>

  340. <div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;<span class="comment"></span> </div>

  341. <div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;<span class="comment">   /**</span></div>

  342. <div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;<span class="comment">      The group id that this audio/cv port belongs to.</span></div>

  343. <div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;<span class="comment">      No group is assigned by default.</span></div>

  344. <div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;<span class="comment"></span> </div>

  345. <div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;<span class="comment">      You can use a group from PredefinedPortGroups or roll your own.@n</span></div>

  346. <div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;<span class="comment">      When rolling your own port groups, you MUST start their group ids from 0 and they MUST be sequential.</span></div>

  347. <div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;<span class="comment">      @see PortGroup, Plugin::initPortGroup</span></div>

  348. <div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;<span class="comment">    */</span></div>

  349. <div class="line"><a name="l00278"></a><span class="lineno"><a class="line" href="structAudioPort.html#a80aba3da64389d738bd8ae68bcedb4f4">  278</a></span>&#160;    uint32_t <a class="code" href="structAudioPort.html#a80aba3da64389d738bd8ae68bcedb4f4">groupId</a>;</div>

  350. <div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;<span class="comment"></span> </div>

  351. <div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;<span class="comment">   /**</span></div>

  352. <div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;<span class="comment">      Default constructor for a regular audio port.</span></div>

  353. <div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;<span class="comment">    */</span></div>

  354. <div class="line"><a name="l00283"></a><span class="lineno"><a class="line" href="structAudioPort.html#abbd5c1ad18e0b920c2ff6c5053e59ede">  283</a></span>&#160;    <a class="code" href="structAudioPort.html#abbd5c1ad18e0b920c2ff6c5053e59ede">AudioPort</a>() noexcept</div>

  355. <div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;        : <a class="code" href="structAudioPort.html#af93f38f9ef48ea14544adf32e4b1e513">hints</a>(0x0),</div>

  356. <div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;          <a class="code" href="structAudioPort.html#adb3b58f79131b653d6b2adfa3ea07e5c">name</a>(),</div>

  357. <div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;          <a class="code" href="structAudioPort.html#af2bda30f97a1b63cbeb9f11f718d3d30">symbol</a>(),</div>

  358. <div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;          <a class="code" href="structAudioPort.html#a80aba3da64389d738bd8ae68bcedb4f4">groupId</a>(<a class="code" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaea27aed9948a2aaf4978941c96df3932">kPortGroupNone</a>) {}</div>

  359. <div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;};</div>

  360. <div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;<span class="comment"></span> </div>

  361. <div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;<span class="comment">/**</span></div>

  362. <div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;<span class="comment">   Parameter ranges.@n</span></div>

  363. <div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;<span class="comment">   This is used to set the default, minimum and maximum values of a parameter.</span></div>

  364. <div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;<span class="comment"></span> </div>

  365. <div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;<span class="comment">   By default a parameter has 0.0 as minimum, 1.0 as maximum and 0.0 as default.@n</span></div>

  366. <div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;<span class="comment">   When changing this struct values you must ensure maximum &gt; minimum and default is within range.</span></div>

  367. <div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;<span class="comment"> */</span></div>

  368. <div class="line"><a name="l00297"></a><span class="lineno"><a class="line" href="structParameterRanges.html">  297</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structParameterRanges.html">ParameterRanges</a> {<span class="comment"></span></div>

  369. <div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;<span class="comment">   /**</span></div>

  370. <div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;<span class="comment">      Default value.</span></div>

  371. <div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;<span class="comment">    */</span></div>

  372. <div class="line"><a name="l00301"></a><span class="lineno"><a class="line" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">  301</a></span>&#160;    <span class="keywordtype">float</span> <a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a>;</div>

  373. <div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;<span class="comment"></span> </div>

  374. <div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;<span class="comment">   /**</span></div>

  375. <div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="comment">      Minimum value.</span></div>

  376. <div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="comment">    */</span></div>

  377. <div class="line"><a name="l00306"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">  306</a></span>&#160;    <span class="keywordtype">float</span> <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>;</div>

  378. <div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;<span class="comment"></span> </div>

  379. <div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;<span class="comment">   /**</span></div>

  380. <div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;<span class="comment">      Maximum value.</span></div>

  381. <div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;<span class="comment">    */</span></div>

  382. <div class="line"><a name="l00311"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">  311</a></span>&#160;    <span class="keywordtype">float</span> <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>;</div>

  383. <div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160;<span class="comment"></span> </div>

  384. <div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;<span class="comment">   /**</span></div>

  385. <div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;<span class="comment">      Default constructor, using 0.0 as default, 0.0 as minimum, 1.0 as maximum.</span></div>

  386. <div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;<span class="comment">    */</span></div>

  387. <div class="line"><a name="l00316"></a><span class="lineno"><a class="line" href="structParameterRanges.html#adb9b2712df3401eb0c5e11362d865d4e">  316</a></span>&#160;    <a class="code" href="structParameterRanges.html#adb9b2712df3401eb0c5e11362d865d4e">ParameterRanges</a>() noexcept</div>

  388. <div class="line"><a name="l00317"></a><span class="lineno">  317</span>&#160;        : <a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a>(0.0f),</div>

  389. <div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;          <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>(0.0f),</div>

  390. <div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;          <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>(1.0f) {}</div>

  391. <div class="line"><a name="l00320"></a><span class="lineno">  320</span>&#160;<span class="comment"></span> </div>

  392. <div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;<span class="comment">   /**</span></div>

  393. <div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;<span class="comment">      Constructor using custom values.</span></div>

  394. <div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;<span class="comment">    */</span></div>

  395. <div class="line"><a name="l00324"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a75337384c041ef8cd1a1cd2ba57ac205">  324</a></span>&#160;    <a class="code" href="structParameterRanges.html#a75337384c041ef8cd1a1cd2ba57ac205">ParameterRanges</a>(<span class="keywordtype">float</span> df, <span class="keywordtype">float</span> mn, <span class="keywordtype">float</span> mx) noexcept</div>

  396. <div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160;        : <a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a>(df),</div>

  397. <div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;          <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>(mn),</div>

  398. <div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;          <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>(mx) {}</div>

  399. <div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;<span class="comment"></span> </div>

  400. <div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;<span class="comment">   /**</span></div>

  401. <div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160;<span class="comment">      Fix the default value within range.</span></div>

  402. <div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;<span class="comment">    */</span></div>

  403. <div class="line"><a name="l00332"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a17519e584ccc28e87b73bfbd1a81cf10">  332</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structParameterRanges.html#a17519e584ccc28e87b73bfbd1a81cf10">fixDefault</a>() noexcept</div>

  404. <div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;    {</div>

  405. <div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;        <a class="code" href="structParameterRanges.html#a1dac84c100f420bfc529a4d2ea60dc7c">fixValue</a>(<a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a>);</div>

  406. <div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;    }</div>

  407. <div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;<span class="comment"></span> </div>

  408. <div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;<span class="comment">   /**</span></div>

  409. <div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;<span class="comment">      Fix a value within range.</span></div>

  410. <div class="line"><a name="l00339"></a><span class="lineno">  339</span>&#160;<span class="comment">    */</span></div>

  411. <div class="line"><a name="l00340"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a1dac84c100f420bfc529a4d2ea60dc7c">  340</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structParameterRanges.html#a1dac84c100f420bfc529a4d2ea60dc7c">fixValue</a>(<span class="keywordtype">float</span>&amp; value) <span class="keyword">const</span> noexcept</div>

  412. <div class="line"><a name="l00341"></a><span class="lineno">  341</span>&#160;    {</div>

  413. <div class="line"><a name="l00342"></a><span class="lineno">  342</span>&#160;        <span class="keywordflow">if</span> (value &lt; <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>)</div>

  414. <div class="line"><a name="l00343"></a><span class="lineno">  343</span>&#160;            value = <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>;</div>

  415. <div class="line"><a name="l00344"></a><span class="lineno">  344</span>&#160;        <span class="keywordflow">else</span> <span class="keywordflow">if</span> (value &gt; <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>)</div>

  416. <div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160;            value = <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>;</div>

  417. <div class="line"><a name="l00346"></a><span class="lineno">  346</span>&#160;    }</div>

  418. <div class="line"><a name="l00347"></a><span class="lineno">  347</span>&#160;<span class="comment"></span> </div>

  419. <div class="line"><a name="l00348"></a><span class="lineno">  348</span>&#160;<span class="comment">   /**</span></div>

  420. <div class="line"><a name="l00349"></a><span class="lineno">  349</span>&#160;<span class="comment">      Get a fixed value within range.</span></div>

  421. <div class="line"><a name="l00350"></a><span class="lineno">  350</span>&#160;<span class="comment">    */</span></div>

  422. <div class="line"><a name="l00351"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a983383b2b3ce5d049802a7f0a12cee0c">  351</a></span>&#160;    <span class="keywordtype">float</span> <a class="code" href="structParameterRanges.html#a983383b2b3ce5d049802a7f0a12cee0c">getFixedValue</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>&amp; value) <span class="keyword">const</span> noexcept</div>

  423. <div class="line"><a name="l00352"></a><span class="lineno">  352</span>&#160;    {</div>

  424. <div class="line"><a name="l00353"></a><span class="lineno">  353</span>&#160;        <span class="keywordflow">if</span> (value &lt;= <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>)</div>

  425. <div class="line"><a name="l00354"></a><span class="lineno">  354</span>&#160;            <span class="keywordflow">return</span> <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>;</div>

  426. <div class="line"><a name="l00355"></a><span class="lineno">  355</span>&#160;        <span class="keywordflow">if</span> (value &gt;= <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>)</div>

  427. <div class="line"><a name="l00356"></a><span class="lineno">  356</span>&#160;            <span class="keywordflow">return</span> <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>;</div>

  428. <div class="line"><a name="l00357"></a><span class="lineno">  357</span>&#160;        <span class="keywordflow">return</span> value;</div>

  429. <div class="line"><a name="l00358"></a><span class="lineno">  358</span>&#160;    }</div>

  430. <div class="line"><a name="l00359"></a><span class="lineno">  359</span>&#160;<span class="comment"></span> </div>

  431. <div class="line"><a name="l00360"></a><span class="lineno">  360</span>&#160;<span class="comment">   /**</span></div>

  432. <div class="line"><a name="l00361"></a><span class="lineno">  361</span>&#160;<span class="comment">      Get a value normalized to 0.0&lt;-&gt;1.0.</span></div>

  433. <div class="line"><a name="l00362"></a><span class="lineno">  362</span>&#160;<span class="comment">    */</span></div>

  434. <div class="line"><a name="l00363"></a><span class="lineno"><a class="line" href="structParameterRanges.html#ad16ef939c1caa2f51e9a4041f769f86e">  363</a></span>&#160;    <span class="keywordtype">float</span> <a class="code" href="structParameterRanges.html#ad16ef939c1caa2f51e9a4041f769f86e">getNormalizedValue</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>&amp; value) <span class="keyword">const</span> noexcept</div>

  435. <div class="line"><a name="l00364"></a><span class="lineno">  364</span>&#160;    {</div>

  436. <div class="line"><a name="l00365"></a><span class="lineno">  365</span>&#160;        <span class="keyword">const</span> <span class="keywordtype">float</span> normValue((value - <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>) / (<a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a> - <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>));</div>

  437. <div class="line"><a name="l00366"></a><span class="lineno">  366</span>&#160; </div>

  438. <div class="line"><a name="l00367"></a><span class="lineno">  367</span>&#160;        <span class="keywordflow">if</span> (normValue &lt;= 0.0f)</div>

  439. <div class="line"><a name="l00368"></a><span class="lineno">  368</span>&#160;            <span class="keywordflow">return</span> 0.0f;</div>

  440. <div class="line"><a name="l00369"></a><span class="lineno">  369</span>&#160;        <span class="keywordflow">if</span> (normValue &gt;= 1.0f)</div>

  441. <div class="line"><a name="l00370"></a><span class="lineno">  370</span>&#160;            <span class="keywordflow">return</span> 1.0f;</div>

  442. <div class="line"><a name="l00371"></a><span class="lineno">  371</span>&#160;        <span class="keywordflow">return</span> normValue;</div>

  443. <div class="line"><a name="l00372"></a><span class="lineno">  372</span>&#160;    }</div>

  444. <div class="line"><a name="l00373"></a><span class="lineno">  373</span>&#160;<span class="comment"></span> </div>

  445. <div class="line"><a name="l00374"></a><span class="lineno">  374</span>&#160;<span class="comment">   /**</span></div>

  446. <div class="line"><a name="l00375"></a><span class="lineno">  375</span>&#160;<span class="comment">      Get a value normalized to 0.0&lt;-&gt;1.0, fixed within range.</span></div>

  447. <div class="line"><a name="l00376"></a><span class="lineno">  376</span>&#160;<span class="comment">    */</span></div>

  448. <div class="line"><a name="l00377"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a82698a1e07b1b04ccb5df0de4db0d0be">  377</a></span>&#160;    <span class="keywordtype">float</span> <a class="code" href="structParameterRanges.html#a82698a1e07b1b04ccb5df0de4db0d0be">getFixedAndNormalizedValue</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>&amp; value) <span class="keyword">const</span> noexcept</div>

  449. <div class="line"><a name="l00378"></a><span class="lineno">  378</span>&#160;    {</div>

  450. <div class="line"><a name="l00379"></a><span class="lineno">  379</span>&#160;        <span class="keywordflow">if</span> (value &lt;= <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>)</div>

  451. <div class="line"><a name="l00380"></a><span class="lineno">  380</span>&#160;            <span class="keywordflow">return</span> 0.0f;</div>

  452. <div class="line"><a name="l00381"></a><span class="lineno">  381</span>&#160;        <span class="keywordflow">if</span> (value &gt;= <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>)</div>

  453. <div class="line"><a name="l00382"></a><span class="lineno">  382</span>&#160;            <span class="keywordflow">return</span> 1.0f;</div>

  454. <div class="line"><a name="l00383"></a><span class="lineno">  383</span>&#160; </div>

  455. <div class="line"><a name="l00384"></a><span class="lineno">  384</span>&#160;        <span class="keyword">const</span> <span class="keywordtype">float</span> normValue((value - <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>) / (<a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a> - <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>));</div>

  456. <div class="line"><a name="l00385"></a><span class="lineno">  385</span>&#160; </div>

  457. <div class="line"><a name="l00386"></a><span class="lineno">  386</span>&#160;        <span class="keywordflow">if</span> (normValue &lt;= 0.0f)</div>

  458. <div class="line"><a name="l00387"></a><span class="lineno">  387</span>&#160;            <span class="keywordflow">return</span> 0.0f;</div>

  459. <div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;        <span class="keywordflow">if</span> (normValue &gt;= 1.0f)</div>

  460. <div class="line"><a name="l00389"></a><span class="lineno">  389</span>&#160;            <span class="keywordflow">return</span> 1.0f;</div>

  461. <div class="line"><a name="l00390"></a><span class="lineno">  390</span>&#160; </div>

  462. <div class="line"><a name="l00391"></a><span class="lineno">  391</span>&#160;        <span class="keywordflow">return</span> normValue;</div>

  463. <div class="line"><a name="l00392"></a><span class="lineno">  392</span>&#160;    }</div>

  464. <div class="line"><a name="l00393"></a><span class="lineno">  393</span>&#160;<span class="comment"></span> </div>

  465. <div class="line"><a name="l00394"></a><span class="lineno">  394</span>&#160;<span class="comment">   /**</span></div>

  466. <div class="line"><a name="l00395"></a><span class="lineno">  395</span>&#160;<span class="comment">      Get a proper value previously normalized to 0.0&lt;-&gt;1.0.</span></div>

  467. <div class="line"><a name="l00396"></a><span class="lineno">  396</span>&#160;<span class="comment">    */</span></div>

  468. <div class="line"><a name="l00397"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a992f75a925b3cd5e66544087708ea3c3">  397</a></span>&#160;    <span class="keywordtype">float</span> <a class="code" href="structParameterRanges.html#a992f75a925b3cd5e66544087708ea3c3">getUnnormalizedValue</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>&amp; value) <span class="keyword">const</span> noexcept</div>

  469. <div class="line"><a name="l00398"></a><span class="lineno">  398</span>&#160;    {</div>

  470. <div class="line"><a name="l00399"></a><span class="lineno">  399</span>&#160;        <span class="keywordflow">if</span> (value &lt;= 0.0f)</div>

  471. <div class="line"><a name="l00400"></a><span class="lineno">  400</span>&#160;            <span class="keywordflow">return</span> <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>;</div>

  472. <div class="line"><a name="l00401"></a><span class="lineno">  401</span>&#160;        <span class="keywordflow">if</span> (value &gt;= 1.0f)</div>

  473. <div class="line"><a name="l00402"></a><span class="lineno">  402</span>&#160;            <span class="keywordflow">return</span> <a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a>;</div>

  474. <div class="line"><a name="l00403"></a><span class="lineno">  403</span>&#160; </div>

  475. <div class="line"><a name="l00404"></a><span class="lineno">  404</span>&#160;        <span class="keywordflow">return</span> value * (<a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a> - <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>) + <a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a>;</div>

  476. <div class="line"><a name="l00405"></a><span class="lineno">  405</span>&#160;    }</div>

  477. <div class="line"><a name="l00406"></a><span class="lineno">  406</span>&#160;};</div>

  478. <div class="line"><a name="l00407"></a><span class="lineno">  407</span>&#160;<span class="comment"></span> </div>

  479. <div class="line"><a name="l00408"></a><span class="lineno">  408</span>&#160;<span class="comment">/**</span></div>

  480. <div class="line"><a name="l00409"></a><span class="lineno">  409</span>&#160;<span class="comment">   Parameter enumeration value.@n</span></div>

  481. <div class="line"><a name="l00410"></a><span class="lineno">  410</span>&#160;<span class="comment">   A string representation of a plugin parameter value.@n</span></div>

  482. <div class="line"><a name="l00411"></a><span class="lineno">  411</span>&#160;<span class="comment">   Used together can be used to give meaning to parameter values, working as an enumeration.</span></div>

  483. <div class="line"><a name="l00412"></a><span class="lineno">  412</span>&#160;<span class="comment"> */</span></div>

  484. <div class="line"><a name="l00413"></a><span class="lineno"><a class="line" href="structParameterEnumerationValue.html">  413</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a> {<span class="comment"></span></div>

  485. <div class="line"><a name="l00414"></a><span class="lineno">  414</span>&#160;<span class="comment">   /**</span></div>

  486. <div class="line"><a name="l00415"></a><span class="lineno">  415</span>&#160;<span class="comment">      Parameter value.</span></div>

  487. <div class="line"><a name="l00416"></a><span class="lineno">  416</span>&#160;<span class="comment">    */</span></div>

  488. <div class="line"><a name="l00417"></a><span class="lineno"><a class="line" href="structParameterEnumerationValue.html#a292f282837daa791205027d998907ae9">  417</a></span>&#160;    <span class="keywordtype">float</span> <a class="code" href="structParameterEnumerationValue.html#a292f282837daa791205027d998907ae9">value</a>;</div>

  489. <div class="line"><a name="l00418"></a><span class="lineno">  418</span>&#160;<span class="comment"></span> </div>

  490. <div class="line"><a name="l00419"></a><span class="lineno">  419</span>&#160;<span class="comment">   /**</span></div>

  491. <div class="line"><a name="l00420"></a><span class="lineno">  420</span>&#160;<span class="comment">      String representation of this value.</span></div>

  492. <div class="line"><a name="l00421"></a><span class="lineno">  421</span>&#160;<span class="comment">    */</span></div>

  493. <div class="line"><a name="l00422"></a><span class="lineno"><a class="line" href="structParameterEnumerationValue.html#aba1c51d5a2c99416c1dcf0a08345178d">  422</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structParameterEnumerationValue.html#aba1c51d5a2c99416c1dcf0a08345178d">label</a>;</div>

  494. <div class="line"><a name="l00423"></a><span class="lineno">  423</span>&#160;<span class="comment"></span> </div>

  495. <div class="line"><a name="l00424"></a><span class="lineno">  424</span>&#160;<span class="comment">   /**</span></div>

  496. <div class="line"><a name="l00425"></a><span class="lineno">  425</span>&#160;<span class="comment">      Default constructor, using 0.0 as value and empty label.</span></div>

  497. <div class="line"><a name="l00426"></a><span class="lineno">  426</span>&#160;<span class="comment">    */</span></div>

  498. <div class="line"><a name="l00427"></a><span class="lineno"><a class="line" href="structParameterEnumerationValue.html#a169e558182f93aadd2e66819a981a3f9">  427</a></span>&#160;    <a class="code" href="structParameterEnumerationValue.html#a169e558182f93aadd2e66819a981a3f9">ParameterEnumerationValue</a>() noexcept</div>

  499. <div class="line"><a name="l00428"></a><span class="lineno">  428</span>&#160;        : <a class="code" href="structParameterEnumerationValue.html#a292f282837daa791205027d998907ae9">value</a>(0.0f),</div>

  500. <div class="line"><a name="l00429"></a><span class="lineno">  429</span>&#160;          <a class="code" href="structParameterEnumerationValue.html#aba1c51d5a2c99416c1dcf0a08345178d">label</a>() {}</div>

  501. <div class="line"><a name="l00430"></a><span class="lineno">  430</span>&#160;<span class="comment"></span> </div>

  502. <div class="line"><a name="l00431"></a><span class="lineno">  431</span>&#160;<span class="comment">   /**</span></div>

  503. <div class="line"><a name="l00432"></a><span class="lineno">  432</span>&#160;<span class="comment">      Constructor using custom values.</span></div>

  504. <div class="line"><a name="l00433"></a><span class="lineno">  433</span>&#160;<span class="comment">    */</span></div>

  505. <div class="line"><a name="l00434"></a><span class="lineno"><a class="line" href="structParameterEnumerationValue.html#aad073d95adfcd8ec01767490fbd69f68">  434</a></span>&#160;    <a class="code" href="structParameterEnumerationValue.html#aad073d95adfcd8ec01767490fbd69f68">ParameterEnumerationValue</a>(<span class="keywordtype">float</span> v, <span class="keyword">const</span> <span class="keywordtype">char</span>* l) noexcept</div>

  506. <div class="line"><a name="l00435"></a><span class="lineno">  435</span>&#160;        : <a class="code" href="structParameterEnumerationValue.html#a292f282837daa791205027d998907ae9">value</a>(v),</div>

  507. <div class="line"><a name="l00436"></a><span class="lineno">  436</span>&#160;          <a class="code" href="structParameterEnumerationValue.html#aba1c51d5a2c99416c1dcf0a08345178d">label</a>(l) {}</div>

  508. <div class="line"><a name="l00437"></a><span class="lineno">  437</span>&#160;};</div>

  509. <div class="line"><a name="l00438"></a><span class="lineno">  438</span>&#160;<span class="comment"></span> </div>

  510. <div class="line"><a name="l00439"></a><span class="lineno">  439</span>&#160;<span class="comment">/**</span></div>

  511. <div class="line"><a name="l00440"></a><span class="lineno">  440</span>&#160;<span class="comment">   Collection of parameter enumeration values.@n</span></div>

  512. <div class="line"><a name="l00441"></a><span class="lineno">  441</span>&#160;<span class="comment">   Handy class to handle the lifetime and count of all enumeration values.</span></div>

  513. <div class="line"><a name="l00442"></a><span class="lineno">  442</span>&#160;<span class="comment"> */</span></div>

  514. <div class="line"><a name="l00443"></a><span class="lineno"><a class="line" href="structParameterEnumerationValues.html">  443</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a> {<span class="comment"></span></div>

  515. <div class="line"><a name="l00444"></a><span class="lineno">  444</span>&#160;<span class="comment">   /**</span></div>

  516. <div class="line"><a name="l00445"></a><span class="lineno">  445</span>&#160;<span class="comment">      Number of elements allocated in @values.</span></div>

  517. <div class="line"><a name="l00446"></a><span class="lineno">  446</span>&#160;<span class="comment">    */</span></div>

  518. <div class="line"><a name="l00447"></a><span class="lineno"><a class="line" href="structParameterEnumerationValues.html#afd740dd45384c493801405a1c1c3d51d">  447</a></span>&#160;    uint8_t <a class="code" href="structParameterEnumerationValues.html#afd740dd45384c493801405a1c1c3d51d">count</a>;</div>

  519. <div class="line"><a name="l00448"></a><span class="lineno">  448</span>&#160;<span class="comment"></span> </div>

  520. <div class="line"><a name="l00449"></a><span class="lineno">  449</span>&#160;<span class="comment">   /**</span></div>

  521. <div class="line"><a name="l00450"></a><span class="lineno">  450</span>&#160;<span class="comment">      Wherever the host is to be restricted to only use enumeration values.</span></div>

  522. <div class="line"><a name="l00451"></a><span class="lineno">  451</span>&#160;<span class="comment"></span> </div>

  523. <div class="line"><a name="l00452"></a><span class="lineno">  452</span>&#160;<span class="comment">      @note This mode is only a hint! Not all hosts and plugin formats support this mode.</span></div>

  524. <div class="line"><a name="l00453"></a><span class="lineno">  453</span>&#160;<span class="comment">    */</span></div>

  525. <div class="line"><a name="l00454"></a><span class="lineno"><a class="line" href="structParameterEnumerationValues.html#a014ebcacbe68c3f77f2f8ac9ffe3cd6f">  454</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="structParameterEnumerationValues.html#a014ebcacbe68c3f77f2f8ac9ffe3cd6f">restrictedMode</a>;</div>

  526. <div class="line"><a name="l00455"></a><span class="lineno">  455</span>&#160;<span class="comment"></span> </div>

  527. <div class="line"><a name="l00456"></a><span class="lineno">  456</span>&#160;<span class="comment">   /**</span></div>

  528. <div class="line"><a name="l00457"></a><span class="lineno">  457</span>&#160;<span class="comment">      Array of @ParameterEnumerationValue items.@n</span></div>

  529. <div class="line"><a name="l00458"></a><span class="lineno">  458</span>&#160;<span class="comment">      This pointer must be null or have been allocated on the heap with `new ParameterEnumerationValue[count]`.</span></div>

  530. <div class="line"><a name="l00459"></a><span class="lineno">  459</span>&#160;<span class="comment">    */</span></div>

  531. <div class="line"><a name="l00460"></a><span class="lineno"><a class="line" href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">  460</a></span>&#160;    <a class="code" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a>* <a class="code" href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">values</a>;</div>

  532. <div class="line"><a name="l00461"></a><span class="lineno">  461</span>&#160;<span class="comment"></span> </div>

  533. <div class="line"><a name="l00462"></a><span class="lineno">  462</span>&#160;<span class="comment">   /**</span></div>

  534. <div class="line"><a name="l00463"></a><span class="lineno">  463</span>&#160;<span class="comment">      Default constructor, for zero enumeration values.</span></div>

  535. <div class="line"><a name="l00464"></a><span class="lineno">  464</span>&#160;<span class="comment">    */</span></div>

  536. <div class="line"><a name="l00465"></a><span class="lineno"><a class="line" href="structParameterEnumerationValues.html#ab1bbcf39e2efae872e9b8dbde17a045a">  465</a></span>&#160;    <a class="code" href="structParameterEnumerationValues.html#ab1bbcf39e2efae872e9b8dbde17a045a">ParameterEnumerationValues</a>() noexcept</div>

  537. <div class="line"><a name="l00466"></a><span class="lineno">  466</span>&#160;        : <a class="code" href="structParameterEnumerationValues.html#afd740dd45384c493801405a1c1c3d51d">count</a>(0),</div>

  538. <div class="line"><a name="l00467"></a><span class="lineno">  467</span>&#160;          <a class="code" href="structParameterEnumerationValues.html#a014ebcacbe68c3f77f2f8ac9ffe3cd6f">restrictedMode</a>(false),</div>

  539. <div class="line"><a name="l00468"></a><span class="lineno">  468</span>&#160;          <a class="code" href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">values</a>() {}</div>

  540. <div class="line"><a name="l00469"></a><span class="lineno">  469</span>&#160;<span class="comment"></span> </div>

  541. <div class="line"><a name="l00470"></a><span class="lineno">  470</span>&#160;<span class="comment">   /**</span></div>

  542. <div class="line"><a name="l00471"></a><span class="lineno">  471</span>&#160;<span class="comment">      Constructor using custom values.@n</span></div>

  543. <div class="line"><a name="l00472"></a><span class="lineno">  472</span>&#160;<span class="comment">      The pointer to @values must have been allocated on the heap with `new`.</span></div>

  544. <div class="line"><a name="l00473"></a><span class="lineno">  473</span>&#160;<span class="comment">    */</span></div>

  545. <div class="line"><a name="l00474"></a><span class="lineno"><a class="line" href="structParameterEnumerationValues.html#a109591a3392e28362de7e1e474f75ae2">  474</a></span>&#160;    <a class="code" href="structParameterEnumerationValues.html#a109591a3392e28362de7e1e474f75ae2">ParameterEnumerationValues</a>(uint32_t c, <span class="keywordtype">bool</span> r, <a class="code" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a>* v) noexcept</div>

  546. <div class="line"><a name="l00475"></a><span class="lineno">  475</span>&#160;        : <a class="code" href="structParameterEnumerationValues.html#afd740dd45384c493801405a1c1c3d51d">count</a>(c),</div>

  547. <div class="line"><a name="l00476"></a><span class="lineno">  476</span>&#160;          <a class="code" href="structParameterEnumerationValues.html#a014ebcacbe68c3f77f2f8ac9ffe3cd6f">restrictedMode</a>(r),</div>

  548. <div class="line"><a name="l00477"></a><span class="lineno">  477</span>&#160;          <a class="code" href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">values</a>(v) {}</div>

  549. <div class="line"><a name="l00478"></a><span class="lineno">  478</span>&#160; </div>

  550. <div class="line"><a name="l00479"></a><span class="lineno">  479</span>&#160;    ~<a class="code" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a>() noexcept</div>

  551. <div class="line"><a name="l00480"></a><span class="lineno">  480</span>&#160;    {</div>

  552. <div class="line"><a name="l00481"></a><span class="lineno">  481</span>&#160;        <a class="code" href="structParameterEnumerationValues.html#afd740dd45384c493801405a1c1c3d51d">count</a> = 0;</div>

  553. <div class="line"><a name="l00482"></a><span class="lineno">  482</span>&#160;        <a class="code" href="structParameterEnumerationValues.html#a014ebcacbe68c3f77f2f8ac9ffe3cd6f">restrictedMode</a> = <span class="keyword">false</span>;</div>

  554. <div class="line"><a name="l00483"></a><span class="lineno">  483</span>&#160; </div>

  555. <div class="line"><a name="l00484"></a><span class="lineno">  484</span>&#160;        <span class="keywordflow">if</span> (<a class="code" href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">values</a> != <span class="keyword">nullptr</span>)</div>

  556. <div class="line"><a name="l00485"></a><span class="lineno">  485</span>&#160;        {</div>

  557. <div class="line"><a name="l00486"></a><span class="lineno">  486</span>&#160;            <span class="keyword">delete</span>[] <a class="code" href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">values</a>;</div>

  558. <div class="line"><a name="l00487"></a><span class="lineno">  487</span>&#160;            <a class="code" href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">values</a> = <span class="keyword">nullptr</span>;</div>

  559. <div class="line"><a name="l00488"></a><span class="lineno">  488</span>&#160;        }</div>

  560. <div class="line"><a name="l00489"></a><span class="lineno">  489</span>&#160;    }</div>

  561. <div class="line"><a name="l00490"></a><span class="lineno">  490</span>&#160; </div>

  562. <div class="line"><a name="l00491"></a><span class="lineno">  491</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE(<a class="code" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a>)</div>

  563. <div class="line"><a name="l00492"></a><span class="lineno">  492</span>&#160;};</div>

  564. <div class="line"><a name="l00493"></a><span class="lineno">  493</span>&#160;<span class="comment"></span> </div>

  565. <div class="line"><a name="l00494"></a><span class="lineno">  494</span>&#160;<span class="comment">/**</span></div>

  566. <div class="line"><a name="l00495"></a><span class="lineno">  495</span>&#160;<span class="comment">   Parameter.</span></div>

  567. <div class="line"><a name="l00496"></a><span class="lineno">  496</span>&#160;<span class="comment"> */</span></div>

  568. <div class="line"><a name="l00497"></a><span class="lineno"><a class="line" href="structParameter.html">  497</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structParameter.html">Parameter</a> {<span class="comment"></span></div>

  569. <div class="line"><a name="l00498"></a><span class="lineno">  498</span>&#160;<span class="comment">   /**</span></div>

  570. <div class="line"><a name="l00499"></a><span class="lineno">  499</span>&#160;<span class="comment">      Hints describing this parameter.</span></div>

  571. <div class="line"><a name="l00500"></a><span class="lineno">  500</span>&#160;<span class="comment">      @see ParameterHints</span></div>

  572. <div class="line"><a name="l00501"></a><span class="lineno">  501</span>&#160;<span class="comment">    */</span></div>

  573. <div class="line"><a name="l00502"></a><span class="lineno"><a class="line" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">  502</a></span>&#160;    uint32_t <a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a>;</div>

  574. <div class="line"><a name="l00503"></a><span class="lineno">  503</span>&#160;<span class="comment"></span> </div>

  575. <div class="line"><a name="l00504"></a><span class="lineno">  504</span>&#160;<span class="comment">   /**</span></div>

  576. <div class="line"><a name="l00505"></a><span class="lineno">  505</span>&#160;<span class="comment">      The name of this parameter.@n</span></div>

  577. <div class="line"><a name="l00506"></a><span class="lineno">  506</span>&#160;<span class="comment">      A parameter name can contain any character, but hosts might have a hard time with non-ascii ones.@n</span></div>

  578. <div class="line"><a name="l00507"></a><span class="lineno">  507</span>&#160;<span class="comment">      The name doesn&#39;t have to be unique within a plugin instance, but it&#39;s recommended.</span></div>

  579. <div class="line"><a name="l00508"></a><span class="lineno">  508</span>&#160;<span class="comment">    */</span></div>

  580. <div class="line"><a name="l00509"></a><span class="lineno"><a class="line" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">  509</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>;</div>

  581. <div class="line"><a name="l00510"></a><span class="lineno">  510</span>&#160;<span class="comment"></span> </div>

  582. <div class="line"><a name="l00511"></a><span class="lineno">  511</span>&#160;<span class="comment">   /**</span></div>

  583. <div class="line"><a name="l00512"></a><span class="lineno">  512</span>&#160;<span class="comment">      The short name of this parameter.@n</span></div>

  584. <div class="line"><a name="l00513"></a><span class="lineno">  513</span>&#160;<span class="comment">      Used when displaying the parameter name in a very limited space.</span></div>

  585. <div class="line"><a name="l00514"></a><span class="lineno">  514</span>&#160;<span class="comment">      @note This value is optional, the full name is used when the short one is missing.</span></div>

  586. <div class="line"><a name="l00515"></a><span class="lineno">  515</span>&#160;<span class="comment">    */</span></div>

  587. <div class="line"><a name="l00516"></a><span class="lineno"><a class="line" href="structParameter.html#a1a47c46f3588b8a940d87fd4d69810ab">  516</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structParameter.html#a1a47c46f3588b8a940d87fd4d69810ab">shortName</a>;</div>

  588. <div class="line"><a name="l00517"></a><span class="lineno">  517</span>&#160;<span class="comment"></span> </div>

  589. <div class="line"><a name="l00518"></a><span class="lineno">  518</span>&#160;<span class="comment">   /**</span></div>

  590. <div class="line"><a name="l00519"></a><span class="lineno">  519</span>&#160;<span class="comment">      The symbol of this parameter.@n</span></div>

  591. <div class="line"><a name="l00520"></a><span class="lineno">  520</span>&#160;<span class="comment">      A parameter symbol is a short restricted name used as a machine and human readable identifier.@n</span></div>

  592. <div class="line"><a name="l00521"></a><span class="lineno">  521</span>&#160;<span class="comment">      The first character must be one of _, a-z or A-Z and subsequent characters can be from _, a-z, A-Z and 0-9.</span></div>

  593. <div class="line"><a name="l00522"></a><span class="lineno">  522</span>&#160;<span class="comment">      @note Parameter symbols MUST be unique within a plugin instance.</span></div>

  594. <div class="line"><a name="l00523"></a><span class="lineno">  523</span>&#160;<span class="comment">    */</span></div>

  595. <div class="line"><a name="l00524"></a><span class="lineno"><a class="line" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">  524</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a>;</div>

  596. <div class="line"><a name="l00525"></a><span class="lineno">  525</span>&#160;<span class="comment"></span> </div>

  597. <div class="line"><a name="l00526"></a><span class="lineno">  526</span>&#160;<span class="comment">   /**</span></div>

  598. <div class="line"><a name="l00527"></a><span class="lineno">  527</span>&#160;<span class="comment">      The unit of this parameter.@n</span></div>

  599. <div class="line"><a name="l00528"></a><span class="lineno">  528</span>&#160;<span class="comment">      This means something like &quot;dB&quot;, &quot;kHz&quot; and &quot;ms&quot;.@n</span></div>

  600. <div class="line"><a name="l00529"></a><span class="lineno">  529</span>&#160;<span class="comment">      Can be left blank if a unit does not apply to this parameter.</span></div>

  601. <div class="line"><a name="l00530"></a><span class="lineno">  530</span>&#160;<span class="comment">    */</span></div>

  602. <div class="line"><a name="l00531"></a><span class="lineno"><a class="line" href="structParameter.html#a2f79574998d34504e3a694163b4599a1">  531</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structParameter.html#a2f79574998d34504e3a694163b4599a1">unit</a>;</div>

  603. <div class="line"><a name="l00532"></a><span class="lineno">  532</span>&#160;<span class="comment"></span> </div>

  604. <div class="line"><a name="l00533"></a><span class="lineno">  533</span>&#160;<span class="comment">   /**</span></div>

  605. <div class="line"><a name="l00534"></a><span class="lineno">  534</span>&#160;<span class="comment">      An extensive description/comment about the parameter.</span></div>

  606. <div class="line"><a name="l00535"></a><span class="lineno">  535</span>&#160;<span class="comment">      @note This value is optional and only used for LV2.</span></div>

  607. <div class="line"><a name="l00536"></a><span class="lineno">  536</span>&#160;<span class="comment">    */</span></div>

  608. <div class="line"><a name="l00537"></a><span class="lineno"><a class="line" href="structParameter.html#a5aacdf5c58652cc6840ebfbe2a748d29">  537</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structParameter.html#a5aacdf5c58652cc6840ebfbe2a748d29">description</a>;</div>

  609. <div class="line"><a name="l00538"></a><span class="lineno">  538</span>&#160;<span class="comment"></span> </div>

  610. <div class="line"><a name="l00539"></a><span class="lineno">  539</span>&#160;<span class="comment">   /**</span></div>

  611. <div class="line"><a name="l00540"></a><span class="lineno">  540</span>&#160;<span class="comment">      Ranges of this parameter.@n</span></div>

  612. <div class="line"><a name="l00541"></a><span class="lineno">  541</span>&#160;<span class="comment">      The ranges describe the default, minimum and maximum values.</span></div>

  613. <div class="line"><a name="l00542"></a><span class="lineno">  542</span>&#160;<span class="comment">    */</span></div>

  614. <div class="line"><a name="l00543"></a><span class="lineno"><a class="line" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">  543</a></span>&#160;    <a class="code" href="structParameterRanges.html">ParameterRanges</a> <a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>;</div>

  615. <div class="line"><a name="l00544"></a><span class="lineno">  544</span>&#160;<span class="comment"></span> </div>

  616. <div class="line"><a name="l00545"></a><span class="lineno">  545</span>&#160;<span class="comment">   /**</span></div>

  617. <div class="line"><a name="l00546"></a><span class="lineno">  546</span>&#160;<span class="comment">      Enumeration values.@n</span></div>

  618. <div class="line"><a name="l00547"></a><span class="lineno">  547</span>&#160;<span class="comment">      Can be used to give meaning to parameter values, working as an enumeration.</span></div>

  619. <div class="line"><a name="l00548"></a><span class="lineno">  548</span>&#160;<span class="comment">    */</span></div>

  620. <div class="line"><a name="l00549"></a><span class="lineno"><a class="line" href="structParameter.html#ab94ec79aad8e8f6e4bc33d046f029358">  549</a></span>&#160;    <a class="code" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a> <a class="code" href="structParameter.html#ab94ec79aad8e8f6e4bc33d046f029358">enumValues</a>;</div>

  621. <div class="line"><a name="l00550"></a><span class="lineno">  550</span>&#160;<span class="comment"></span> </div>

  622. <div class="line"><a name="l00551"></a><span class="lineno">  551</span>&#160;<span class="comment">   /**</span></div>

  623. <div class="line"><a name="l00552"></a><span class="lineno">  552</span>&#160;<span class="comment">      Designation for this parameter.</span></div>

  624. <div class="line"><a name="l00553"></a><span class="lineno">  553</span>&#160;<span class="comment">    */</span></div>

  625. <div class="line"><a name="l00554"></a><span class="lineno"><a class="line" href="structParameter.html#a3bbf6f7d5ccea9a13504bd6ee3713986">  554</a></span>&#160;    <a class="code" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> <a class="code" href="structParameter.html#a3bbf6f7d5ccea9a13504bd6ee3713986">designation</a>;</div>

  626. <div class="line"><a name="l00555"></a><span class="lineno">  555</span>&#160;<span class="comment"></span> </div>

  627. <div class="line"><a name="l00556"></a><span class="lineno">  556</span>&#160;<span class="comment">   /**</span></div>

  628. <div class="line"><a name="l00557"></a><span class="lineno">  557</span>&#160;<span class="comment">      MIDI CC to use by default on this parameter.@n</span></div>

  629. <div class="line"><a name="l00558"></a><span class="lineno">  558</span>&#160;<span class="comment">      A value of 0 or 32 (bank change) is considered invalid.@n</span></div>

  630. <div class="line"><a name="l00559"></a><span class="lineno">  559</span>&#160;<span class="comment">      Must also be less or equal to 120.</span></div>

  631. <div class="line"><a name="l00560"></a><span class="lineno">  560</span>&#160;<span class="comment">      @note This value is only a hint! Hosts might map it automatically or completely ignore it.</span></div>

  632. <div class="line"><a name="l00561"></a><span class="lineno">  561</span>&#160;<span class="comment">    */</span></div>

  633. <div class="line"><a name="l00562"></a><span class="lineno"><a class="line" href="structParameter.html#a5389731e4cd95cac10af9aec9aa7b202">  562</a></span>&#160;    uint8_t <a class="code" href="structParameter.html#a5389731e4cd95cac10af9aec9aa7b202">midiCC</a>;</div>

  634. <div class="line"><a name="l00563"></a><span class="lineno">  563</span>&#160;<span class="comment"></span> </div>

  635. <div class="line"><a name="l00564"></a><span class="lineno">  564</span>&#160;<span class="comment">   /**</span></div>

  636. <div class="line"><a name="l00565"></a><span class="lineno">  565</span>&#160;<span class="comment">      The group id that this parameter belongs to.</span></div>

  637. <div class="line"><a name="l00566"></a><span class="lineno">  566</span>&#160;<span class="comment">      No group is assigned by default.</span></div>

  638. <div class="line"><a name="l00567"></a><span class="lineno">  567</span>&#160;<span class="comment"></span> </div>

  639. <div class="line"><a name="l00568"></a><span class="lineno">  568</span>&#160;<span class="comment">      You can use a group from PredefinedPortGroups or roll your own.@n</span></div>

  640. <div class="line"><a name="l00569"></a><span class="lineno">  569</span>&#160;<span class="comment">      When rolling your own port groups, you MUST start their group ids from 0 and they MUST be sequential.</span></div>

  641. <div class="line"><a name="l00570"></a><span class="lineno">  570</span>&#160;<span class="comment">      @see PortGroup, Plugin::initPortGroup</span></div>

  642. <div class="line"><a name="l00571"></a><span class="lineno">  571</span>&#160;<span class="comment">    */</span></div>

  643. <div class="line"><a name="l00572"></a><span class="lineno"><a class="line" href="structParameter.html#a72dd5af5c024bd86497a4a5d9c8c4f25">  572</a></span>&#160;    uint32_t <a class="code" href="structParameter.html#a72dd5af5c024bd86497a4a5d9c8c4f25">groupId</a>;</div>

  644. <div class="line"><a name="l00573"></a><span class="lineno">  573</span>&#160;<span class="comment"></span> </div>

  645. <div class="line"><a name="l00574"></a><span class="lineno">  574</span>&#160;<span class="comment">   /**</span></div>

  646. <div class="line"><a name="l00575"></a><span class="lineno">  575</span>&#160;<span class="comment">      Default constructor for a null parameter.</span></div>

  647. <div class="line"><a name="l00576"></a><span class="lineno">  576</span>&#160;<span class="comment">    */</span></div>

  648. <div class="line"><a name="l00577"></a><span class="lineno"><a class="line" href="structParameter.html#a12ced87d6d832deccb6c8ce2c8313b2e">  577</a></span>&#160;    <a class="code" href="structParameter.html#a12ced87d6d832deccb6c8ce2c8313b2e">Parameter</a>() noexcept</div>

  649. <div class="line"><a name="l00578"></a><span class="lineno">  578</span>&#160;        : <a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a>(0x0),</div>

  650. <div class="line"><a name="l00579"></a><span class="lineno">  579</span>&#160;          <a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>(),</div>

  651. <div class="line"><a name="l00580"></a><span class="lineno">  580</span>&#160;          <a class="code" href="structParameter.html#a1a47c46f3588b8a940d87fd4d69810ab">shortName</a>(),</div>

  652. <div class="line"><a name="l00581"></a><span class="lineno">  581</span>&#160;          <a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a>(),</div>

  653. <div class="line"><a name="l00582"></a><span class="lineno">  582</span>&#160;          <a class="code" href="structParameter.html#a2f79574998d34504e3a694163b4599a1">unit</a>(),</div>

  654. <div class="line"><a name="l00583"></a><span class="lineno">  583</span>&#160;          <a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>(),</div>

  655. <div class="line"><a name="l00584"></a><span class="lineno">  584</span>&#160;          <a class="code" href="structParameter.html#ab94ec79aad8e8f6e4bc33d046f029358">enumValues</a>(),</div>

  656. <div class="line"><a name="l00585"></a><span class="lineno">  585</span>&#160;          <a class="code" href="structParameter.html#a3bbf6f7d5ccea9a13504bd6ee3713986">designation</a>(<a class="code" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a>),</div>

  657. <div class="line"><a name="l00586"></a><span class="lineno">  586</span>&#160;          <a class="code" href="structParameter.html#a5389731e4cd95cac10af9aec9aa7b202">midiCC</a>(0),</div>

  658. <div class="line"><a name="l00587"></a><span class="lineno">  587</span>&#160;          <a class="code" href="structParameter.html#a72dd5af5c024bd86497a4a5d9c8c4f25">groupId</a>(<a class="code" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaea27aed9948a2aaf4978941c96df3932">kPortGroupNone</a>) {}</div>

  659. <div class="line"><a name="l00588"></a><span class="lineno">  588</span>&#160;<span class="comment"></span> </div>

  660. <div class="line"><a name="l00589"></a><span class="lineno">  589</span>&#160;<span class="comment">   /**</span></div>

  661. <div class="line"><a name="l00590"></a><span class="lineno">  590</span>&#160;<span class="comment">      Constructor using custom values.</span></div>

  662. <div class="line"><a name="l00591"></a><span class="lineno">  591</span>&#160;<span class="comment">    */</span></div>

  663. <div class="line"><a name="l00592"></a><span class="lineno"><a class="line" href="structParameter.html#af0c5eeebedfe0058775a7ff4d904b6ab">  592</a></span>&#160;    <a class="code" href="structParameter.html#af0c5eeebedfe0058775a7ff4d904b6ab">Parameter</a>(uint32_t h, <span class="keyword">const</span> <span class="keywordtype">char</span>* n, <span class="keyword">const</span> <span class="keywordtype">char</span>* s, <span class="keyword">const</span> <span class="keywordtype">char</span>* u, <span class="keywordtype">float</span> def, <span class="keywordtype">float</span> min, <span class="keywordtype">float</span> max) noexcept</div>

  664. <div class="line"><a name="l00593"></a><span class="lineno">  593</span>&#160;        : <a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a>(h),</div>

  665. <div class="line"><a name="l00594"></a><span class="lineno">  594</span>&#160;          <a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>(n),</div>

  666. <div class="line"><a name="l00595"></a><span class="lineno">  595</span>&#160;          <a class="code" href="structParameter.html#a1a47c46f3588b8a940d87fd4d69810ab">shortName</a>(),</div>

  667. <div class="line"><a name="l00596"></a><span class="lineno">  596</span>&#160;          <a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a>(s),</div>

  668. <div class="line"><a name="l00597"></a><span class="lineno">  597</span>&#160;          <a class="code" href="structParameter.html#a2f79574998d34504e3a694163b4599a1">unit</a>(u),</div>

  669. <div class="line"><a name="l00598"></a><span class="lineno">  598</span>&#160;          <a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>(def, min, max),</div>

  670. <div class="line"><a name="l00599"></a><span class="lineno">  599</span>&#160;          <a class="code" href="structParameter.html#ab94ec79aad8e8f6e4bc33d046f029358">enumValues</a>(),</div>

  671. <div class="line"><a name="l00600"></a><span class="lineno">  600</span>&#160;          <a class="code" href="structParameter.html#a3bbf6f7d5ccea9a13504bd6ee3713986">designation</a>(<a class="code" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a>),</div>

  672. <div class="line"><a name="l00601"></a><span class="lineno">  601</span>&#160;          <a class="code" href="structParameter.html#a5389731e4cd95cac10af9aec9aa7b202">midiCC</a>(0),</div>

  673. <div class="line"><a name="l00602"></a><span class="lineno">  602</span>&#160;          <a class="code" href="structParameter.html#a72dd5af5c024bd86497a4a5d9c8c4f25">groupId</a>(<a class="code" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaea27aed9948a2aaf4978941c96df3932">kPortGroupNone</a>) {}</div>

  674. <div class="line"><a name="l00603"></a><span class="lineno">  603</span>&#160;<span class="comment"></span> </div>

  675. <div class="line"><a name="l00604"></a><span class="lineno">  604</span>&#160;<span class="comment">   /**</span></div>

  676. <div class="line"><a name="l00605"></a><span class="lineno">  605</span>&#160;<span class="comment">      Initialize a parameter for a specific designation.</span></div>

  677. <div class="line"><a name="l00606"></a><span class="lineno">  606</span>&#160;<span class="comment">    */</span></div>

  678. <div class="line"><a name="l00607"></a><span class="lineno"><a class="line" href="structParameter.html#ad959d31bcfaa056908406bbf37c134bf">  607</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structParameter.html#ad959d31bcfaa056908406bbf37c134bf">initDesignation</a>(<a class="code" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> d) noexcept</div>

  679. <div class="line"><a name="l00608"></a><span class="lineno">  608</span>&#160;    {</div>

  680. <div class="line"><a name="l00609"></a><span class="lineno">  609</span>&#160;        <a class="code" href="structParameter.html#a3bbf6f7d5ccea9a13504bd6ee3713986">designation</a> = d;</div>

  681. <div class="line"><a name="l00610"></a><span class="lineno">  610</span>&#160; </div>

  682. <div class="line"><a name="l00611"></a><span class="lineno">  611</span>&#160;        <span class="keywordflow">switch</span> (d)</div>

  683. <div class="line"><a name="l00612"></a><span class="lineno">  612</span>&#160;        {</div>

  684. <div class="line"><a name="l00613"></a><span class="lineno">  613</span>&#160;        <span class="keywordflow">case</span> <a class="code" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a>:</div>

  685. <div class="line"><a name="l00614"></a><span class="lineno">  614</span>&#160;            <span class="keywordflow">break</span>;</div>

  686. <div class="line"><a name="l00615"></a><span class="lineno">  615</span>&#160;        <span class="keywordflow">case</span> <a class="code" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">kParameterDesignationBypass</a>:</div>

  687. <div class="line"><a name="l00616"></a><span class="lineno">  616</span>&#160;            <a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a>      = <a class="code" href="group__ParameterHints.html#ga6d39267b105c2d8dfc82a810c5e8a061">kParameterIsAutomatable</a>|<a class="code" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a>|<a class="code" href="group__ParameterHints.html#ga76a82c93efe6ad728c9f0cb4ef33a2b9">kParameterIsInteger</a>;</div>

  688. <div class="line"><a name="l00617"></a><span class="lineno">  617</span>&#160;            <a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>       = <span class="stringliteral">&quot;Bypass&quot;</span>;</div>

  689. <div class="line"><a name="l00618"></a><span class="lineno">  618</span>&#160;            <a class="code" href="structParameter.html#a1a47c46f3588b8a940d87fd4d69810ab">shortName</a>  = <span class="stringliteral">&quot;Bypass&quot;</span>;</div>

  690. <div class="line"><a name="l00619"></a><span class="lineno">  619</span>&#160;            <a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a>     = <span class="stringliteral">&quot;dpf_bypass&quot;</span>;</div>

  691. <div class="line"><a name="l00620"></a><span class="lineno">  620</span>&#160;            <a class="code" href="structParameter.html#a2f79574998d34504e3a694163b4599a1">unit</a>       = <span class="stringliteral">&quot;&quot;</span>;</div>

  692. <div class="line"><a name="l00621"></a><span class="lineno">  621</span>&#160;            <a class="code" href="structParameter.html#a5389731e4cd95cac10af9aec9aa7b202">midiCC</a>     = 0;</div>

  693. <div class="line"><a name="l00622"></a><span class="lineno">  622</span>&#160;            <a class="code" href="structParameter.html#a72dd5af5c024bd86497a4a5d9c8c4f25">groupId</a>    = <a class="code" href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaea27aed9948a2aaf4978941c96df3932">kPortGroupNone</a>;</div>

  694. <div class="line"><a name="l00623"></a><span class="lineno">  623</span>&#160;            <a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a> = 0.0f;</div>

  695. <div class="line"><a name="l00624"></a><span class="lineno">  624</span>&#160;            <a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a> = 0.0f;</div>

  696. <div class="line"><a name="l00625"></a><span class="lineno">  625</span>&#160;            <a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>.<a class="code" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a> = 1.0f;</div>

  697. <div class="line"><a name="l00626"></a><span class="lineno">  626</span>&#160;            <span class="keywordflow">break</span>;</div>

  698. <div class="line"><a name="l00627"></a><span class="lineno">  627</span>&#160;        }</div>

  699. <div class="line"><a name="l00628"></a><span class="lineno">  628</span>&#160;    }</div>

  700. <div class="line"><a name="l00629"></a><span class="lineno">  629</span>&#160;};</div>

  701. <div class="line"><a name="l00630"></a><span class="lineno">  630</span>&#160;<span class="comment"></span> </div>

  702. <div class="line"><a name="l00631"></a><span class="lineno">  631</span>&#160;<span class="comment">/**</span></div>

  703. <div class="line"><a name="l00632"></a><span class="lineno">  632</span>&#160;<span class="comment">   Port Group.@n</span></div>

  704. <div class="line"><a name="l00633"></a><span class="lineno">  633</span>&#160;<span class="comment">   Allows to group together audio/cv ports or parameters.</span></div>

  705. <div class="line"><a name="l00634"></a><span class="lineno">  634</span>&#160;<span class="comment"></span> </div>

  706. <div class="line"><a name="l00635"></a><span class="lineno">  635</span>&#160;<span class="comment">   Each unique group MUST have an unique symbol and a name.</span></div>

  707. <div class="line"><a name="l00636"></a><span class="lineno">  636</span>&#160;<span class="comment">   A group can be applied to both inputs and outputs (at the same time).</span></div>

  708. <div class="line"><a name="l00637"></a><span class="lineno">  637</span>&#160;<span class="comment">   The same group cannot be used in audio ports and parameters.</span></div>

  709. <div class="line"><a name="l00638"></a><span class="lineno">  638</span>&#160;<span class="comment"></span> </div>

  710. <div class="line"><a name="l00639"></a><span class="lineno">  639</span>&#160;<span class="comment">   When both audio and parameter groups are used, audio groups MUST be defined first.</span></div>

  711. <div class="line"><a name="l00640"></a><span class="lineno">  640</span>&#160;<span class="comment">   That is, group indexes start with audio ports, then parameters.</span></div>

  712. <div class="line"><a name="l00641"></a><span class="lineno">  641</span>&#160;<span class="comment"></span> </div>

  713. <div class="line"><a name="l00642"></a><span class="lineno">  642</span>&#160;<span class="comment">   An audio port group logically combines ports which should be considered part of the same stream.@n</span></div>

  714. <div class="line"><a name="l00643"></a><span class="lineno">  643</span>&#160;<span class="comment">   For example, two audio ports in a group may form a stereo stream.</span></div>

  715. <div class="line"><a name="l00644"></a><span class="lineno">  644</span>&#160;<span class="comment"></span> </div>

  716. <div class="line"><a name="l00645"></a><span class="lineno">  645</span>&#160;<span class="comment">   A parameter group provides meta-data to the host to indicate that some parameters belong together.</span></div>

  717. <div class="line"><a name="l00646"></a><span class="lineno">  646</span>&#160;<span class="comment"></span> </div>

  718. <div class="line"><a name="l00647"></a><span class="lineno">  647</span>&#160;<span class="comment">   The use of port groups is completely optional.</span></div>

  719. <div class="line"><a name="l00648"></a><span class="lineno">  648</span>&#160;<span class="comment"></span> </div>

  720. <div class="line"><a name="l00649"></a><span class="lineno">  649</span>&#160;<span class="comment">   @see Plugin::initPortGroup, AudioPort::group, Parameter::group</span></div>

  721. <div class="line"><a name="l00650"></a><span class="lineno">  650</span>&#160;<span class="comment"> */</span></div>

  722. <div class="line"><a name="l00651"></a><span class="lineno"><a class="line" href="structPortGroup.html">  651</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structPortGroup.html">PortGroup</a> {<span class="comment"></span></div>

  723. <div class="line"><a name="l00652"></a><span class="lineno">  652</span>&#160;<span class="comment">   /**</span></div>

  724. <div class="line"><a name="l00653"></a><span class="lineno">  653</span>&#160;<span class="comment">      The name of this port group.@n</span></div>

  725. <div class="line"><a name="l00654"></a><span class="lineno">  654</span>&#160;<span class="comment">      A port group name can contain any character, but hosts might have a hard time with non-ascii ones.@n</span></div>

  726. <div class="line"><a name="l00655"></a><span class="lineno">  655</span>&#160;<span class="comment">      The name doesn&#39;t have to be unique within a plugin instance, but it&#39;s recommended.</span></div>

  727. <div class="line"><a name="l00656"></a><span class="lineno">  656</span>&#160;<span class="comment">    */</span></div>

  728. <div class="line"><a name="l00657"></a><span class="lineno"><a class="line" href="structPortGroup.html#af3ab9eaf5eb1ad8165fc43b4518d2c5b">  657</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structPortGroup.html#af3ab9eaf5eb1ad8165fc43b4518d2c5b">name</a>;</div>

  729. <div class="line"><a name="l00658"></a><span class="lineno">  658</span>&#160;<span class="comment"></span> </div>

  730. <div class="line"><a name="l00659"></a><span class="lineno">  659</span>&#160;<span class="comment">   /**</span></div>

  731. <div class="line"><a name="l00660"></a><span class="lineno">  660</span>&#160;<span class="comment">      The symbol of this port group.@n</span></div>

  732. <div class="line"><a name="l00661"></a><span class="lineno">  661</span>&#160;<span class="comment">      A port group symbol is a short restricted name used as a machine and human readable identifier.@n</span></div>

  733. <div class="line"><a name="l00662"></a><span class="lineno">  662</span>&#160;<span class="comment">      The first character must be one of _, a-z or A-Z and subsequent characters can be from _, a-z, A-Z and 0-9.</span></div>

  734. <div class="line"><a name="l00663"></a><span class="lineno">  663</span>&#160;<span class="comment">      @note Port group symbols MUST be unique within a plugin instance.</span></div>

  735. <div class="line"><a name="l00664"></a><span class="lineno">  664</span>&#160;<span class="comment">    */</span></div>

  736. <div class="line"><a name="l00665"></a><span class="lineno"><a class="line" href="structPortGroup.html#ae42f849c9f34d940f6fdcfc9abd65d4f">  665</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structPortGroup.html#ae42f849c9f34d940f6fdcfc9abd65d4f">symbol</a>;</div>

  737. <div class="line"><a name="l00666"></a><span class="lineno">  666</span>&#160;};</div>

  738. <div class="line"><a name="l00667"></a><span class="lineno">  667</span>&#160;<span class="comment"></span> </div>

  739. <div class="line"><a name="l00668"></a><span class="lineno">  668</span>&#160;<span class="comment">/**</span></div>

  740. <div class="line"><a name="l00669"></a><span class="lineno">  669</span>&#160;<span class="comment">   State.</span></div>

  741. <div class="line"><a name="l00670"></a><span class="lineno">  670</span>&#160;<span class="comment"></span> </div>

  742. <div class="line"><a name="l00671"></a><span class="lineno">  671</span>&#160;<span class="comment">   In DPF states refer to key:value string pairs, used to store arbitrary non-parameter data.@n</span></div>

  743. <div class="line"><a name="l00672"></a><span class="lineno">  672</span>&#160;<span class="comment">   By default states are completely internal to the plugin and not visible by the host.@n</span></div>

  744. <div class="line"><a name="l00673"></a><span class="lineno">  673</span>&#160;<span class="comment">   Flags can be set to allow hosts to see and/or change them.</span></div>

  745. <div class="line"><a name="l00674"></a><span class="lineno">  674</span>&#160;<span class="comment"></span> </div>

  746. <div class="line"><a name="l00675"></a><span class="lineno">  675</span>&#160;<span class="comment">   TODO API under construction</span></div>

  747. <div class="line"><a name="l00676"></a><span class="lineno">  676</span>&#160;<span class="comment"> */</span></div>

  748. <div class="line"><a name="l00677"></a><span class="lineno"><a class="line" href="structState.html">  677</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structState.html">State</a> {<span class="comment"></span></div>

  749. <div class="line"><a name="l00678"></a><span class="lineno">  678</span>&#160;<span class="comment">   /**</span></div>

  750. <div class="line"><a name="l00679"></a><span class="lineno">  679</span>&#160;<span class="comment">      Hints describing this state.</span></div>

  751. <div class="line"><a name="l00680"></a><span class="lineno">  680</span>&#160;<span class="comment">      @note Changing these hints can break compatibility with previously saved data.</span></div>

  752. <div class="line"><a name="l00681"></a><span class="lineno">  681</span>&#160;<span class="comment">      @see StateHints</span></div>

  753. <div class="line"><a name="l00682"></a><span class="lineno">  682</span>&#160;<span class="comment">    */</span></div>

  754. <div class="line"><a name="l00683"></a><span class="lineno"><a class="line" href="structState.html#adaa34a729d4e8c0e2e6434b4c4f55fab">  683</a></span>&#160;    uint32_t <a class="code" href="structState.html#adaa34a729d4e8c0e2e6434b4c4f55fab">hints</a>;</div>

  755. <div class="line"><a name="l00684"></a><span class="lineno">  684</span>&#160;<span class="comment"></span> </div>

  756. <div class="line"><a name="l00685"></a><span class="lineno">  685</span>&#160;<span class="comment">   /**</span></div>

  757. <div class="line"><a name="l00686"></a><span class="lineno">  686</span>&#160;<span class="comment">      The key or &quot;symbol&quot; of this state.@n</span></div>

  758. <div class="line"><a name="l00687"></a><span class="lineno">  687</span>&#160;<span class="comment">      A state key is a short restricted name used as a machine and human readable identifier.</span></div>

  759. <div class="line"><a name="l00688"></a><span class="lineno">  688</span>&#160;<span class="comment">      @note State keys MUST be unique within a plugin instance.</span></div>

  760. <div class="line"><a name="l00689"></a><span class="lineno">  689</span>&#160;<span class="comment">      TODO define rules for allowed characters, must be usable as URI non-encoded parameters</span></div>

  761. <div class="line"><a name="l00690"></a><span class="lineno">  690</span>&#160;<span class="comment">    */</span></div>

  762. <div class="line"><a name="l00691"></a><span class="lineno"><a class="line" href="structState.html#a62474faa50839c3d35fe31b3bf7e39b0">  691</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structState.html#a62474faa50839c3d35fe31b3bf7e39b0">key</a>;</div>

  763. <div class="line"><a name="l00692"></a><span class="lineno">  692</span>&#160;<span class="comment"></span> </div>

  764. <div class="line"><a name="l00693"></a><span class="lineno">  693</span>&#160;<span class="comment">   /**</span></div>

  765. <div class="line"><a name="l00694"></a><span class="lineno">  694</span>&#160;<span class="comment">      The default value of this state.@n</span></div>

  766. <div class="line"><a name="l00695"></a><span class="lineno">  695</span>&#160;<span class="comment">      Can be left empty if considered a valid initial state.</span></div>

  767. <div class="line"><a name="l00696"></a><span class="lineno">  696</span>&#160;<span class="comment">    */</span></div>

  768. <div class="line"><a name="l00697"></a><span class="lineno"><a class="line" href="structState.html#af925c53b4676ed45b8b813424e626c3e">  697</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structState.html#af925c53b4676ed45b8b813424e626c3e">defaultValue</a>;</div>

  769. <div class="line"><a name="l00698"></a><span class="lineno">  698</span>&#160;<span class="comment"></span> </div>

  770. <div class="line"><a name="l00699"></a><span class="lineno">  699</span>&#160;<span class="comment">   /**</span></div>

  771. <div class="line"><a name="l00700"></a><span class="lineno">  700</span>&#160;<span class="comment">      String representation of this state.</span></div>

  772. <div class="line"><a name="l00701"></a><span class="lineno">  701</span>&#160;<span class="comment">    */</span></div>

  773. <div class="line"><a name="l00702"></a><span class="lineno"><a class="line" href="structState.html#ad29e7e5a872defd5521d69e47b1e9df5">  702</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structState.html#ad29e7e5a872defd5521d69e47b1e9df5">label</a>;</div>

  774. <div class="line"><a name="l00703"></a><span class="lineno">  703</span>&#160;<span class="comment"></span> </div>

  775. <div class="line"><a name="l00704"></a><span class="lineno">  704</span>&#160;<span class="comment">   /**</span></div>

  776. <div class="line"><a name="l00705"></a><span class="lineno">  705</span>&#160;<span class="comment">      An extensive description/comment about this state.</span></div>

  777. <div class="line"><a name="l00706"></a><span class="lineno">  706</span>&#160;<span class="comment">      @note This value is optional and only used for LV2.</span></div>

  778. <div class="line"><a name="l00707"></a><span class="lineno">  707</span>&#160;<span class="comment">    */</span></div>

  779. <div class="line"><a name="l00708"></a><span class="lineno"><a class="line" href="structState.html#afb8bee553cefbfe2a495fc391a5f0243">  708</a></span>&#160;    <a class="code" href="classString.html">String</a> <a class="code" href="structState.html#afb8bee553cefbfe2a495fc391a5f0243">description</a>;</div>

  780. <div class="line"><a name="l00709"></a><span class="lineno">  709</span>&#160;};</div>

  781. <div class="line"><a name="l00710"></a><span class="lineno">  710</span>&#160;<span class="comment"></span> </div>

  782. <div class="line"><a name="l00711"></a><span class="lineno">  711</span>&#160;<span class="comment">/**</span></div>

  783. <div class="line"><a name="l00712"></a><span class="lineno">  712</span>&#160;<span class="comment">   MIDI event.</span></div>

  784. <div class="line"><a name="l00713"></a><span class="lineno">  713</span>&#160;<span class="comment"> */</span></div>

  785. <div class="line"><a name="l00714"></a><span class="lineno"><a class="line" href="structMidiEvent.html">  714</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structMidiEvent.html">MidiEvent</a> {<span class="comment"></span></div>

  786. <div class="line"><a name="l00715"></a><span class="lineno">  715</span>&#160;<span class="comment">   /**</span></div>

  787. <div class="line"><a name="l00716"></a><span class="lineno">  716</span>&#160;<span class="comment">      Size of internal data.</span></div>

  788. <div class="line"><a name="l00717"></a><span class="lineno">  717</span>&#160;<span class="comment">    */</span></div>

  789. <div class="line"><a name="l00718"></a><span class="lineno"><a class="line" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">  718</a></span>&#160;    <span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">kDataSize</a> = 4;</div>

  790. <div class="line"><a name="l00719"></a><span class="lineno">  719</span>&#160;<span class="comment"></span> </div>

  791. <div class="line"><a name="l00720"></a><span class="lineno">  720</span>&#160;<span class="comment">   /**</span></div>

  792. <div class="line"><a name="l00721"></a><span class="lineno">  721</span>&#160;<span class="comment">      Time offset in frames.</span></div>

  793. <div class="line"><a name="l00722"></a><span class="lineno">  722</span>&#160;<span class="comment">    */</span></div>

  794. <div class="line"><a name="l00723"></a><span class="lineno"><a class="line" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">  723</a></span>&#160;    uint32_t <a class="code" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">frame</a>;</div>

  795. <div class="line"><a name="l00724"></a><span class="lineno">  724</span>&#160;<span class="comment"></span> </div>

  796. <div class="line"><a name="l00725"></a><span class="lineno">  725</span>&#160;<span class="comment">   /**</span></div>

  797. <div class="line"><a name="l00726"></a><span class="lineno">  726</span>&#160;<span class="comment">      Number of bytes used.</span></div>

  798. <div class="line"><a name="l00727"></a><span class="lineno">  727</span>&#160;<span class="comment">    */</span></div>

  799. <div class="line"><a name="l00728"></a><span class="lineno"><a class="line" href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e">  728</a></span>&#160;    uint32_t <a class="code" href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e">size</a>;</div>

  800. <div class="line"><a name="l00729"></a><span class="lineno">  729</span>&#160;<span class="comment"></span> </div>

  801. <div class="line"><a name="l00730"></a><span class="lineno">  730</span>&#160;<span class="comment">   /**</span></div>

  802. <div class="line"><a name="l00731"></a><span class="lineno">  731</span>&#160;<span class="comment">      MIDI data.@n</span></div>

  803. <div class="line"><a name="l00732"></a><span class="lineno">  732</span>&#160;<span class="comment">      If size &gt; kDataSize, dataExt is used (otherwise null).</span></div>

  804. <div class="line"><a name="l00733"></a><span class="lineno">  733</span>&#160;<span class="comment"></span> </div>

  805. <div class="line"><a name="l00734"></a><span class="lineno">  734</span>&#160;<span class="comment">      When dataExt is used, the event holder is responsible for</span></div>

  806. <div class="line"><a name="l00735"></a><span class="lineno">  735</span>&#160;<span class="comment">      keeping the pointer valid during the entirety of the run function.</span></div>

  807. <div class="line"><a name="l00736"></a><span class="lineno">  736</span>&#160;<span class="comment">    */</span></div>

  808. <div class="line"><a name="l00737"></a><span class="lineno"><a class="line" href="structMidiEvent.html#aba54410d44eef48c10516f29452ef3a9">  737</a></span>&#160;    uint8_t        <a class="code" href="structMidiEvent.html#aba54410d44eef48c10516f29452ef3a9">data</a>[<a class="code" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">kDataSize</a>];</div>

  809. <div class="line"><a name="l00738"></a><span class="lineno">  738</span>&#160;    <span class="keyword">const</span> uint8_t* dataExt;</div>

  810. <div class="line"><a name="l00739"></a><span class="lineno">  739</span>&#160;};</div>

  811. <div class="line"><a name="l00740"></a><span class="lineno">  740</span>&#160;<span class="comment"></span> </div>

  812. <div class="line"><a name="l00741"></a><span class="lineno">  741</span>&#160;<span class="comment">/**</span></div>

  813. <div class="line"><a name="l00742"></a><span class="lineno">  742</span>&#160;<span class="comment">   Time position.@n</span></div>

  814. <div class="line"><a name="l00743"></a><span class="lineno">  743</span>&#160;<span class="comment">   The @a playing and @a frame values are always valid.@n</span></div>

  815. <div class="line"><a name="l00744"></a><span class="lineno">  744</span>&#160;<span class="comment">   BBT values are only valid when @a bbt.valid is true.</span></div>

  816. <div class="line"><a name="l00745"></a><span class="lineno">  745</span>&#160;<span class="comment"></span> </div>

  817. <div class="line"><a name="l00746"></a><span class="lineno">  746</span>&#160;<span class="comment">   This struct is inspired by the [JACK Transport API](https://jackaudio.org/api/structjack__position__t.html).</span></div>

  818. <div class="line"><a name="l00747"></a><span class="lineno">  747</span>&#160;<span class="comment"> */</span></div>

  819. <div class="line"><a name="l00748"></a><span class="lineno"><a class="line" href="structTimePosition.html">  748</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structTimePosition.html">TimePosition</a> {<span class="comment"></span></div>

  820. <div class="line"><a name="l00749"></a><span class="lineno">  749</span>&#160;<span class="comment">   /**</span></div>

  821. <div class="line"><a name="l00750"></a><span class="lineno">  750</span>&#160;<span class="comment">      Wherever the host transport is playing/rolling.</span></div>

  822. <div class="line"><a name="l00751"></a><span class="lineno">  751</span>&#160;<span class="comment">    */</span></div>

  823. <div class="line"><a name="l00752"></a><span class="lineno"><a class="line" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574">  752</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574">playing</a>;</div>

  824. <div class="line"><a name="l00753"></a><span class="lineno">  753</span>&#160;<span class="comment"></span> </div>

  825. <div class="line"><a name="l00754"></a><span class="lineno">  754</span>&#160;<span class="comment">   /**</span></div>

  826. <div class="line"><a name="l00755"></a><span class="lineno">  755</span>&#160;<span class="comment">      Current host transport position in frames.</span></div>

  827. <div class="line"><a name="l00756"></a><span class="lineno">  756</span>&#160;<span class="comment">      @note This value is not always monotonic,</span></div>

  828. <div class="line"><a name="l00757"></a><span class="lineno">  757</span>&#160;<span class="comment">            with some plugin hosts assigning it based on a source that can accumulate rounding errors.</span></div>

  829. <div class="line"><a name="l00758"></a><span class="lineno">  758</span>&#160;<span class="comment">    */</span></div>

  830. <div class="line"><a name="l00759"></a><span class="lineno"><a class="line" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b">  759</a></span>&#160;    uint64_t <a class="code" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b">frame</a>;</div>

  831. <div class="line"><a name="l00760"></a><span class="lineno">  760</span>&#160;<span class="comment"></span> </div>

  832. <div class="line"><a name="l00761"></a><span class="lineno">  761</span>&#160;<span class="comment">   /**</span></div>

  833. <div class="line"><a name="l00762"></a><span class="lineno">  762</span>&#160;<span class="comment">      Bar-Beat-Tick time position.</span></div>

  834. <div class="line"><a name="l00763"></a><span class="lineno">  763</span>&#160;<span class="comment">    */</span></div>

  835. <div class="line"><a name="l00764"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html">  764</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structTimePosition_1_1BarBeatTick.html">BarBeatTick</a> {<span class="comment"></span></div>

  836. <div class="line"><a name="l00765"></a><span class="lineno">  765</span>&#160;<span class="comment">       /**</span></div>

  837. <div class="line"><a name="l00766"></a><span class="lineno">  766</span>&#160;<span class="comment">          Wherever the host transport is using BBT.@n</span></div>

  838. <div class="line"><a name="l00767"></a><span class="lineno">  767</span>&#160;<span class="comment">          If false you must not read from this struct.</span></div>

  839. <div class="line"><a name="l00768"></a><span class="lineno">  768</span>&#160;<span class="comment">        */</span></div>

  840. <div class="line"><a name="l00769"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e">  769</a></span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e">valid</a>;</div>

  841. <div class="line"><a name="l00770"></a><span class="lineno">  770</span>&#160;<span class="comment"></span> </div>

  842. <div class="line"><a name="l00771"></a><span class="lineno">  771</span>&#160;<span class="comment">       /**</span></div>

  843. <div class="line"><a name="l00772"></a><span class="lineno">  772</span>&#160;<span class="comment">          Current bar.@n</span></div>

  844. <div class="line"><a name="l00773"></a><span class="lineno">  773</span>&#160;<span class="comment">          Should always be &gt; 0.@n</span></div>

  845. <div class="line"><a name="l00774"></a><span class="lineno">  774</span>&#160;<span class="comment">          The first bar is bar &#39;1&#39;.</span></div>

  846. <div class="line"><a name="l00775"></a><span class="lineno">  775</span>&#160;<span class="comment">        */</span></div>

  847. <div class="line"><a name="l00776"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21">  776</a></span>&#160;        int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21">bar</a>;</div>

  848. <div class="line"><a name="l00777"></a><span class="lineno">  777</span>&#160;<span class="comment"></span> </div>

  849. <div class="line"><a name="l00778"></a><span class="lineno">  778</span>&#160;<span class="comment">       /**</span></div>

  850. <div class="line"><a name="l00779"></a><span class="lineno">  779</span>&#160;<span class="comment">          Current beat within bar.@n</span></div>

  851. <div class="line"><a name="l00780"></a><span class="lineno">  780</span>&#160;<span class="comment">          Should always be &gt; 0 and &lt;= @a beatsPerBar.@n</span></div>

  852. <div class="line"><a name="l00781"></a><span class="lineno">  781</span>&#160;<span class="comment">          The first beat is beat &#39;1&#39;.</span></div>

  853. <div class="line"><a name="l00782"></a><span class="lineno">  782</span>&#160;<span class="comment">        */</span></div>

  854. <div class="line"><a name="l00783"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c">  783</a></span>&#160;        int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c">beat</a>;</div>

  855. <div class="line"><a name="l00784"></a><span class="lineno">  784</span>&#160;<span class="comment"></span> </div>

  856. <div class="line"><a name="l00785"></a><span class="lineno">  785</span>&#160;<span class="comment">       /**</span></div>

  857. <div class="line"><a name="l00786"></a><span class="lineno">  786</span>&#160;<span class="comment">          Current tick within beat.@n</span></div>

  858. <div class="line"><a name="l00787"></a><span class="lineno">  787</span>&#160;<span class="comment">          Should always be &gt;= 0 and &lt; @a ticksPerBeat.@n</span></div>

  859. <div class="line"><a name="l00788"></a><span class="lineno">  788</span>&#160;<span class="comment">          The first tick is tick &#39;0&#39;.</span></div>

  860. <div class="line"><a name="l00789"></a><span class="lineno">  789</span>&#160;<span class="comment">          @note Fraction part of tick is only available on some plugin formats.</span></div>

  861. <div class="line"><a name="l00790"></a><span class="lineno">  790</span>&#160;<span class="comment">        */</span></div>

  862. <div class="line"><a name="l00791"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#aecb8a1a98db84c6d03c39278f86a0324">  791</a></span>&#160;        <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#aecb8a1a98db84c6d03c39278f86a0324">tick</a>;</div>

  863. <div class="line"><a name="l00792"></a><span class="lineno">  792</span>&#160;<span class="comment"></span> </div>

  864. <div class="line"><a name="l00793"></a><span class="lineno">  793</span>&#160;<span class="comment">       /**</span></div>

  865. <div class="line"><a name="l00794"></a><span class="lineno">  794</span>&#160;<span class="comment">          Number of ticks that have elapsed between frame 0 and the first beat of the current measure.</span></div>

  866. <div class="line"><a name="l00795"></a><span class="lineno">  795</span>&#160;<span class="comment">        */</span></div>

  867. <div class="line"><a name="l00796"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">  796</a></span>&#160;        <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">barStartTick</a>;</div>

  868. <div class="line"><a name="l00797"></a><span class="lineno">  797</span>&#160;<span class="comment"></span> </div>

  869. <div class="line"><a name="l00798"></a><span class="lineno">  798</span>&#160;<span class="comment">       /**</span></div>

  870. <div class="line"><a name="l00799"></a><span class="lineno">  799</span>&#160;<span class="comment">          Time signature &quot;numerator&quot;.</span></div>

  871. <div class="line"><a name="l00800"></a><span class="lineno">  800</span>&#160;<span class="comment">        */</span></div>

  872. <div class="line"><a name="l00801"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">  801</a></span>&#160;        <span class="keywordtype">float</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">beatsPerBar</a>;</div>

  873. <div class="line"><a name="l00802"></a><span class="lineno">  802</span>&#160;<span class="comment"></span> </div>

  874. <div class="line"><a name="l00803"></a><span class="lineno">  803</span>&#160;<span class="comment">       /**</span></div>

  875. <div class="line"><a name="l00804"></a><span class="lineno">  804</span>&#160;<span class="comment">          Time signature &quot;denominator&quot;.</span></div>

  876. <div class="line"><a name="l00805"></a><span class="lineno">  805</span>&#160;<span class="comment">        */</span></div>

  877. <div class="line"><a name="l00806"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">  806</a></span>&#160;        <span class="keywordtype">float</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">beatType</a>;</div>

  878. <div class="line"><a name="l00807"></a><span class="lineno">  807</span>&#160;<span class="comment"></span> </div>

  879. <div class="line"><a name="l00808"></a><span class="lineno">  808</span>&#160;<span class="comment">       /**</span></div>

  880. <div class="line"><a name="l00809"></a><span class="lineno">  809</span>&#160;<span class="comment">          Number of ticks within a beat.@n</span></div>

  881. <div class="line"><a name="l00810"></a><span class="lineno">  810</span>&#160;<span class="comment">          Usually a moderately large integer with many denominators, such as 1920.0.</span></div>

  882. <div class="line"><a name="l00811"></a><span class="lineno">  811</span>&#160;<span class="comment">        */</span></div>

  883. <div class="line"><a name="l00812"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">  812</a></span>&#160;        <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">ticksPerBeat</a>;</div>

  884. <div class="line"><a name="l00813"></a><span class="lineno">  813</span>&#160;<span class="comment"></span> </div>

  885. <div class="line"><a name="l00814"></a><span class="lineno">  814</span>&#160;<span class="comment">       /**</span></div>

  886. <div class="line"><a name="l00815"></a><span class="lineno">  815</span>&#160;<span class="comment">          Number of beats per minute.</span></div>

  887. <div class="line"><a name="l00816"></a><span class="lineno">  816</span>&#160;<span class="comment">        */</span></div>

  888. <div class="line"><a name="l00817"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">  817</a></span>&#160;        <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">beatsPerMinute</a>;</div>

  889. <div class="line"><a name="l00818"></a><span class="lineno">  818</span>&#160;<span class="comment"></span> </div>

  890. <div class="line"><a name="l00819"></a><span class="lineno">  819</span>&#160;<span class="comment">       /**</span></div>

  891. <div class="line"><a name="l00820"></a><span class="lineno">  820</span>&#160;<span class="comment">          Default constructor for a null BBT time position.</span></div>

  892. <div class="line"><a name="l00821"></a><span class="lineno">  821</span>&#160;<span class="comment">        */</span></div>

  893. <div class="line"><a name="l00822"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef">  822</a></span>&#160;        <a class="code" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef">BarBeatTick</a>() noexcept</div>

  894. <div class="line"><a name="l00823"></a><span class="lineno">  823</span>&#160;            : <a class="code" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e">valid</a>(false),</div>

  895. <div class="line"><a name="l00824"></a><span class="lineno">  824</span>&#160;              <a class="code" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21">bar</a>(0),</div>

  896. <div class="line"><a name="l00825"></a><span class="lineno">  825</span>&#160;              <a class="code" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c">beat</a>(0),</div>

  897. <div class="line"><a name="l00826"></a><span class="lineno">  826</span>&#160;              <a class="code" href="structTimePosition_1_1BarBeatTick.html#aecb8a1a98db84c6d03c39278f86a0324">tick</a>(0),</div>

  898. <div class="line"><a name="l00827"></a><span class="lineno">  827</span>&#160;              <a class="code" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">barStartTick</a>(0.0),</div>

  899. <div class="line"><a name="l00828"></a><span class="lineno">  828</span>&#160;              <a class="code" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">beatsPerBar</a>(0.0f),</div>

  900. <div class="line"><a name="l00829"></a><span class="lineno">  829</span>&#160;              <a class="code" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">beatType</a>(0.0f),</div>

  901. <div class="line"><a name="l00830"></a><span class="lineno">  830</span>&#160;              <a class="code" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">ticksPerBeat</a>(0.0),</div>

  902. <div class="line"><a name="l00831"></a><span class="lineno">  831</span>&#160;              <a class="code" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">beatsPerMinute</a>(0.0) {}</div>

  903. <div class="line"><a name="l00832"></a><span class="lineno">  832</span>&#160;<span class="comment"></span> </div>

  904. <div class="line"><a name="l00833"></a><span class="lineno">  833</span>&#160;<span class="comment">       /**</span></div>

  905. <div class="line"><a name="l00834"></a><span class="lineno">  834</span>&#160;<span class="comment">          Reinitialize this position using the default null initialization.</span></div>

  906. <div class="line"><a name="l00835"></a><span class="lineno">  835</span>&#160;<span class="comment">        */</span></div>

  907. <div class="line"><a name="l00836"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ae6ea776260b58800bff63f515351bd3a">  836</a></span>&#160;        <span class="keywordtype">void</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#ae6ea776260b58800bff63f515351bd3a">clear</a>() noexcept</div>

  908. <div class="line"><a name="l00837"></a><span class="lineno">  837</span>&#160;        {</div>

  909. <div class="line"><a name="l00838"></a><span class="lineno">  838</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e">valid</a> = <span class="keyword">false</span>;</div>

  910. <div class="line"><a name="l00839"></a><span class="lineno">  839</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21">bar</a> = 0;</div>

  911. <div class="line"><a name="l00840"></a><span class="lineno">  840</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c">beat</a> = 0;</div>

  912. <div class="line"><a name="l00841"></a><span class="lineno">  841</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#aecb8a1a98db84c6d03c39278f86a0324">tick</a> = 0;</div>

  913. <div class="line"><a name="l00842"></a><span class="lineno">  842</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">barStartTick</a> = 0.0;</div>

  914. <div class="line"><a name="l00843"></a><span class="lineno">  843</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">beatsPerBar</a> = 0.0f;</div>

  915. <div class="line"><a name="l00844"></a><span class="lineno">  844</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">beatType</a> = 0.0f;</div>

  916. <div class="line"><a name="l00845"></a><span class="lineno">  845</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">ticksPerBeat</a> = 0.0;</div>

  917. <div class="line"><a name="l00846"></a><span class="lineno">  846</span>&#160;            <a class="code" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">beatsPerMinute</a> = 0.0;</div>

  918. <div class="line"><a name="l00847"></a><span class="lineno">  847</span>&#160;        }</div>

  919. <div class="line"><a name="l00848"></a><span class="lineno">  848</span>&#160;    } bbt;</div>

  920. <div class="line"><a name="l00849"></a><span class="lineno">  849</span>&#160;<span class="comment"></span> </div>

  921. <div class="line"><a name="l00850"></a><span class="lineno">  850</span>&#160;<span class="comment">   /**</span></div>

  922. <div class="line"><a name="l00851"></a><span class="lineno">  851</span>&#160;<span class="comment">      Default constructor for a time position.</span></div>

  923. <div class="line"><a name="l00852"></a><span class="lineno">  852</span>&#160;<span class="comment">    */</span></div>

  924. <div class="line"><a name="l00853"></a><span class="lineno"><a class="line" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae">  853</a></span>&#160;    <a class="code" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae">TimePosition</a>() noexcept</div>

  925. <div class="line"><a name="l00854"></a><span class="lineno">  854</span>&#160;        : <a class="code" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574">playing</a>(false),</div>

  926. <div class="line"><a name="l00855"></a><span class="lineno">  855</span>&#160;          <a class="code" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b">frame</a>(0),</div>

  927. <div class="line"><a name="l00856"></a><span class="lineno">  856</span>&#160;          bbt() {}</div>

  928. <div class="line"><a name="l00857"></a><span class="lineno">  857</span>&#160;<span class="comment"></span> </div>

  929. <div class="line"><a name="l00858"></a><span class="lineno">  858</span>&#160;<span class="comment">   /**</span></div>

  930. <div class="line"><a name="l00859"></a><span class="lineno">  859</span>&#160;<span class="comment">      Reinitialize this position using the default null initialization.</span></div>

  931. <div class="line"><a name="l00860"></a><span class="lineno">  860</span>&#160;<span class="comment">    */</span></div>

  932. <div class="line"><a name="l00861"></a><span class="lineno"><a class="line" href="structTimePosition.html#acd89e79032d748ee7fc01d55a2c518bb">  861</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structTimePosition.html#acd89e79032d748ee7fc01d55a2c518bb">clear</a>() noexcept</div>

  933. <div class="line"><a name="l00862"></a><span class="lineno">  862</span>&#160;    {</div>

  934. <div class="line"><a name="l00863"></a><span class="lineno">  863</span>&#160;        <a class="code" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574">playing</a>  = <span class="keyword">false</span>;</div>

  935. <div class="line"><a name="l00864"></a><span class="lineno">  864</span>&#160;        <a class="code" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b">frame</a> = 0;</div>

  936. <div class="line"><a name="l00865"></a><span class="lineno">  865</span>&#160;        bbt.<a class="code" href="structTimePosition_1_1BarBeatTick.html#ae6ea776260b58800bff63f515351bd3a">clear</a>();</div>

  937. <div class="line"><a name="l00866"></a><span class="lineno">  866</span>&#160;    }</div>

  938. <div class="line"><a name="l00867"></a><span class="lineno">  867</span>&#160;};</div>

  939. <div class="line"><a name="l00868"></a><span class="lineno">  868</span>&#160;<span class="comment"></span> </div>

  940. <div class="line"><a name="l00869"></a><span class="lineno">  869</span>&#160;<span class="comment">/** @} */</span></div>

  941. <div class="line"><a name="l00870"></a><span class="lineno">  870</span>&#160; </div>

  942. <div class="line"><a name="l00871"></a><span class="lineno">  871</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  943. <div class="line"><a name="l00872"></a><span class="lineno">  872</span>&#160;<span class="comment"> * DPF Plugin */</span></div>

  944. <div class="line"><a name="l00873"></a><span class="lineno">  873</span>&#160;<span class="comment"></span> </div>

  945. <div class="line"><a name="l00874"></a><span class="lineno">  874</span>&#160;<span class="comment">/**</span></div>

  946. <div class="line"><a name="l00875"></a><span class="lineno">  875</span>&#160;<span class="comment">   @defgroup MainClasses Main Classes</span></div>

  947. <div class="line"><a name="l00876"></a><span class="lineno">  876</span>&#160;<span class="comment">   @{</span></div>

  948. <div class="line"><a name="l00877"></a><span class="lineno">  877</span>&#160;<span class="comment"> */</span></div>

  949. <div class="line"><a name="l00878"></a><span class="lineno">  878</span>&#160;<span class="comment"></span> </div>

  950. <div class="line"><a name="l00879"></a><span class="lineno">  879</span>&#160;<span class="comment">/**</span></div>

  951. <div class="line"><a name="l00880"></a><span class="lineno">  880</span>&#160;<span class="comment">   DPF Plugin class from where plugin instances are created.</span></div>

  952. <div class="line"><a name="l00881"></a><span class="lineno">  881</span>&#160;<span class="comment"></span> </div>

  953. <div class="line"><a name="l00882"></a><span class="lineno">  882</span>&#160;<span class="comment">   The public methods (Host state) are called from the plugin to get or set host information.@n</span></div>

  954. <div class="line"><a name="l00883"></a><span class="lineno">  883</span>&#160;<span class="comment">   They can be called from a plugin instance at anytime unless stated otherwise.@n</span></div>

  955. <div class="line"><a name="l00884"></a><span class="lineno">  884</span>&#160;<span class="comment">   All other methods are to be implemented by the plugin and will be called by the host.</span></div>

  956. <div class="line"><a name="l00885"></a><span class="lineno">  885</span>&#160;<span class="comment"></span> </div>

  957. <div class="line"><a name="l00886"></a><span class="lineno">  886</span>&#160;<span class="comment">   Shortly after a plugin instance is created, the various init* functions will be called by the host.@n</span></div>

  958. <div class="line"><a name="l00887"></a><span class="lineno">  887</span>&#160;<span class="comment">   Host will call activate() before run(), and deactivate() before the plugin instance is destroyed.@n</span></div>

  959. <div class="line"><a name="l00888"></a><span class="lineno">  888</span>&#160;<span class="comment">   The host may call deactivate right after activate and vice-versa, but never activate/deactivate consecutively.@n</span></div>

  960. <div class="line"><a name="l00889"></a><span class="lineno">  889</span>&#160;<span class="comment">   There is no limit on how many times run() is called, only that activate/deactivate will be called in between.</span></div>

  961. <div class="line"><a name="l00890"></a><span class="lineno">  890</span>&#160;<span class="comment"></span> </div>

  962. <div class="line"><a name="l00891"></a><span class="lineno">  891</span>&#160;<span class="comment">   The buffer size and sample rate values will remain constant between activate and deactivate.@n</span></div>

  963. <div class="line"><a name="l00892"></a><span class="lineno">  892</span>&#160;<span class="comment">   Buffer size is only a hint though, the host might call run() with a higher or lower number of frames.</span></div>

  964. <div class="line"><a name="l00893"></a><span class="lineno">  893</span>&#160;<span class="comment"></span> </div>

  965. <div class="line"><a name="l00894"></a><span class="lineno">  894</span>&#160;<span class="comment">   Some of this class functions are only available according to some macros.</span></div>

  966. <div class="line"><a name="l00895"></a><span class="lineno">  895</span>&#160;<span class="comment"></span> </div>

  967. <div class="line"><a name="l00896"></a><span class="lineno">  896</span>&#160;<span class="comment">   DISTRHO_PLUGIN_WANT_PROGRAMS activates program related features.@n</span></div>

  968. <div class="line"><a name="l00897"></a><span class="lineno">  897</span>&#160;<span class="comment">   When enabled you need to implement initProgramName() and loadProgram().</span></div>

  969. <div class="line"><a name="l00898"></a><span class="lineno">  898</span>&#160;<span class="comment"></span> </div>

  970. <div class="line"><a name="l00899"></a><span class="lineno">  899</span>&#160;<span class="comment">   DISTRHO_PLUGIN_WANT_STATE activates internal state features.@n</span></div>

  971. <div class="line"><a name="l00900"></a><span class="lineno">  900</span>&#160;<span class="comment">   When enabled you need to implement initStateKey() and setState().</span></div>

  972. <div class="line"><a name="l00901"></a><span class="lineno">  901</span>&#160;<span class="comment"></span> </div>

  973. <div class="line"><a name="l00902"></a><span class="lineno">  902</span>&#160;<span class="comment">   The process function run() changes wherever DISTRHO_PLUGIN_WANT_MIDI_INPUT is enabled or not.@n</span></div>

  974. <div class="line"><a name="l00903"></a><span class="lineno">  903</span>&#160;<span class="comment">   When enabled it provides midi input events.</span></div>

  975. <div class="line"><a name="l00904"></a><span class="lineno">  904</span>&#160;<span class="comment"> */</span></div>

  976. <div class="line"><a name="l00905"></a><span class="lineno"><a class="line" href="classPlugin.html">  905</a></span>&#160;<span class="keyword">class </span><a class="code" href="classPlugin.html">Plugin</a></div>

  977. <div class="line"><a name="l00906"></a><span class="lineno">  906</span>&#160;{</div>

  978. <div class="line"><a name="l00907"></a><span class="lineno">  907</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>

  979. <div class="line"><a name="l00908"></a><span class="lineno">  908</span>&#160;<span class="comment">   /**</span></div>

  980. <div class="line"><a name="l00909"></a><span class="lineno">  909</span>&#160;<span class="comment">      Plugin class constructor.@n</span></div>

  981. <div class="line"><a name="l00910"></a><span class="lineno">  910</span>&#160;<span class="comment">      You must set all parameter values to their defaults, matching ParameterRanges::def.</span></div>

  982. <div class="line"><a name="l00911"></a><span class="lineno">  911</span>&#160;<span class="comment">    */</span></div>

  983. <div class="line"><a name="l00912"></a><span class="lineno"><a class="line" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">  912</a></span>&#160;    <a class="code" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin</a>(uint32_t parameterCount, uint32_t programCount, uint32_t stateCount);</div>

  984. <div class="line"><a name="l00913"></a><span class="lineno">  913</span>&#160;<span class="comment"></span> </div>

  985. <div class="line"><a name="l00914"></a><span class="lineno">  914</span>&#160;<span class="comment">   /**</span></div>

  986. <div class="line"><a name="l00915"></a><span class="lineno">  915</span>&#160;<span class="comment">      Destructor.</span></div>

  987. <div class="line"><a name="l00916"></a><span class="lineno">  916</span>&#160;<span class="comment">    */</span></div>

  988. <div class="line"><a name="l00917"></a><span class="lineno"><a class="line" href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">  917</a></span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">~Plugin</a>();</div>

  989. <div class="line"><a name="l00918"></a><span class="lineno">  918</span>&#160; </div>

  990. <div class="line"><a name="l00919"></a><span class="lineno">  919</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  991. <div class="line"><a name="l00920"></a><span class="lineno">  920</span>&#160;<span class="comment">    * Host state */</span></div>

  992. <div class="line"><a name="l00921"></a><span class="lineno">  921</span>&#160;<span class="comment"></span> </div>

  993. <div class="line"><a name="l00922"></a><span class="lineno">  922</span>&#160;<span class="comment">   /**</span></div>

  994. <div class="line"><a name="l00923"></a><span class="lineno">  923</span>&#160;<span class="comment">      Get the current buffer size that will probably be used during processing, in frames.@n</span></div>

  995. <div class="line"><a name="l00924"></a><span class="lineno">  924</span>&#160;<span class="comment">      This value will remain constant between activate and deactivate.</span></div>

  996. <div class="line"><a name="l00925"></a><span class="lineno">  925</span>&#160;<span class="comment">      @note This value is only a hint!@n</span></div>

  997. <div class="line"><a name="l00926"></a><span class="lineno">  926</span>&#160;<span class="comment">            Hosts might call run() with a higher or lower number of frames.</span></div>

  998. <div class="line"><a name="l00927"></a><span class="lineno">  927</span>&#160;<span class="comment">      @see bufferSizeChanged(uint32_t)</span></div>

  999. <div class="line"><a name="l00928"></a><span class="lineno">  928</span>&#160;<span class="comment">    */</span></div>

  1000. <div class="line"><a name="l00929"></a><span class="lineno"><a class="line" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">  929</a></span>&#160;    uint32_t <a class="code" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize</a>() const noexcept;</div>

  1001. <div class="line"><a name="l00930"></a><span class="lineno">  930</span>&#160;<span class="comment"></span> </div>

  1002. <div class="line"><a name="l00931"></a><span class="lineno">  931</span>&#160;<span class="comment">   /**</span></div>

  1003. <div class="line"><a name="l00932"></a><span class="lineno">  932</span>&#160;<span class="comment">      Get the current sample rate that will be used during processing.@n</span></div>

  1004. <div class="line"><a name="l00933"></a><span class="lineno">  933</span>&#160;<span class="comment">      This value will remain constant between activate and deactivate.</span></div>

  1005. <div class="line"><a name="l00934"></a><span class="lineno">  934</span>&#160;<span class="comment">      @see sampleRateChanged(double)</span></div>

  1006. <div class="line"><a name="l00935"></a><span class="lineno">  935</span>&#160;<span class="comment">    */</span></div>

  1007. <div class="line"><a name="l00936"></a><span class="lineno"><a class="line" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">  936</a></span>&#160;    <span class="keywordtype">double</span> <a class="code" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">getSampleRate</a>() const noexcept;</div>

  1008. <div class="line"><a name="l00937"></a><span class="lineno">  937</span>&#160;<span class="comment"></span> </div>

  1009. <div class="line"><a name="l00938"></a><span class="lineno">  938</span>&#160;<span class="comment">   /**</span></div>

  1010. <div class="line"><a name="l00939"></a><span class="lineno">  939</span>&#160;<span class="comment">      Get the bundle path where the plugin resides.</span></div>

  1011. <div class="line"><a name="l00940"></a><span class="lineno">  940</span>&#160;<span class="comment">      Can return null if the plugin is not available in a bundle (if it is a single binary).</span></div>

  1012. <div class="line"><a name="l00941"></a><span class="lineno">  941</span>&#160;<span class="comment">      @see getBinaryFilename</span></div>

  1013. <div class="line"><a name="l00942"></a><span class="lineno">  942</span>&#160;<span class="comment">      @see getResourcePath</span></div>

  1014. <div class="line"><a name="l00943"></a><span class="lineno">  943</span>&#160;<span class="comment">    */</span></div>

  1015. <div class="line"><a name="l00944"></a><span class="lineno"><a class="line" href="classPlugin.html#a5fd60c82f5a50f12312c57729885fc2f">  944</a></span>&#160;    const <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a5fd60c82f5a50f12312c57729885fc2f">getBundlePath</a>() const noexcept;</div>

  1016. <div class="line"><a name="l00945"></a><span class="lineno">  945</span>&#160;<span class="comment"></span> </div>

  1017. <div class="line"><a name="l00946"></a><span class="lineno">  946</span>&#160;<span class="comment">   /**</span></div>

  1018. <div class="line"><a name="l00947"></a><span class="lineno">  947</span>&#160;<span class="comment">      Check if this plugin instance is a &quot;dummy&quot; one used for plugin meta-data/information export.@n</span></div>

  1019. <div class="line"><a name="l00948"></a><span class="lineno">  948</span>&#160;<span class="comment">      When true no processing will be done, the plugin is created only to extract information.@n</span></div>

  1020. <div class="line"><a name="l00949"></a><span class="lineno">  949</span>&#160;<span class="comment">      In DPF, LADSPA/DSSI, VST2 and VST3 formats create one global instance per plugin binary</span></div>

  1021. <div class="line"><a name="l00950"></a><span class="lineno">  950</span>&#160;<span class="comment">      while LV2 creates one when generating turtle meta-data.</span></div>

  1022. <div class="line"><a name="l00951"></a><span class="lineno">  951</span>&#160;<span class="comment">    */</span></div>

  1023. <div class="line"><a name="l00952"></a><span class="lineno"><a class="line" href="classPlugin.html#ab2c6b7bc2e0cdcd589cf9d03be831042">  952</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#ab2c6b7bc2e0cdcd589cf9d03be831042">isDummyInstance</a>() const noexcept;</div>

  1024. <div class="line"><a name="l00953"></a><span class="lineno">  953</span>&#160; </div>

  1025. <div class="line"><a name="l00954"></a><span class="lineno">  954</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_TIMEPOS</span><span class="comment"></span></div>

  1026. <div class="line"><a name="l00955"></a><span class="lineno">  955</span>&#160;<span class="comment">   /**</span></div>

  1027. <div class="line"><a name="l00956"></a><span class="lineno">  956</span>&#160;<span class="comment">      Get the current host transport time position.@n</span></div>

  1028. <div class="line"><a name="l00957"></a><span class="lineno">  957</span>&#160;<span class="comment">      This function should only be called during run().@n</span></div>

  1029. <div class="line"><a name="l00958"></a><span class="lineno">  958</span>&#160;<span class="comment">      You can call this during other times, but the returned position is not guaranteed to be in sync.</span></div>

  1030. <div class="line"><a name="l00959"></a><span class="lineno">  959</span>&#160;<span class="comment">      @note TimePosition is not supported in LADSPA and DSSI plugin formats.</span></div>

  1031. <div class="line"><a name="l00960"></a><span class="lineno">  960</span>&#160;<span class="comment">    */</span></div>

  1032. <div class="line"><a name="l00961"></a><span class="lineno"><a class="line" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">  961</a></span>&#160;    <span class="keyword">const</span> <a class="code" href="structTimePosition.html">TimePosition</a>&amp; <a class="code" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">getTimePosition</a>() const noexcept;</div>

  1033. <div class="line"><a name="l00962"></a><span class="lineno">  962</span>&#160;<span class="preprocessor">#endif</span></div>

  1034. <div class="line"><a name="l00963"></a><span class="lineno">  963</span>&#160; </div>

  1035. <div class="line"><a name="l00964"></a><span class="lineno">  964</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_LATENCY</span><span class="comment"></span></div>

  1036. <div class="line"><a name="l00965"></a><span class="lineno">  965</span>&#160;<span class="comment">   /**</span></div>

  1037. <div class="line"><a name="l00966"></a><span class="lineno">  966</span>&#160;<span class="comment">      Change the plugin audio output latency to @a frames.@n</span></div>

  1038. <div class="line"><a name="l00967"></a><span class="lineno">  967</span>&#160;<span class="comment">      This function should only be called in the constructor, activate() and run().</span></div>

  1039. <div class="line"><a name="l00968"></a><span class="lineno">  968</span>&#160;<span class="comment">      @note This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled.</span></div>

  1040. <div class="line"><a name="l00969"></a><span class="lineno">  969</span>&#160;<span class="comment">    */</span></div>

  1041. <div class="line"><a name="l00970"></a><span class="lineno"><a class="line" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">  970</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">setLatency</a>(uint32_t frames) noexcept;</div>

  1042. <div class="line"><a name="l00971"></a><span class="lineno">  971</span>&#160;<span class="preprocessor">#endif</span></div>

  1043. <div class="line"><a name="l00972"></a><span class="lineno">  972</span>&#160; </div>

  1044. <div class="line"><a name="l00973"></a><span class="lineno">  973</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</span><span class="comment"></span></div>

  1045. <div class="line"><a name="l00974"></a><span class="lineno">  974</span>&#160;<span class="comment">   /**</span></div>

  1046. <div class="line"><a name="l00975"></a><span class="lineno">  975</span>&#160;<span class="comment">      Write a MIDI output event.@n</span></div>

  1047. <div class="line"><a name="l00976"></a><span class="lineno">  976</span>&#160;<span class="comment">      This function must only be called during run().@n</span></div>

  1048. <div class="line"><a name="l00977"></a><span class="lineno">  977</span>&#160;<span class="comment">      Returns false when the host buffer is full, in which case do not call this again until the next run().</span></div>

  1049. <div class="line"><a name="l00978"></a><span class="lineno">  978</span>&#160;<span class="comment">    */</span></div>

  1050. <div class="line"><a name="l00979"></a><span class="lineno"><a class="line" href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">  979</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">writeMidiEvent</a>(<span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>&amp; midiEvent) noexcept;</div>

  1051. <div class="line"><a name="l00980"></a><span class="lineno">  980</span>&#160;<span class="preprocessor">#endif</span></div>

  1052. <div class="line"><a name="l00981"></a><span class="lineno">  981</span>&#160; </div>

  1053. <div class="line"><a name="l00982"></a><span class="lineno">  982</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST</span><span class="comment"></span></div>

  1054. <div class="line"><a name="l00983"></a><span class="lineno">  983</span>&#160;<span class="comment">   /**</span></div>

  1055. <div class="line"><a name="l00984"></a><span class="lineno">  984</span>&#160;<span class="comment">      Check if parameter value change requests will work with the current plugin host.</span></div>

  1056. <div class="line"><a name="l00985"></a><span class="lineno">  985</span>&#160;<span class="comment">      @note This function is only available if DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST is enabled.</span></div>

  1057. <div class="line"><a name="l00986"></a><span class="lineno">  986</span>&#160;<span class="comment">      @see requestParameterValueChange(uint32_t, float)</span></div>

  1058. <div class="line"><a name="l00987"></a><span class="lineno">  987</span>&#160;<span class="comment">    */</span></div>

  1059. <div class="line"><a name="l00988"></a><span class="lineno"><a class="line" href="classPlugin.html#a581614e1d301ee613a988855c61b2517">  988</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#a581614e1d301ee613a988855c61b2517">canRequestParameterValueChanges</a>() const noexcept;</div>

  1060. <div class="line"><a name="l00989"></a><span class="lineno">  989</span>&#160;<span class="comment"></span> </div>

  1061. <div class="line"><a name="l00990"></a><span class="lineno">  990</span>&#160;<span class="comment">   /**</span></div>

  1062. <div class="line"><a name="l00991"></a><span class="lineno">  991</span>&#160;<span class="comment">      Request a parameter value change from the host.</span></div>

  1063. <div class="line"><a name="l00992"></a><span class="lineno">  992</span>&#160;<span class="comment">      If successful, this function will automatically trigger a parameter update on the UI side as well.</span></div>

  1064. <div class="line"><a name="l00993"></a><span class="lineno">  993</span>&#160;<span class="comment">      This function can fail, for example if the host is busy with the parameter for read-only automation.</span></div>

  1065. <div class="line"><a name="l00994"></a><span class="lineno">  994</span>&#160;<span class="comment">      Some hosts simply do not have this functionality, which can be verified with canRequestParameterValueChanges().</span></div>

  1066. <div class="line"><a name="l00995"></a><span class="lineno">  995</span>&#160;<span class="comment">      @note This function is only available if DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST is enabled.</span></div>

  1067. <div class="line"><a name="l00996"></a><span class="lineno">  996</span>&#160;<span class="comment">    */</span></div>

  1068. <div class="line"><a name="l00997"></a><span class="lineno"><a class="line" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">  997</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">requestParameterValueChange</a>(uint32_t index, <span class="keywordtype">float</span> value) noexcept;</div>

  1069. <div class="line"><a name="l00998"></a><span class="lineno">  998</span>&#160;<span class="preprocessor">#endif</span></div>

  1070. <div class="line"><a name="l00999"></a><span class="lineno">  999</span>&#160; </div>

  1071. <div class="line"><a name="l01000"></a><span class="lineno"> 1000</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span><span class="comment"></span></div>

  1072. <div class="line"><a name="l01001"></a><span class="lineno"> 1001</span>&#160;<span class="comment">   /**</span></div>

  1073. <div class="line"><a name="l01002"></a><span class="lineno"> 1002</span>&#160;<span class="comment">      Set state value and notify the host about the change.@n</span></div>

  1074. <div class="line"><a name="l01003"></a><span class="lineno"> 1003</span>&#160;<span class="comment">      This function will call `setState()` and also trigger an update on the UI side as necessary.@n</span></div>

  1075. <div class="line"><a name="l01004"></a><span class="lineno"> 1004</span>&#160;<span class="comment">      It must not be called during run.@n</span></div>

  1076. <div class="line"><a name="l01005"></a><span class="lineno"> 1005</span>&#160;<span class="comment">      The state must be host readable.</span></div>

  1077. <div class="line"><a name="l01006"></a><span class="lineno"> 1006</span>&#160;<span class="comment">      @note this function does nothing on DSSI plugin format, as DSSI only supports UI-&gt;DSP messages.</span></div>

  1078. <div class="line"><a name="l01007"></a><span class="lineno"> 1007</span>&#160;<span class="comment"></span> </div>

  1079. <div class="line"><a name="l01008"></a><span class="lineno"> 1008</span>&#160;<span class="comment">      TODO API under construction</span></div>

  1080. <div class="line"><a name="l01009"></a><span class="lineno"> 1009</span>&#160;<span class="comment">    */</span></div>

  1081. <div class="line"><a name="l01010"></a><span class="lineno"><a class="line" href="classPlugin.html#aa85c50c732d9083f57b72d6b4cd7c5ae"> 1010</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#aa85c50c732d9083f57b72d6b4cd7c5ae">updateStateValue</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value) noexcept;</div>

  1082. <div class="line"><a name="l01011"></a><span class="lineno"> 1011</span>&#160;<span class="preprocessor">#endif</span></div>

  1083. <div class="line"><a name="l01012"></a><span class="lineno"> 1012</span>&#160; </div>

  1084. <div class="line"><a name="l01013"></a><span class="lineno"> 1013</span>&#160;<span class="keyword">protected</span>:</div>

  1085. <div class="line"><a name="l01014"></a><span class="lineno"> 1014</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  1086. <div class="line"><a name="l01015"></a><span class="lineno"> 1015</span>&#160;<span class="comment">    * Information */</span></div>

  1087. <div class="line"><a name="l01016"></a><span class="lineno"> 1016</span>&#160;<span class="comment"></span> </div>

  1088. <div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>&#160;<span class="comment">   /**</span></div>

  1089. <div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>&#160;<span class="comment">      Get the plugin name.@n</span></div>

  1090. <div class="line"><a name="l01019"></a><span class="lineno"> 1019</span>&#160;<span class="comment">      Returns DISTRHO_PLUGIN_NAME by default.</span></div>

  1091. <div class="line"><a name="l01020"></a><span class="lineno"> 1020</span>&#160;<span class="comment">    */</span></div>

  1092. <div class="line"><a name="l01021"></a><span class="lineno"><a class="line" href="classPlugin.html#aebb5df5cde162462dc460d4fd45dae75"> 1021</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#aebb5df5cde162462dc460d4fd45dae75">getName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a>; }</div>

  1093. <div class="line"><a name="l01022"></a><span class="lineno"> 1022</span>&#160;<span class="comment"></span> </div>

  1094. <div class="line"><a name="l01023"></a><span class="lineno"> 1023</span>&#160;<span class="comment">   /**</span></div>

  1095. <div class="line"><a name="l01024"></a><span class="lineno"> 1024</span>&#160;<span class="comment">      Get the plugin label.@n</span></div>

  1096. <div class="line"><a name="l01025"></a><span class="lineno"> 1025</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>

  1097. <div class="line"><a name="l01026"></a><span class="lineno"> 1026</span>&#160;<span class="comment">    */</span></div>

  1098. <div class="line"><a name="l01027"></a><span class="lineno"><a class="line" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f"> 1027</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">getLabel</a>() <span class="keyword">const</span> = 0;</div>

  1099. <div class="line"><a name="l01028"></a><span class="lineno"> 1028</span>&#160;<span class="comment"></span> </div>

  1100. <div class="line"><a name="l01029"></a><span class="lineno"> 1029</span>&#160;<span class="comment">   /**</span></div>

  1101. <div class="line"><a name="l01030"></a><span class="lineno"> 1030</span>&#160;<span class="comment">      Get an extensive comment/description about the plugin.@n</span></div>

  1102. <div class="line"><a name="l01031"></a><span class="lineno"> 1031</span>&#160;<span class="comment">      Optional, returns nothing by default.</span></div>

  1103. <div class="line"><a name="l01032"></a><span class="lineno"> 1032</span>&#160;<span class="comment">    */</span></div>

  1104. <div class="line"><a name="l01033"></a><span class="lineno"><a class="line" href="classPlugin.html#a30db5eef9de617f4c81d5c6925facea3"> 1033</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a30db5eef9de617f4c81d5c6925facea3">getDescription</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; }</div>

  1105. <div class="line"><a name="l01034"></a><span class="lineno"> 1034</span>&#160;<span class="comment"></span> </div>

  1106. <div class="line"><a name="l01035"></a><span class="lineno"> 1035</span>&#160;<span class="comment">   /**</span></div>

  1107. <div class="line"><a name="l01036"></a><span class="lineno"> 1036</span>&#160;<span class="comment">      Get the plugin author/maker.</span></div>

  1108. <div class="line"><a name="l01037"></a><span class="lineno"> 1037</span>&#160;<span class="comment">    */</span></div>

  1109. <div class="line"><a name="l01038"></a><span class="lineno"><a class="line" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d"> 1038</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">getMaker</a>() <span class="keyword">const</span> = 0;</div>

  1110. <div class="line"><a name="l01039"></a><span class="lineno"> 1039</span>&#160;<span class="comment"></span> </div>

  1111. <div class="line"><a name="l01040"></a><span class="lineno"> 1040</span>&#160;<span class="comment">   /**</span></div>

  1112. <div class="line"><a name="l01041"></a><span class="lineno"> 1041</span>&#160;<span class="comment">      Get the plugin homepage.@n</span></div>

  1113. <div class="line"><a name="l01042"></a><span class="lineno"> 1042</span>&#160;<span class="comment">      Optional, returns nothing by default.</span></div>

  1114. <div class="line"><a name="l01043"></a><span class="lineno"> 1043</span>&#160;<span class="comment">    */</span></div>

  1115. <div class="line"><a name="l01044"></a><span class="lineno"><a class="line" href="classPlugin.html#ad12c681ce31004da0badd609763f45c5"> 1044</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#ad12c681ce31004da0badd609763f45c5">getHomePage</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; }</div>

  1116. <div class="line"><a name="l01045"></a><span class="lineno"> 1045</span>&#160;<span class="comment"></span> </div>

  1117. <div class="line"><a name="l01046"></a><span class="lineno"> 1046</span>&#160;<span class="comment">   /**</span></div>

  1118. <div class="line"><a name="l01047"></a><span class="lineno"> 1047</span>&#160;<span class="comment">      Get the plugin license (a single line of text or a URL).@n</span></div>

  1119. <div class="line"><a name="l01048"></a><span class="lineno"> 1048</span>&#160;<span class="comment">      For commercial plugins this should return some short copyright information.</span></div>

  1120. <div class="line"><a name="l01049"></a><span class="lineno"> 1049</span>&#160;<span class="comment">    */</span></div>

  1121. <div class="line"><a name="l01050"></a><span class="lineno"><a class="line" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1"> 1050</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">getLicense</a>() <span class="keyword">const</span> = 0;</div>

  1122. <div class="line"><a name="l01051"></a><span class="lineno"> 1051</span>&#160;<span class="comment"></span> </div>

  1123. <div class="line"><a name="l01052"></a><span class="lineno"> 1052</span>&#160;<span class="comment">   /**</span></div>

  1124. <div class="line"><a name="l01053"></a><span class="lineno"> 1053</span>&#160;<span class="comment">      Get the plugin version, in hexadecimal.</span></div>

  1125. <div class="line"><a name="l01054"></a><span class="lineno"> 1054</span>&#160;<span class="comment">      @see d_version()</span></div>

  1126. <div class="line"><a name="l01055"></a><span class="lineno"> 1055</span>&#160;<span class="comment">    */</span></div>

  1127. <div class="line"><a name="l01056"></a><span class="lineno"><a class="line" href="classPlugin.html#abae540dd93caf4834270358a8aad334a"> 1056</a></span>&#160;    <span class="keyword">virtual</span> uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>() <span class="keyword">const</span> = 0;</div>

  1128. <div class="line"><a name="l01057"></a><span class="lineno"> 1057</span>&#160;<span class="comment"></span> </div>

  1129. <div class="line"><a name="l01058"></a><span class="lineno"> 1058</span>&#160;<span class="comment">   /**</span></div>

  1130. <div class="line"><a name="l01059"></a><span class="lineno"> 1059</span>&#160;<span class="comment">      Get the plugin unique Id.@n</span></div>

  1131. <div class="line"><a name="l01060"></a><span class="lineno"> 1060</span>&#160;<span class="comment">      This value is used by LADSPA, DSSI and VST plugin formats.</span></div>

  1132. <div class="line"><a name="l01061"></a><span class="lineno"> 1061</span>&#160;<span class="comment">      @see d_cconst()</span></div>

  1133. <div class="line"><a name="l01062"></a><span class="lineno"> 1062</span>&#160;<span class="comment">    */</span></div>

  1134. <div class="line"><a name="l01063"></a><span class="lineno"><a class="line" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66"> 1063</a></span>&#160;    <span class="keyword">virtual</span> int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>() <span class="keyword">const</span> = 0;</div>

  1135. <div class="line"><a name="l01064"></a><span class="lineno"> 1064</span>&#160; </div>

  1136. <div class="line"><a name="l01065"></a><span class="lineno"> 1065</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  1137. <div class="line"><a name="l01066"></a><span class="lineno"> 1066</span>&#160;<span class="comment">    * Init */</span></div>

  1138. <div class="line"><a name="l01067"></a><span class="lineno"> 1067</span>&#160;<span class="comment"></span> </div>

  1139. <div class="line"><a name="l01068"></a><span class="lineno"> 1068</span>&#160;<span class="comment">   /**</span></div>

  1140. <div class="line"><a name="l01069"></a><span class="lineno"> 1069</span>&#160;<span class="comment">      Initialize the audio port @a index.@n</span></div>

  1141. <div class="line"><a name="l01070"></a><span class="lineno"> 1070</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.</span></div>

  1142. <div class="line"><a name="l01071"></a><span class="lineno"> 1071</span>&#160;<span class="comment">    */</span></div>

  1143. <div class="line"><a name="l01072"></a><span class="lineno"><a class="line" href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4"> 1072</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">initAudioPort</a>(<span class="keywordtype">bool</span> input, uint32_t index, <a class="code" href="structAudioPort.html">AudioPort</a>&amp; port);</div>

  1144. <div class="line"><a name="l01073"></a><span class="lineno"> 1073</span>&#160;<span class="comment"></span> </div>

  1145. <div class="line"><a name="l01074"></a><span class="lineno"> 1074</span>&#160;<span class="comment">   /**</span></div>

  1146. <div class="line"><a name="l01075"></a><span class="lineno"> 1075</span>&#160;<span class="comment">      Initialize the parameter @a index.@n</span></div>

  1147. <div class="line"><a name="l01076"></a><span class="lineno"> 1076</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.</span></div>

  1148. <div class="line"><a name="l01077"></a><span class="lineno"> 1077</span>&#160;<span class="comment">    */</span></div>

  1149. <div class="line"><a name="l01078"></a><span class="lineno"><a class="line" href="classPlugin.html#aacf87bd0037efeb3b60d204940f3f4a0"> 1078</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aacf87bd0037efeb3b60d204940f3f4a0">initParameter</a>(uint32_t index, <a class="code" href="structParameter.html">Parameter</a>&amp; parameter);</div>

  1150. <div class="line"><a name="l01079"></a><span class="lineno"> 1079</span>&#160;<span class="comment"></span> </div>

  1151. <div class="line"><a name="l01080"></a><span class="lineno"> 1080</span>&#160;<span class="comment">   /**</span></div>

  1152. <div class="line"><a name="l01081"></a><span class="lineno"> 1081</span>&#160;<span class="comment">      Initialize the port group @a groupId.@n</span></div>

  1153. <div class="line"><a name="l01082"></a><span class="lineno"> 1082</span>&#160;<span class="comment">      This function will be called once,</span></div>

  1154. <div class="line"><a name="l01083"></a><span class="lineno"> 1083</span>&#160;<span class="comment">      shortly after the plugin is created and all audio ports and parameters have been enumerated.</span></div>

  1155. <div class="line"><a name="l01084"></a><span class="lineno"> 1084</span>&#160;<span class="comment">    */</span></div>

  1156. <div class="line"><a name="l01085"></a><span class="lineno"><a class="line" href="classPlugin.html#a71b876c8157b087b3552960f2877a44d"> 1085</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a71b876c8157b087b3552960f2877a44d">initPortGroup</a>(uint32_t groupId, <a class="code" href="structPortGroup.html">PortGroup</a>&amp; portGroup);</div>

  1157. <div class="line"><a name="l01086"></a><span class="lineno"> 1086</span>&#160; </div>

  1158. <div class="line"><a name="l01087"></a><span class="lineno"> 1087</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span><span class="comment"></span></div>

  1159. <div class="line"><a name="l01088"></a><span class="lineno"> 1088</span>&#160;<span class="comment">   /**</span></div>

  1160. <div class="line"><a name="l01089"></a><span class="lineno"> 1089</span>&#160;<span class="comment">      Set the name of the program @a index.@n</span></div>

  1161. <div class="line"><a name="l01090"></a><span class="lineno"> 1090</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.@n</span></div>

  1162. <div class="line"><a name="l01091"></a><span class="lineno"> 1091</span>&#160;<span class="comment">      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.</span></div>

  1163. <div class="line"><a name="l01092"></a><span class="lineno"> 1092</span>&#160;<span class="comment">    */</span></div>

  1164. <div class="line"><a name="l01093"></a><span class="lineno"><a class="line" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b"> 1093</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">initProgramName</a>(uint32_t index, <a class="code" href="classString.html">String</a>&amp; programName) = 0;</div>

  1165. <div class="line"><a name="l01094"></a><span class="lineno"> 1094</span>&#160;<span class="preprocessor">#endif</span></div>

  1166. <div class="line"><a name="l01095"></a><span class="lineno"> 1095</span>&#160; </div>

  1167. <div class="line"><a name="l01096"></a><span class="lineno"> 1096</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span><span class="comment"></span></div>

  1168. <div class="line"><a name="l01097"></a><span class="lineno"> 1097</span>&#160;<span class="comment">   /**</span></div>

  1169. <div class="line"><a name="l01098"></a><span class="lineno"> 1098</span>&#160;<span class="comment">      Initialize the state @a index.@n</span></div>

  1170. <div class="line"><a name="l01099"></a><span class="lineno"> 1099</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.@n</span></div>

  1171. <div class="line"><a name="l01100"></a><span class="lineno"> 1100</span>&#160;<span class="comment">      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.</span></div>

  1172. <div class="line"><a name="l01101"></a><span class="lineno"> 1101</span>&#160;<span class="comment">    */</span></div>

  1173. <div class="line"><a name="l01102"></a><span class="lineno"><a class="line" href="classPlugin.html#ad4ab623187f905c250a42284704eb840"> 1102</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ad4ab623187f905c250a42284704eb840">initState</a>(uint32_t index, <a class="code" href="structState.html">State</a>&amp; state);</div>

  1174. <div class="line"><a name="l01103"></a><span class="lineno"> 1103</span>&#160; </div>

  1175. <div class="line"><a name="l01104"></a><span class="lineno"> 1104</span>&#160;    DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;initState(uint32_t,State&amp;)&quot;</span>)</div>

  1176. <div class="line"><a name="l01105"></a><span class="lineno"> 1105</span>&#160;    virtual <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ad4ab623187f905c250a42284704eb840">initState</a>(uint32_t, <a class="code" href="classString.html">String</a>&amp;, <a class="code" href="classString.html">String</a>&amp;) {}</div>

  1177. <div class="line"><a name="l01106"></a><span class="lineno"> 1106</span>&#160; </div>

  1178. <div class="line"><a name="l01107"></a><span class="lineno"> 1107</span>&#160;    DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;initState(uint32_t,State&amp;)&quot;</span>)</div>

  1179. <div class="line"><a name="l01108"></a><span class="lineno"> 1108</span>&#160;    virtual <span class="keywordtype">bool</span> isStateFile(uint32_t) { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>

  1180. <div class="line"><a name="l01109"></a><span class="lineno"> 1109</span>&#160;<span class="preprocessor">#endif</span></div>

  1181. <div class="line"><a name="l01110"></a><span class="lineno"> 1110</span>&#160; </div>

  1182. <div class="line"><a name="l01111"></a><span class="lineno"> 1111</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  1183. <div class="line"><a name="l01112"></a><span class="lineno"> 1112</span>&#160;<span class="comment">    * Internal data */</span></div>

  1184. <div class="line"><a name="l01113"></a><span class="lineno"> 1113</span>&#160;<span class="comment"></span> </div>

  1185. <div class="line"><a name="l01114"></a><span class="lineno"> 1114</span>&#160;<span class="comment">   /**</span></div>

  1186. <div class="line"><a name="l01115"></a><span class="lineno"> 1115</span>&#160;<span class="comment">      Get the current value of a parameter.@n</span></div>

  1187. <div class="line"><a name="l01116"></a><span class="lineno"> 1116</span>&#160;<span class="comment">      The host may call this function from any context, including realtime processing.</span></div>

  1188. <div class="line"><a name="l01117"></a><span class="lineno"> 1117</span>&#160;<span class="comment">    */</span></div>

  1189. <div class="line"><a name="l01118"></a><span class="lineno"><a class="line" href="classPlugin.html#af9e9f5438e2e0c2352052eb5f95832aa"> 1118</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classPlugin.html#af9e9f5438e2e0c2352052eb5f95832aa">getParameterValue</a>(uint32_t index) <span class="keyword">const</span>;</div>

  1190. <div class="line"><a name="l01119"></a><span class="lineno"> 1119</span>&#160;<span class="comment"></span> </div>

  1191. <div class="line"><a name="l01120"></a><span class="lineno"> 1120</span>&#160;<span class="comment">   /**</span></div>

  1192. <div class="line"><a name="l01121"></a><span class="lineno"> 1121</span>&#160;<span class="comment">      Change a parameter value.@n</span></div>

  1193. <div class="line"><a name="l01122"></a><span class="lineno"> 1122</span>&#160;<span class="comment">      The host may call this function from any context, including realtime processing.@n</span></div>

  1194. <div class="line"><a name="l01123"></a><span class="lineno"> 1123</span>&#160;<span class="comment">      When a parameter is marked as automatable, you must ensure no non-realtime operations are performed.</span></div>

  1195. <div class="line"><a name="l01124"></a><span class="lineno"> 1124</span>&#160;<span class="comment">      @note This function will only be called for parameter inputs.</span></div>

  1196. <div class="line"><a name="l01125"></a><span class="lineno"> 1125</span>&#160;<span class="comment">    */</span></div>

  1197. <div class="line"><a name="l01126"></a><span class="lineno"><a class="line" href="classPlugin.html#a7e9e26ceafc7603ef6163483a9dc39be"> 1126</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a7e9e26ceafc7603ef6163483a9dc39be">setParameterValue</a>(uint32_t index, <span class="keywordtype">float</span> value);</div>

  1198. <div class="line"><a name="l01127"></a><span class="lineno"> 1127</span>&#160; </div>

  1199. <div class="line"><a name="l01128"></a><span class="lineno"> 1128</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span><span class="comment"></span></div>

  1200. <div class="line"><a name="l01129"></a><span class="lineno"> 1129</span>&#160;<span class="comment">   /**</span></div>

  1201. <div class="line"><a name="l01130"></a><span class="lineno"> 1130</span>&#160;<span class="comment">      Load a program.@n</span></div>

  1202. <div class="line"><a name="l01131"></a><span class="lineno"> 1131</span>&#160;<span class="comment">      The host may call this function from any context, including realtime processing.@n</span></div>

  1203. <div class="line"><a name="l01132"></a><span class="lineno"> 1132</span>&#160;<span class="comment">      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.</span></div>

  1204. <div class="line"><a name="l01133"></a><span class="lineno"> 1133</span>&#160;<span class="comment">    */</span></div>

  1205. <div class="line"><a name="l01134"></a><span class="lineno"><a class="line" href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8"> 1134</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8">loadProgram</a>(uint32_t index);</div>

  1206. <div class="line"><a name="l01135"></a><span class="lineno"> 1135</span>&#160;<span class="preprocessor">#endif</span></div>

  1207. <div class="line"><a name="l01136"></a><span class="lineno"> 1136</span>&#160; </div>

  1208. <div class="line"><a name="l01137"></a><span class="lineno"> 1137</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_FULL_STATE</span><span class="comment"></span></div>

  1209. <div class="line"><a name="l01138"></a><span class="lineno"> 1138</span>&#160;<span class="comment">   /**</span></div>

  1210. <div class="line"><a name="l01139"></a><span class="lineno"> 1139</span>&#160;<span class="comment">      Get the value of an internal state.@n</span></div>

  1211. <div class="line"><a name="l01140"></a><span class="lineno"> 1140</span>&#160;<span class="comment">      The host may call this function from any non-realtime context.@n</span></div>

  1212. <div class="line"><a name="l01141"></a><span class="lineno"> 1141</span>&#160;<span class="comment">      Must be implemented by your plugin class if DISTRHO_PLUGIN_WANT_FULL_STATE is enabled.</span></div>

  1213. <div class="line"><a name="l01142"></a><span class="lineno"> 1142</span>&#160;<span class="comment">      @note The use of this function breaks compatibility with the DSSI format.</span></div>

  1214. <div class="line"><a name="l01143"></a><span class="lineno"> 1143</span>&#160;<span class="comment">    */</span></div>

  1215. <div class="line"><a name="l01144"></a><span class="lineno"><a class="line" href="classPlugin.html#a9cf24d4880f200eaeacd08a591d00d1f"> 1144</a></span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classString.html">String</a> <a class="code" href="classPlugin.html#a9cf24d4880f200eaeacd08a591d00d1f">getState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key) <span class="keyword">const</span>;</div>

  1216. <div class="line"><a name="l01145"></a><span class="lineno"> 1145</span>&#160;<span class="preprocessor">#endif</span></div>

  1217. <div class="line"><a name="l01146"></a><span class="lineno"> 1146</span>&#160; </div>

  1218. <div class="line"><a name="l01147"></a><span class="lineno"> 1147</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span><span class="comment"></span></div>

  1219. <div class="line"><a name="l01148"></a><span class="lineno"> 1148</span>&#160;<span class="comment">   /**</span></div>

  1220. <div class="line"><a name="l01149"></a><span class="lineno"> 1149</span>&#160;<span class="comment">      Change an internal state @a key to @a value.@n</span></div>

  1221. <div class="line"><a name="l01150"></a><span class="lineno"> 1150</span>&#160;<span class="comment">      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.</span></div>

  1222. <div class="line"><a name="l01151"></a><span class="lineno"> 1151</span>&#160;<span class="comment">    */</span></div>

  1223. <div class="line"><a name="l01152"></a><span class="lineno"><a class="line" href="classPlugin.html#afcbb504b824bacea622de9bac09b2331"> 1152</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">setState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value);</div>

  1224. <div class="line"><a name="l01153"></a><span class="lineno"> 1153</span>&#160;<span class="preprocessor">#endif</span></div>

  1225. <div class="line"><a name="l01154"></a><span class="lineno"> 1154</span>&#160; </div>

  1226. <div class="line"><a name="l01155"></a><span class="lineno"> 1155</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  1227. <div class="line"><a name="l01156"></a><span class="lineno"> 1156</span>&#160;<span class="comment">    * Audio/MIDI Processing */</span></div>

  1228. <div class="line"><a name="l01157"></a><span class="lineno"> 1157</span>&#160;<span class="comment"></span> </div>

  1229. <div class="line"><a name="l01158"></a><span class="lineno"> 1158</span>&#160;<span class="comment">   /**</span></div>

  1230. <div class="line"><a name="l01159"></a><span class="lineno"> 1159</span>&#160;<span class="comment">      Activate this plugin.</span></div>

  1231. <div class="line"><a name="l01160"></a><span class="lineno"> 1160</span>&#160;<span class="comment">    */</span></div>

  1232. <div class="line"><a name="l01161"></a><span class="lineno"><a class="line" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c"> 1161</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">activate</a>() {}</div>

  1233. <div class="line"><a name="l01162"></a><span class="lineno"> 1162</span>&#160;<span class="comment"></span> </div>

  1234. <div class="line"><a name="l01163"></a><span class="lineno"> 1163</span>&#160;<span class="comment">   /**</span></div>

  1235. <div class="line"><a name="l01164"></a><span class="lineno"> 1164</span>&#160;<span class="comment">      Deactivate this plugin.</span></div>

  1236. <div class="line"><a name="l01165"></a><span class="lineno"> 1165</span>&#160;<span class="comment">    */</span></div>

  1237. <div class="line"><a name="l01166"></a><span class="lineno"><a class="line" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46"> 1166</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46">deactivate</a>() {}</div>

  1238. <div class="line"><a name="l01167"></a><span class="lineno"> 1167</span>&#160; </div>

  1239. <div class="line"><a name="l01168"></a><span class="lineno"> 1168</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_INPUT</span><span class="comment"></span></div>

  1240. <div class="line"><a name="l01169"></a><span class="lineno"> 1169</span>&#160;<span class="comment">   /**</span></div>

  1241. <div class="line"><a name="l01170"></a><span class="lineno"> 1170</span>&#160;<span class="comment">      Run/process function for plugins with MIDI input.</span></div>

  1242. <div class="line"><a name="l01171"></a><span class="lineno"> 1171</span>&#160;<span class="comment">      @note Some parameters might be null if there are no audio inputs/outputs or MIDI events.</span></div>

  1243. <div class="line"><a name="l01172"></a><span class="lineno"> 1172</span>&#160;<span class="comment">    */</span></div>

  1244. <div class="line"><a name="l01173"></a><span class="lineno"><a class="line" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6"> 1173</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames,</div>

  1245. <div class="line"><a name="l01174"></a><span class="lineno"> 1174</span>&#160;                     <span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>* midiEvents, uint32_t midiEventCount) = 0;</div>

  1246. <div class="line"><a name="l01175"></a><span class="lineno"> 1175</span>&#160;<span class="preprocessor">#else</span><span class="comment"></span></div>

  1247. <div class="line"><a name="l01176"></a><span class="lineno"> 1176</span>&#160;<span class="comment">   /**</span></div>

  1248. <div class="line"><a name="l01177"></a><span class="lineno"> 1177</span>&#160;<span class="comment">      Run/process function for plugins without MIDI input.</span></div>

  1249. <div class="line"><a name="l01178"></a><span class="lineno"> 1178</span>&#160;<span class="comment">      @note Some parameters might be null if there are no audio inputs or outputs.</span></div>

  1250. <div class="line"><a name="l01179"></a><span class="lineno"> 1179</span>&#160;<span class="comment">    */</span></div>

  1251. <div class="line"><a name="l01180"></a><span class="lineno"> 1180</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames) = 0;</div>

  1252. <div class="line"><a name="l01181"></a><span class="lineno"> 1181</span>&#160;<span class="preprocessor">#endif</span></div>

  1253. <div class="line"><a name="l01182"></a><span class="lineno"> 1182</span>&#160; </div>

  1254. <div class="line"><a name="l01183"></a><span class="lineno"> 1183</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  1255. <div class="line"><a name="l01184"></a><span class="lineno"> 1184</span>&#160;<span class="comment">    * Callbacks (optional) */</span></div>

  1256. <div class="line"><a name="l01185"></a><span class="lineno"> 1185</span>&#160;<span class="comment"></span> </div>

  1257. <div class="line"><a name="l01186"></a><span class="lineno"> 1186</span>&#160;<span class="comment">   /**</span></div>

  1258. <div class="line"><a name="l01187"></a><span class="lineno"> 1187</span>&#160;<span class="comment">      Optional callback to inform the plugin about a buffer size change.@n</span></div>

  1259. <div class="line"><a name="l01188"></a><span class="lineno"> 1188</span>&#160;<span class="comment">      This function will only be called when the plugin is deactivated.</span></div>

  1260. <div class="line"><a name="l01189"></a><span class="lineno"> 1189</span>&#160;<span class="comment">      @note This value is only a hint!@n</span></div>

  1261. <div class="line"><a name="l01190"></a><span class="lineno"> 1190</span>&#160;<span class="comment">            Hosts might call run() with a higher or lower number of frames.</span></div>

  1262. <div class="line"><a name="l01191"></a><span class="lineno"> 1191</span>&#160;<span class="comment">      @see getBufferSize()</span></div>

  1263. <div class="line"><a name="l01192"></a><span class="lineno"> 1192</span>&#160;<span class="comment">    */</span></div>

  1264. <div class="line"><a name="l01193"></a><span class="lineno"><a class="line" href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297"> 1193</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297">bufferSizeChanged</a>(uint32_t newBufferSize);</div>

  1265. <div class="line"><a name="l01194"></a><span class="lineno"> 1194</span>&#160;<span class="comment"></span> </div>

  1266. <div class="line"><a name="l01195"></a><span class="lineno"> 1195</span>&#160;<span class="comment">   /**</span></div>

  1267. <div class="line"><a name="l01196"></a><span class="lineno"> 1196</span>&#160;<span class="comment">      Optional callback to inform the plugin about a sample rate change.@n</span></div>

  1268. <div class="line"><a name="l01197"></a><span class="lineno"> 1197</span>&#160;<span class="comment">      This function will only be called when the plugin is deactivated.</span></div>

  1269. <div class="line"><a name="l01198"></a><span class="lineno"> 1198</span>&#160;<span class="comment">      @see getSampleRate()</span></div>

  1270. <div class="line"><a name="l01199"></a><span class="lineno"> 1199</span>&#160;<span class="comment">    */</span></div>

  1271. <div class="line"><a name="l01200"></a><span class="lineno"><a class="line" href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc"> 1200</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc">sampleRateChanged</a>(<span class="keywordtype">double</span> newSampleRate);</div>

  1272. <div class="line"><a name="l01201"></a><span class="lineno"> 1201</span>&#160; </div>

  1273. <div class="line"><a name="l01202"></a><span class="lineno"> 1202</span>&#160;    <span class="comment">// -------------------------------------------------------------------------------------------------------</span></div>

  1274. <div class="line"><a name="l01203"></a><span class="lineno"> 1203</span>&#160; </div>

  1275. <div class="line"><a name="l01204"></a><span class="lineno"> 1204</span>&#160;<span class="keyword">private</span>:</div>

  1276. <div class="line"><a name="l01205"></a><span class="lineno"> 1205</span>&#160;    <span class="keyword">struct </span>PrivateData;</div>

  1277. <div class="line"><a name="l01206"></a><span class="lineno"> 1206</span>&#160;    PrivateData* <span class="keyword">const</span> pData;</div>

  1278. <div class="line"><a name="l01207"></a><span class="lineno"> 1207</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span>PluginExporter;</div>

  1279. <div class="line"><a name="l01208"></a><span class="lineno"> 1208</span>&#160; </div>

  1280. <div class="line"><a name="l01209"></a><span class="lineno"> 1209</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classPlugin.html">Plugin</a>)</div>

  1281. <div class="line"><a name="l01210"></a><span class="lineno"> 1210</span>&#160;};</div>

  1282. <div class="line"><a name="l01211"></a><span class="lineno"> 1211</span>&#160;<span class="comment"></span> </div>

  1283. <div class="line"><a name="l01212"></a><span class="lineno"> 1212</span>&#160;<span class="comment">/** @} */</span></div>

  1284. <div class="line"><a name="l01213"></a><span class="lineno"> 1213</span>&#160; </div>

  1285. <div class="line"><a name="l01214"></a><span class="lineno"> 1214</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  1286. <div class="line"><a name="l01215"></a><span class="lineno"> 1215</span>&#160;<span class="comment"> * Create plugin, entry point */</span></div>

  1287. <div class="line"><a name="l01216"></a><span class="lineno"> 1216</span>&#160;<span class="comment"></span> </div>

  1288. <div class="line"><a name="l01217"></a><span class="lineno"> 1217</span>&#160;<span class="comment">/**</span></div>

  1289. <div class="line"><a name="l01218"></a><span class="lineno"> 1218</span>&#160;<span class="comment">   @defgroup EntryPoints Entry Points</span></div>

  1290. <div class="line"><a name="l01219"></a><span class="lineno"> 1219</span>&#160;<span class="comment">   @{</span></div>

  1291. <div class="line"><a name="l01220"></a><span class="lineno"> 1220</span>&#160;<span class="comment"> */</span></div>

  1292. <div class="line"><a name="l01221"></a><span class="lineno"> 1221</span>&#160;<span class="comment"></span> </div>

  1293. <div class="line"><a name="l01222"></a><span class="lineno"> 1222</span>&#160;<span class="comment">/**</span></div>

  1294. <div class="line"><a name="l01223"></a><span class="lineno"> 1223</span>&#160;<span class="comment">   Create an instance of the Plugin class.@n</span></div>

  1295. <div class="line"><a name="l01224"></a><span class="lineno"> 1224</span>&#160;<span class="comment">   This is the entry point for DPF plugins.@n</span></div>

  1296. <div class="line"><a name="l01225"></a><span class="lineno"> 1225</span>&#160;<span class="comment">   DPF will call this to either create an instance of your plugin for the host</span></div>

  1297. <div class="line"><a name="l01226"></a><span class="lineno"> 1226</span>&#160;<span class="comment">   or to fetch some initial information for internal caching.</span></div>

  1298. <div class="line"><a name="l01227"></a><span class="lineno"> 1227</span>&#160;<span class="comment"> */</span></div>

  1299. <div class="line"><a name="l01228"></a><span class="lineno"><a class="line" href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee"> 1228</a></span>&#160;<span class="keyword">extern</span> <a class="code" href="classPlugin.html">Plugin</a>* <a class="code" href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee">createPlugin</a>();</div>

  1300. <div class="line"><a name="l01229"></a><span class="lineno"> 1229</span>&#160;<span class="comment"></span> </div>

  1301. <div class="line"><a name="l01230"></a><span class="lineno"> 1230</span>&#160;<span class="comment">/** @} */</span></div>

  1302. <div class="line"><a name="l01231"></a><span class="lineno"> 1231</span>&#160; </div>

  1303. <div class="line"><a name="l01232"></a><span class="lineno"> 1232</span>&#160;<span class="comment">// -----------------------------------------------------------------------------------------------------------</span></div>

  1304. <div class="line"><a name="l01233"></a><span class="lineno"> 1233</span>&#160; </div>

  1305. <div class="line"><a name="l01234"></a><span class="lineno"> 1234</span>&#160;<a class="code" href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div>

  1306. <div class="line"><a name="l01235"></a><span class="lineno"> 1235</span>&#160; </div>

  1307. <div class="line"><a name="l01236"></a><span class="lineno"> 1236</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// DISTRHO_PLUGIN_HPP_INCLUDED</span></div>

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

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

  1310. <div class="ttc" id="aclassPlugin_html_a0467eef817ac130cbbe1c0fbe09660c6"><div class="ttname"><a href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">Plugin::writeMidiEvent</a></div><div class="ttdeci">bool writeMidiEvent(const MidiEvent &amp;midiEvent) noexcept</div></div>

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

  1312. <div class="ttc" id="aclassPlugin_html_a2643e638f62cfd4990247ec66bed60d2"><div class="ttname"><a href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">Plugin::getBufferSize</a></div><div class="ttdeci">uint32_t getBufferSize() const noexcept</div></div>

  1313. <div class="ttc" id="aclassPlugin_html_a2a70c4ec55d74d9bc26862975d8df8a7"><div class="ttname"><a href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">Plugin::setLatency</a></div><div class="ttdeci">void setLatency(uint32_t frames) noexcept</div></div>

  1314. <div class="ttc" id="aclassPlugin_html_a2fcbfa1893f44e661d0d8cd53391dadc"><div class="ttname"><a href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc">Plugin::sampleRateChanged</a></div><div class="ttdeci">virtual void sampleRateChanged(double newSampleRate)</div></div>

  1315. <div class="ttc" id="aclassPlugin_html_a30db5eef9de617f4c81d5c6925facea3"><div class="ttname"><a href="classPlugin.html#a30db5eef9de617f4c81d5c6925facea3">Plugin::getDescription</a></div><div class="ttdeci">virtual const char * getDescription() const</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:1033</div></div>

  1316. <div class="ttc" id="aclassPlugin_html_a3e162cfe8f1c52bf09805fd327bcc3c4"><div class="ttname"><a href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">Plugin::getSampleRate</a></div><div class="ttdeci">double getSampleRate() const noexcept</div></div>

  1317. <div class="ttc" id="aclassPlugin_html_a44eb1bfcc3a3e5949ad053fc9ce55ce8"><div class="ttname"><a href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8">Plugin::loadProgram</a></div><div class="ttdeci">virtual void loadProgram(uint32_t index)</div></div>

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

  1319. <div class="ttc" id="aclassPlugin_html_a581614e1d301ee613a988855c61b2517"><div class="ttname"><a href="classPlugin.html#a581614e1d301ee613a988855c61b2517">Plugin::canRequestParameterValueChanges</a></div><div class="ttdeci">bool canRequestParameterValueChanges() const noexcept</div></div>

  1320. <div class="ttc" id="aclassPlugin_html_a5fd60c82f5a50f12312c57729885fc2f"><div class="ttname"><a href="classPlugin.html#a5fd60c82f5a50f12312c57729885fc2f">Plugin::getBundlePath</a></div><div class="ttdeci">const char * getBundlePath() const noexcept</div></div>

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

  1322. <div class="ttc" id="aclassPlugin_html_a71b876c8157b087b3552960f2877a44d"><div class="ttname"><a href="classPlugin.html#a71b876c8157b087b3552960f2877a44d">Plugin::initPortGroup</a></div><div class="ttdeci">virtual void initPortGroup(uint32_t groupId, PortGroup &amp;portGroup)</div></div>

  1323. <div class="ttc" id="aclassPlugin_html_a75f30935198a0acba25f4ea92af72dc4"><div class="ttname"><a href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">Plugin::initAudioPort</a></div><div class="ttdeci">virtual void initAudioPort(bool input, uint32_t index, AudioPort &amp;port)</div></div>

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

  1325. <div class="ttc" id="aclassPlugin_html_a89814b8f0b1c91e49140d42eb8331383"><div class="ttname"><a href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">Plugin::~Plugin</a></div><div class="ttdeci">virtual ~Plugin()</div></div>

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

  1327. <div class="ttc" id="aclassPlugin_html_a9cf24d4880f200eaeacd08a591d00d1f"><div class="ttname"><a href="classPlugin.html#a9cf24d4880f200eaeacd08a591d00d1f">Plugin::getState</a></div><div class="ttdeci">virtual String getState(const char *key) const</div></div>

  1328. <div class="ttc" id="aclassPlugin_html_a9f6c8ad6b054056649d0250e527e1297"><div class="ttname"><a href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297">Plugin::bufferSizeChanged</a></div><div class="ttdeci">virtual void bufferSizeChanged(uint32_t newBufferSize)</div></div>

  1329. <div class="ttc" id="aclassPlugin_html_aa089a56572bc8f1cb7e4b538c0d19c46"><div class="ttname"><a href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46">Plugin::deactivate</a></div><div class="ttdeci">virtual void deactivate()</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:1166</div></div>

  1330. <div class="ttc" id="aclassPlugin_html_aa5c1262f5ca20536bb5850fdd6faa22c"><div class="ttname"><a href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">Plugin::activate</a></div><div class="ttdeci">virtual void activate()</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:1161</div></div>

  1331. <div class="ttc" id="aclassPlugin_html_aa85c50c732d9083f57b72d6b4cd7c5ae"><div class="ttname"><a href="classPlugin.html#aa85c50c732d9083f57b72d6b4cd7c5ae">Plugin::updateStateValue</a></div><div class="ttdeci">bool updateStateValue(const char *key, const char *value) noexcept</div></div>

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

  1333. <div class="ttc" id="aclassPlugin_html_ab2c6b7bc2e0cdcd589cf9d03be831042"><div class="ttname"><a href="classPlugin.html#ab2c6b7bc2e0cdcd589cf9d03be831042">Plugin::isDummyInstance</a></div><div class="ttdeci">bool isDummyInstance() const noexcept</div></div>

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

  1335. <div class="ttc" id="aclassPlugin_html_acb5a3632da5a5c4110172a3a78e1fd32"><div class="ttname"><a href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin::Plugin</a></div><div class="ttdeci">Plugin(uint32_t parameterCount, uint32_t programCount, uint32_t stateCount)</div></div>

  1336. <div class="ttc" id="aclassPlugin_html_ad12c681ce31004da0badd609763f45c5"><div class="ttname"><a href="classPlugin.html#ad12c681ce31004da0badd609763f45c5">Plugin::getHomePage</a></div><div class="ttdeci">virtual const char * getHomePage() const</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:1044</div></div>

  1337. <div class="ttc" id="aclassPlugin_html_ad4ab623187f905c250a42284704eb840"><div class="ttname"><a href="classPlugin.html#ad4ab623187f905c250a42284704eb840">Plugin::initState</a></div><div class="ttdeci">virtual void initState(uint32_t index, State &amp;state)</div></div>

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

  1339. <div class="ttc" id="aclassPlugin_html_ae65d8603022c09d1ce2ee5cf568de70f"><div class="ttname"><a href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">Plugin::requestParameterValueChange</a></div><div class="ttdeci">bool requestParameterValueChange(uint32_t index, float value) noexcept</div></div>

  1340. <div class="ttc" id="aclassPlugin_html_ae85d602c430b1a4361a88d714d3a42c1"><div class="ttname"><a href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">Plugin::getTimePosition</a></div><div class="ttdeci">const TimePosition &amp; getTimePosition() const noexcept</div></div>

  1341. <div class="ttc" id="aclassPlugin_html_aebb5df5cde162462dc460d4fd45dae75"><div class="ttname"><a href="classPlugin.html#aebb5df5cde162462dc460d4fd45dae75">Plugin::getName</a></div><div class="ttdeci">virtual const char * getName() const</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:1021</div></div>

  1342. <div class="ttc" id="aclassPlugin_html_af9e9f5438e2e0c2352052eb5f95832aa"><div class="ttname"><a href="classPlugin.html#af9e9f5438e2e0c2352052eb5f95832aa">Plugin::getParameterValue</a></div><div class="ttdeci">virtual float getParameterValue(uint32_t index) const</div></div>

  1343. <div class="ttc" id="aclassPlugin_html_afcbb504b824bacea622de9bac09b2331"><div class="ttname"><a href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">Plugin::setState</a></div><div class="ttdeci">virtual void setState(const char *key, const char *value)</div></div>

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

  1345. <div class="ttc" id="agroup__AudioPortHints_html_ga0919fac232ec9c6999057b09d54e3919"><div class="ttname"><a href="group__AudioPortHints.html#ga0919fac232ec9c6999057b09d54e3919">kCVPortHasPositiveUnipolarRange</a></div><div class="ttdeci">static const uint32_t kCVPortHasPositiveUnipolarRange</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:65</div></div>

  1346. <div class="ttc" id="agroup__AudioPortHints_html_ga7133899b77b31caa1eae3fe77409e69e"><div class="ttname"><a href="group__AudioPortHints.html#ga7133899b77b31caa1eae3fe77409e69e">kCVPortHasBipolarRange</a></div><div class="ttdeci">static const uint32_t kCVPortHasBipolarRange</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:53</div></div>

  1347. <div class="ttc" id="agroup__AudioPortHints_html_ga92c8a0135d1b6dacd22df25295c15ff3"><div class="ttname"><a href="group__AudioPortHints.html#ga92c8a0135d1b6dacd22df25295c15ff3">kAudioPortIsCV</a></div><div class="ttdeci">static const uint32_t kAudioPortIsCV</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:40</div></div>

  1348. <div class="ttc" id="agroup__AudioPortHints_html_gae36eb55fe0813af0dd6cdfe4f7baae97"><div class="ttname"><a href="group__AudioPortHints.html#gae36eb55fe0813af0dd6cdfe4f7baae97">kCVPortHasScaledRange</a></div><div class="ttdeci">static const uint32_t kCVPortHasScaledRange</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:73</div></div>

  1349. <div class="ttc" id="agroup__AudioPortHints_html_gafa444d8a3d5244e107c2ddb19f60105d"><div class="ttname"><a href="group__AudioPortHints.html#gafa444d8a3d5244e107c2ddb19f60105d">kCVPortHasNegativeUnipolarRange</a></div><div class="ttdeci">static const uint32_t kCVPortHasNegativeUnipolarRange</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:59</div></div>

  1350. <div class="ttc" id="agroup__AudioPortHints_html_gafbf1a5255d0a19f35ae21480ab2c7433"><div class="ttname"><a href="group__AudioPortHints.html#gafbf1a5255d0a19f35ae21480ab2c7433">kAudioPortIsSidechain</a></div><div class="ttdeci">static const uint32_t kAudioPortIsSidechain</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:47</div></div>

  1351. <div class="ttc" id="agroup__BasePluginStructs_html_ga177ca6eb2528109ec4a130a643e8c70a"><div class="ttname"><a href="group__BasePluginStructs.html#ga177ca6eb2528109ec4a130a643e8c70a">PredefinedPortGroupsIds</a></div><div class="ttdeci">PredefinedPortGroupsIds</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:224</div></div>

  1352. <div class="ttc" id="agroup__BasePluginStructs_html_ga9a7e733c40008f92e96e2ccf24f890de"><div class="ttname"><a href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a></div><div class="ttdeci">ParameterDesignation</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:202</div></div>

  1353. <div class="ttc" id="agroup__BasePluginStructs_html_gga177ca6eb2528109ec4a130a643e8c70aa0f890fe6310b119745b6c6cb409c5fe9"><div class="ttname"><a href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aa0f890fe6310b119745b6c6cb409c5fe9">kPortGroupMono</a></div><div class="ttdeci">@ kPortGroupMono</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:233</div></div>

  1354. <div class="ttc" id="agroup__BasePluginStructs_html_gga177ca6eb2528109ec4a130a643e8c70aaea27aed9948a2aaf4978941c96df3932"><div class="ttname"><a href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaea27aed9948a2aaf4978941c96df3932">kPortGroupNone</a></div><div class="ttdeci">@ kPortGroupNone</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:228</div></div>

  1355. <div class="ttc" id="agroup__BasePluginStructs_html_gga177ca6eb2528109ec4a130a643e8c70aaeefc1b206ffdedf67376156cf6e5d114"><div class="ttname"><a href="group__BasePluginStructs.html#gga177ca6eb2528109ec4a130a643e8c70aaeefc1b206ffdedf67376156cf6e5d114">kPortGroupStereo</a></div><div class="ttdeci">@ kPortGroupStereo</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:239</div></div>

  1356. <div class="ttc" id="agroup__BasePluginStructs_html_gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b"><div class="ttname"><a href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">kParameterDesignationBypass</a></div><div class="ttdeci">@ kParameterDesignationBypass</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:212</div></div>

  1357. <div class="ttc" id="agroup__BasePluginStructs_html_gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401"><div class="ttname"><a href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a></div><div class="ttdeci">@ kParameterDesignationNull</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:206</div></div>

  1358. <div class="ttc" id="agroup__EntryPoints_html_ga87f1fa9084f2490ca04ea733292c6dee"><div class="ttname"><a href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee">createPlugin</a></div><div class="ttdeci">Plugin * createPlugin()</div></div>

  1359. <div class="ttc" id="agroup__NamespaceMacros_html_ga3ff541a449593e069a29e92d21e38ef3"><div class="ttname"><a href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define END_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:834</div></div>

  1360. <div class="ttc" id="agroup__NamespaceMacros_html_gac4cb97c393d20c28ba19365d844341cd"><div class="ttname"><a href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define START_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:828</div></div>

  1361. <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:96</div></div>

  1362. <div class="ttc" id="agroup__ParameterHints_html_ga068de47c587411c9e91ef09f7d800884"><div class="ttname"><a href="group__ParameterHints.html#ga068de47c587411c9e91ef09f7d800884">kParameterIsTrigger</a></div><div class="ttdeci">static const uint32_t kParameterIsTrigger</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:134</div></div>

  1363. <div class="ttc" id="agroup__ParameterHints_html_ga0a3633c93e8589f4b3e6124bb97ad8d4"><div class="ttname"><a href="group__ParameterHints.html#ga0a3633c93e8589f4b3e6124bb97ad8d4">kParameterIsOutput</a></div><div class="ttdeci">static const uint32_t kParameterIsOutput</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:125</div></div>

  1364. <div class="ttc" id="agroup__ParameterHints_html_ga6d39267b105c2d8dfc82a810c5e8a061"><div class="ttname"><a href="group__ParameterHints.html#ga6d39267b105c2d8dfc82a810c5e8a061">kParameterIsAutomatable</a></div><div class="ttdeci">static const uint32_t kParameterIsAutomatable</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:92</div></div>

  1365. <div class="ttc" id="agroup__ParameterHints_html_ga76a82c93efe6ad728c9f0cb4ef33a2b9"><div class="ttname"><a href="group__ParameterHints.html#ga76a82c93efe6ad728c9f0cb4ef33a2b9">kParameterIsInteger</a></div><div class="ttdeci">static const uint32_t kParameterIsInteger</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:107</div></div>

  1366. <div class="ttc" id="agroup__ParameterHints_html_gaafca30df903781d2e1c2491808e17c8d"><div class="ttname"><a href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a></div><div class="ttdeci">static const uint32_t kParameterIsBoolean</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:102</div></div>

  1367. <div class="ttc" id="agroup__ParameterHints_html_gabc539ecbfe420246a33f93aed32b8a3b"><div class="ttname"><a href="group__ParameterHints.html#gabc539ecbfe420246a33f93aed32b8a3b">kParameterIsLogarithmic</a></div><div class="ttdeci">static const uint32_t kParameterIsLogarithmic</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:112</div></div>

  1368. <div class="ttc" id="agroup__PluginMacros_html_ga888482a9f695c2ca2f433e5f3172dcc4"><div class="ttname"><a href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a></div><div class="ttdeci">#define DISTRHO_PLUGIN_NAME</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:481</div></div>

  1369. <div class="ttc" id="agroup__StateHints_html_ga1e7299b8d4c8c1fc57bceef2b87fe057"><div class="ttname"><a href="group__StateHints.html#ga1e7299b8d4c8c1fc57bceef2b87fe057">kStateIsOnlyForDSP</a></div><div class="ttdeci">static const uint32_t kStateIsOnlyForDSP</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:174</div></div>

  1370. <div class="ttc" id="agroup__StateHints_html_ga57437781c616c82bcb9e409433b7f16d"><div class="ttname"><a href="group__StateHints.html#ga57437781c616c82bcb9e409433b7f16d">kStateIsHostWritable</a></div><div class="ttdeci">static const uint32_t kStateIsHostWritable</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:158</div></div>

  1371. <div class="ttc" id="agroup__StateHints_html_ga7d960ebb437726e25066b5e38b4a4843"><div class="ttname"><a href="group__StateHints.html#ga7d960ebb437726e25066b5e38b4a4843">kStateIsOnlyForUI</a></div><div class="ttdeci">static const uint32_t kStateIsOnlyForUI</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:180</div></div>

  1372. <div class="ttc" id="agroup__StateHints_html_gacbcc437321d85ca23d692b68802a0165"><div class="ttname"><a href="group__StateHints.html#gacbcc437321d85ca23d692b68802a0165">kStateIsHostReadable</a></div><div class="ttdeci">static const uint32_t kStateIsHostReadable</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:152</div></div>

  1373. <div class="ttc" id="agroup__StateHints_html_gad07fa3f1fd8ca36e94f75518d9d3d29e"><div class="ttname"><a href="group__StateHints.html#gad07fa3f1fd8ca36e94f75518d9d3d29e">kStateIsBase64Blob</a></div><div class="ttdeci">static const uint32_t kStateIsBase64Blob</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:169</div></div>

  1374. <div class="ttc" id="agroup__StateHints_html_gaea57e1af2af673c2647757335d2d3751"><div class="ttname"><a href="group__StateHints.html#gaea57e1af2af673c2647757335d2d3751">kStateIsFilenamePath</a></div><div class="ttdeci">static const uint32_t kStateIsFilenamePath</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:164</div></div>

  1375. <div class="ttc" id="astructAudioPort_html"><div class="ttname"><a href="structAudioPort.html">AudioPort</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:248</div></div>

  1376. <div class="ttc" id="astructAudioPort_html_a80aba3da64389d738bd8ae68bcedb4f4"><div class="ttname"><a href="structAudioPort.html#a80aba3da64389d738bd8ae68bcedb4f4">AudioPort::groupId</a></div><div class="ttdeci">uint32_t groupId</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:278</div></div>

  1377. <div class="ttc" id="astructAudioPort_html_abbd5c1ad18e0b920c2ff6c5053e59ede"><div class="ttname"><a href="structAudioPort.html#abbd5c1ad18e0b920c2ff6c5053e59ede">AudioPort::AudioPort</a></div><div class="ttdeci">AudioPort() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:283</div></div>

  1378. <div class="ttc" id="astructAudioPort_html_adb3b58f79131b653d6b2adfa3ea07e5c"><div class="ttname"><a href="structAudioPort.html#adb3b58f79131b653d6b2adfa3ea07e5c">AudioPort::name</a></div><div class="ttdeci">String name</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:260</div></div>

  1379. <div class="ttc" id="astructAudioPort_html_af2bda30f97a1b63cbeb9f11f718d3d30"><div class="ttname"><a href="structAudioPort.html#af2bda30f97a1b63cbeb9f11f718d3d30">AudioPort::symbol</a></div><div class="ttdeci">String symbol</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:268</div></div>

  1380. <div class="ttc" id="astructAudioPort_html_af93f38f9ef48ea14544adf32e4b1e513"><div class="ttname"><a href="structAudioPort.html#af93f38f9ef48ea14544adf32e4b1e513">AudioPort::hints</a></div><div class="ttdeci">uint32_t hints</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:253</div></div>

  1381. <div class="ttc" id="astructMidiEvent_html"><div class="ttname"><a href="structMidiEvent.html">MidiEvent</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:714</div></div>

  1382. <div class="ttc" id="astructMidiEvent_html_a48b420a6dbca6502113b92c336a3041e"><div class="ttname"><a href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e">MidiEvent::size</a></div><div class="ttdeci">uint32_t size</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:728</div></div>

  1383. <div class="ttc" id="astructMidiEvent_html_a9e23ce17777c2ff5190670d3262129b9"><div class="ttname"><a href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">MidiEvent::kDataSize</a></div><div class="ttdeci">static const uint32_t kDataSize</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:718</div></div>

  1384. <div class="ttc" id="astructMidiEvent_html_aba54410d44eef48c10516f29452ef3a9"><div class="ttname"><a href="structMidiEvent.html#aba54410d44eef48c10516f29452ef3a9">MidiEvent::data</a></div><div class="ttdeci">uint8_t data[kDataSize]</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:737</div></div>

  1385. <div class="ttc" id="astructMidiEvent_html_aca2f6590b33bd2175ab71f985747d88e"><div class="ttname"><a href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">MidiEvent::frame</a></div><div class="ttdeci">uint32_t frame</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:723</div></div>

  1386. <div class="ttc" id="astructParameterEnumerationValue_html"><div class="ttname"><a href="structParameterEnumerationValue.html">ParameterEnumerationValue</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:413</div></div>

  1387. <div class="ttc" id="astructParameterEnumerationValue_html_a169e558182f93aadd2e66819a981a3f9"><div class="ttname"><a href="structParameterEnumerationValue.html#a169e558182f93aadd2e66819a981a3f9">ParameterEnumerationValue::ParameterEnumerationValue</a></div><div class="ttdeci">ParameterEnumerationValue() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:427</div></div>

  1388. <div class="ttc" id="astructParameterEnumerationValue_html_a292f282837daa791205027d998907ae9"><div class="ttname"><a href="structParameterEnumerationValue.html#a292f282837daa791205027d998907ae9">ParameterEnumerationValue::value</a></div><div class="ttdeci">float value</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:417</div></div>

  1389. <div class="ttc" id="astructParameterEnumerationValue_html_aad073d95adfcd8ec01767490fbd69f68"><div class="ttname"><a href="structParameterEnumerationValue.html#aad073d95adfcd8ec01767490fbd69f68">ParameterEnumerationValue::ParameterEnumerationValue</a></div><div class="ttdeci">ParameterEnumerationValue(float v, const char *l) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:434</div></div>

  1390. <div class="ttc" id="astructParameterEnumerationValue_html_aba1c51d5a2c99416c1dcf0a08345178d"><div class="ttname"><a href="structParameterEnumerationValue.html#aba1c51d5a2c99416c1dcf0a08345178d">ParameterEnumerationValue::label</a></div><div class="ttdeci">String label</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:422</div></div>

  1391. <div class="ttc" id="astructParameterEnumerationValues_html"><div class="ttname"><a href="structParameterEnumerationValues.html">ParameterEnumerationValues</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:443</div></div>

  1392. <div class="ttc" id="astructParameterEnumerationValues_html_a014ebcacbe68c3f77f2f8ac9ffe3cd6f"><div class="ttname"><a href="structParameterEnumerationValues.html#a014ebcacbe68c3f77f2f8ac9ffe3cd6f">ParameterEnumerationValues::restrictedMode</a></div><div class="ttdeci">bool restrictedMode</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:454</div></div>

  1393. <div class="ttc" id="astructParameterEnumerationValues_html_a109591a3392e28362de7e1e474f75ae2"><div class="ttname"><a href="structParameterEnumerationValues.html#a109591a3392e28362de7e1e474f75ae2">ParameterEnumerationValues::ParameterEnumerationValues</a></div><div class="ttdeci">ParameterEnumerationValues(uint32_t c, bool r, ParameterEnumerationValue *v) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:474</div></div>

  1394. <div class="ttc" id="astructParameterEnumerationValues_html_ab1bbcf39e2efae872e9b8dbde17a045a"><div class="ttname"><a href="structParameterEnumerationValues.html#ab1bbcf39e2efae872e9b8dbde17a045a">ParameterEnumerationValues::ParameterEnumerationValues</a></div><div class="ttdeci">ParameterEnumerationValues() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:465</div></div>

  1395. <div class="ttc" id="astructParameterEnumerationValues_html_ae101471c5d819624398001c84c534b7a"><div class="ttname"><a href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">ParameterEnumerationValues::values</a></div><div class="ttdeci">ParameterEnumerationValue * values</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:460</div></div>

  1396. <div class="ttc" id="astructParameterEnumerationValues_html_afd740dd45384c493801405a1c1c3d51d"><div class="ttname"><a href="structParameterEnumerationValues.html#afd740dd45384c493801405a1c1c3d51d">ParameterEnumerationValues::count</a></div><div class="ttdeci">uint8_t count</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:447</div></div>

  1397. <div class="ttc" id="astructParameterRanges_html"><div class="ttname"><a href="structParameterRanges.html">ParameterRanges</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:297</div></div>

  1398. <div class="ttc" id="astructParameterRanges_html_a17519e584ccc28e87b73bfbd1a81cf10"><div class="ttname"><a href="structParameterRanges.html#a17519e584ccc28e87b73bfbd1a81cf10">ParameterRanges::fixDefault</a></div><div class="ttdeci">void fixDefault() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:332</div></div>

  1399. <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:311</div></div>

  1400. <div class="ttc" id="astructParameterRanges_html_a1dac84c100f420bfc529a4d2ea60dc7c"><div class="ttname"><a href="structParameterRanges.html#a1dac84c100f420bfc529a4d2ea60dc7c">ParameterRanges::fixValue</a></div><div class="ttdeci">void fixValue(float &amp;value) const noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:340</div></div>

  1401. <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:306</div></div>

  1402. <div class="ttc" id="astructParameterRanges_html_a75337384c041ef8cd1a1cd2ba57ac205"><div class="ttname"><a href="structParameterRanges.html#a75337384c041ef8cd1a1cd2ba57ac205">ParameterRanges::ParameterRanges</a></div><div class="ttdeci">ParameterRanges(float df, float mn, float mx) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:324</div></div>

  1403. <div class="ttc" id="astructParameterRanges_html_a82698a1e07b1b04ccb5df0de4db0d0be"><div class="ttname"><a href="structParameterRanges.html#a82698a1e07b1b04ccb5df0de4db0d0be">ParameterRanges::getFixedAndNormalizedValue</a></div><div class="ttdeci">float getFixedAndNormalizedValue(const float &amp;value) const noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:377</div></div>

  1404. <div class="ttc" id="astructParameterRanges_html_a983383b2b3ce5d049802a7f0a12cee0c"><div class="ttname"><a href="structParameterRanges.html#a983383b2b3ce5d049802a7f0a12cee0c">ParameterRanges::getFixedValue</a></div><div class="ttdeci">float getFixedValue(const float &amp;value) const noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:351</div></div>

  1405. <div class="ttc" id="astructParameterRanges_html_a992f75a925b3cd5e66544087708ea3c3"><div class="ttname"><a href="structParameterRanges.html#a992f75a925b3cd5e66544087708ea3c3">ParameterRanges::getUnnormalizedValue</a></div><div class="ttdeci">float getUnnormalizedValue(const float &amp;value) const noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:397</div></div>

  1406. <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:301</div></div>

  1407. <div class="ttc" id="astructParameterRanges_html_ad16ef939c1caa2f51e9a4041f769f86e"><div class="ttname"><a href="structParameterRanges.html#ad16ef939c1caa2f51e9a4041f769f86e">ParameterRanges::getNormalizedValue</a></div><div class="ttdeci">float getNormalizedValue(const float &amp;value) const noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:363</div></div>

  1408. <div class="ttc" id="astructParameterRanges_html_adb9b2712df3401eb0c5e11362d865d4e"><div class="ttname"><a href="structParameterRanges.html#adb9b2712df3401eb0c5e11362d865d4e">ParameterRanges::ParameterRanges</a></div><div class="ttdeci">ParameterRanges() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:316</div></div>

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

  1410. <div class="ttc" id="astructParameter_html_a12ced87d6d832deccb6c8ce2c8313b2e"><div class="ttname"><a href="structParameter.html#a12ced87d6d832deccb6c8ce2c8313b2e">Parameter::Parameter</a></div><div class="ttdeci">Parameter() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:577</div></div>

  1411. <div class="ttc" id="astructParameter_html_a1a47c46f3588b8a940d87fd4d69810ab"><div class="ttname"><a href="structParameter.html#a1a47c46f3588b8a940d87fd4d69810ab">Parameter::shortName</a></div><div class="ttdeci">String shortName</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:516</div></div>

  1412. <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:543</div></div>

  1413. <div class="ttc" id="astructParameter_html_a2f79574998d34504e3a694163b4599a1"><div class="ttname"><a href="structParameter.html#a2f79574998d34504e3a694163b4599a1">Parameter::unit</a></div><div class="ttdeci">String unit</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:531</div></div>

  1414. <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:502</div></div>

  1415. <div class="ttc" id="astructParameter_html_a3bbf6f7d5ccea9a13504bd6ee3713986"><div class="ttname"><a href="structParameter.html#a3bbf6f7d5ccea9a13504bd6ee3713986">Parameter::designation</a></div><div class="ttdeci">ParameterDesignation designation</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:554</div></div>

  1416. <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:524</div></div>

  1417. <div class="ttc" id="astructParameter_html_a5389731e4cd95cac10af9aec9aa7b202"><div class="ttname"><a href="structParameter.html#a5389731e4cd95cac10af9aec9aa7b202">Parameter::midiCC</a></div><div class="ttdeci">uint8_t midiCC</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:562</div></div>

  1418. <div class="ttc" id="astructParameter_html_a5aacdf5c58652cc6840ebfbe2a748d29"><div class="ttname"><a href="structParameter.html#a5aacdf5c58652cc6840ebfbe2a748d29">Parameter::description</a></div><div class="ttdeci">String description</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:537</div></div>

  1419. <div class="ttc" id="astructParameter_html_a72dd5af5c024bd86497a4a5d9c8c4f25"><div class="ttname"><a href="structParameter.html#a72dd5af5c024bd86497a4a5d9c8c4f25">Parameter::groupId</a></div><div class="ttdeci">uint32_t groupId</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:572</div></div>

  1420. <div class="ttc" id="astructParameter_html_ab94ec79aad8e8f6e4bc33d046f029358"><div class="ttname"><a href="structParameter.html#ab94ec79aad8e8f6e4bc33d046f029358">Parameter::enumValues</a></div><div class="ttdeci">ParameterEnumerationValues enumValues</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:549</div></div>

  1421. <div class="ttc" id="astructParameter_html_ad959d31bcfaa056908406bbf37c134bf"><div class="ttname"><a href="structParameter.html#ad959d31bcfaa056908406bbf37c134bf">Parameter::initDesignation</a></div><div class="ttdeci">void initDesignation(ParameterDesignation d) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:607</div></div>

  1422. <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:509</div></div>

  1423. <div class="ttc" id="astructParameter_html_af0c5eeebedfe0058775a7ff4d904b6ab"><div class="ttname"><a href="structParameter.html#af0c5eeebedfe0058775a7ff4d904b6ab">Parameter::Parameter</a></div><div class="ttdeci">Parameter(uint32_t h, const char *n, const char *s, const char *u, float def, float min, float max) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:592</div></div>

  1424. <div class="ttc" id="astructPortGroup_html"><div class="ttname"><a href="structPortGroup.html">PortGroup</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:651</div></div>

  1425. <div class="ttc" id="astructPortGroup_html_ae42f849c9f34d940f6fdcfc9abd65d4f"><div class="ttname"><a href="structPortGroup.html#ae42f849c9f34d940f6fdcfc9abd65d4f">PortGroup::symbol</a></div><div class="ttdeci">String symbol</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:665</div></div>

  1426. <div class="ttc" id="astructPortGroup_html_af3ab9eaf5eb1ad8165fc43b4518d2c5b"><div class="ttname"><a href="structPortGroup.html#af3ab9eaf5eb1ad8165fc43b4518d2c5b">PortGroup::name</a></div><div class="ttdeci">String name</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:657</div></div>

  1427. <div class="ttc" id="astructState_html"><div class="ttname"><a href="structState.html">State</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:677</div></div>

  1428. <div class="ttc" id="astructState_html_a62474faa50839c3d35fe31b3bf7e39b0"><div class="ttname"><a href="structState.html#a62474faa50839c3d35fe31b3bf7e39b0">State::key</a></div><div class="ttdeci">String key</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:691</div></div>

  1429. <div class="ttc" id="astructState_html_ad29e7e5a872defd5521d69e47b1e9df5"><div class="ttname"><a href="structState.html#ad29e7e5a872defd5521d69e47b1e9df5">State::label</a></div><div class="ttdeci">String label</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:702</div></div>

  1430. <div class="ttc" id="astructState_html_adaa34a729d4e8c0e2e6434b4c4f55fab"><div class="ttname"><a href="structState.html#adaa34a729d4e8c0e2e6434b4c4f55fab">State::hints</a></div><div class="ttdeci">uint32_t hints</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:683</div></div>

  1431. <div class="ttc" id="astructState_html_af925c53b4676ed45b8b813424e626c3e"><div class="ttname"><a href="structState.html#af925c53b4676ed45b8b813424e626c3e">State::defaultValue</a></div><div class="ttdeci">String defaultValue</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:697</div></div>

  1432. <div class="ttc" id="astructState_html_afb8bee553cefbfe2a495fc391a5f0243"><div class="ttname"><a href="structState.html#afb8bee553cefbfe2a495fc391a5f0243">State::description</a></div><div class="ttdeci">String description</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:708</div></div>

  1433. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html">TimePosition::BarBeatTick</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:764</div></div>

  1434. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_a3d0f3681391ab7d3d37abcae24c72257"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">TimePosition::BarBeatTick::beatType</a></div><div class="ttdeci">float beatType</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:806</div></div>

  1435. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_a45a05047e923285af0fbeacb371e3f4e"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e">TimePosition::BarBeatTick::valid</a></div><div class="ttdeci">bool valid</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:769</div></div>

  1436. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_a4805c98ceeedca9fb886de068c50cb88"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">TimePosition::BarBeatTick::beatsPerBar</a></div><div class="ttdeci">float beatsPerBar</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:801</div></div>

  1437. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_a5205e95c8f8021006bde2eae774d5b62"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">TimePosition::BarBeatTick::barStartTick</a></div><div class="ttdeci">double barStartTick</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:796</div></div>

  1438. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_ab8cfc3f2709a79e733e58556712da062"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">TimePosition::BarBeatTick::ticksPerBeat</a></div><div class="ttdeci">double ticksPerBeat</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:812</div></div>

  1439. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_abff8c9586a4e82694e7d6bac3e8da1ef"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef">TimePosition::BarBeatTick::BarBeatTick</a></div><div class="ttdeci">BarBeatTick() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:822</div></div>

  1440. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_ad104eba852516842d8c4776f9d495d21"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21">TimePosition::BarBeatTick::bar</a></div><div class="ttdeci">int32_t bar</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:776</div></div>

  1441. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_ae6ea776260b58800bff63f515351bd3a"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#ae6ea776260b58800bff63f515351bd3a">TimePosition::BarBeatTick::clear</a></div><div class="ttdeci">void clear() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:836</div></div>

  1442. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_aecb8a1a98db84c6d03c39278f86a0324"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#aecb8a1a98db84c6d03c39278f86a0324">TimePosition::BarBeatTick::tick</a></div><div class="ttdeci">double tick</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:791</div></div>

  1443. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_af4be3edce420539cbb21bc1b0278201c"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c">TimePosition::BarBeatTick::beat</a></div><div class="ttdeci">int32_t beat</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:783</div></div>

  1444. <div class="ttc" id="astructTimePosition_1_1BarBeatTick_html_af7cb9ae9b30da287828ebddee5caff2f"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">TimePosition::BarBeatTick::beatsPerMinute</a></div><div class="ttdeci">double beatsPerMinute</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:817</div></div>

  1445. <div class="ttc" id="astructTimePosition_html"><div class="ttname"><a href="structTimePosition.html">TimePosition</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:748</div></div>

  1446. <div class="ttc" id="astructTimePosition_html_a35db424bdf8ec01102a4fa6346c45574"><div class="ttname"><a href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574">TimePosition::playing</a></div><div class="ttdeci">bool playing</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:752</div></div>

  1447. <div class="ttc" id="astructTimePosition_html_aa3606d1c518c7ebe6335bc19f72b015b"><div class="ttname"><a href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b">TimePosition::frame</a></div><div class="ttdeci">uint64_t frame</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:759</div></div>

  1448. <div class="ttc" id="astructTimePosition_html_acd89e79032d748ee7fc01d55a2c518bb"><div class="ttname"><a href="structTimePosition.html#acd89e79032d748ee7fc01d55a2c518bb">TimePosition::clear</a></div><div class="ttdeci">void clear() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:861</div></div>

  1449. <div class="ttc" id="astructTimePosition_html_aee816daeed95cf309ded1087a0c800ae"><div class="ttname"><a href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae">TimePosition::TimePosition</a></div><div class="ttdeci">TimePosition() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:853</div></div>

  1450. </div><!-- fragment --></div><!-- contents -->

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

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

  1453. Generated on Wed Jul 27 2022 00:46:18 for DISTRHO Plugin Framework by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  1454. </small></address>

  1455. </body>

  1456. </html>