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.
373 Commits
7 Branches
295MB
Tree: 1bf6b55edf
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1bf6b55edf'
${ noResults }
DPF/DistrhoPlugin_8hpp_source.html

971 lines
149KB
Raw Blame History 

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

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

  3. <head>

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

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

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

  7. <title>DISTRHO Plugin Framework: distrho/DistrhoPlugin.hpp Source File</title>

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

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

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

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

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

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

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

  24.   <td style="padding-left: 0.5em;">

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

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

  33. <!-- Generated by Doxygen 1.8.8 -->

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

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

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li class="current"><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

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

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

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="files.html"><span>File&#160;List</span></a></li>

  64.     </ul>

  65.   </div>

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

  67. <div id="MSearchSelectWindow"

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

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

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

  71. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  72. 

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

  74. <div id="MSearchResultsWindow">

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

  76.         name="MSearchResults" id="MSearchResults">

  77. </iframe>

  78. </div>

  79. 

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

  81.   <ul>

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

  83. </div>

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

  85. <div class="header">

  86.   <div class="headertitle">

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

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

  89. <div class="contents">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  110. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;src/DistrhoPluginChecks.h&quot;</span></div>

  111. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>

  112. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div>

  113. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>

  114. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifdef DISTRHO_PROPER_CPP11_SUPPORT</span></div>

  115. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor"># include &lt;cstdint&gt;</span></div>

  116. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#else</span></div>

  117. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor"># include &lt;stdint.h&gt;</span></div>

  118. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#endif</span></div>

  119. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>

  120. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef M_PI</span></div>

  121. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"># define M_PI 3.14159265358979323846</span></div>

  122. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#endif</span></div>

  123. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div>

  124. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;START_NAMESPACE_DISTRHO</div>

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

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

  127. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">   @mainpage DISTRHO %Plugin Framework</span></div>

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

  129. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">   DISTRHO %Plugin Framework (or @b DPF for short)</span></div>

  130. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">   is a plugin framework designed to make development of new plugins an easy and enjoyable task.@n</span></div>

  131. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">   It allows developers to create plugins with custom UIs using a simple C++ API.</span></div>

  132. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"></span></div>

  133. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">   @section Macros</span></div>

  134. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">   You start by creating a &quot;DistrhoPluginInfo.h&quot; file describing the plugin via macros, see @ref PluginMacros.</span></div>

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

  136. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">   @section Plugin</span></div>

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

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

  139. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">   @section Parameters</span></div>

  140. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">   describe input and output, automable and rt safe, boolean etc, cv</span></div>

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

  142. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>

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

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

  145. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>

  146. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#ifdef DOXYGEN</span></div>

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

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

  149. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">   @defgroup PluginMacros Plugin Macros</span></div>

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

  151. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">   C Macros that describe your plugin. (defined in the &quot;DistrhoPluginInfo.h&quot; file)</span></div>

  152. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"></span></div>

  153. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">   With these macros you can tell the host what features your plugin requires.@n</span></div>

  154. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">   Depending on which macros you enable, new functions will be available to call and/or override.</span></div>

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

  156. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">   All values are either integer or strings.@n</span></div>

  157. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment">   For boolean-like values 1 means &#39;on&#39; and 0 means &#39;off&#39;.</span></div>

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

  159. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment">   The values defined in this file are for documentation purposes only.@n</span></div>

  160. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">   All macros are disabled by default.</span></div>

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

  162. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">   Only 4 macros are required, they are:</span></div>

  163. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment">    - @ref DISTRHO_PLUGIN_NAME</span></div>

  164. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">    - @ref DISTRHO_PLUGIN_NUM_INPUTS</span></div>

  165. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">    - @ref DISTRHO_PLUGIN_NUM_OUTPUTS</span></div>

  166. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">    - @ref DISTRHO_PLUGIN_URI</span></div>

  167. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">   @{</span></div>

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

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

  170. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">/**</span></div>

  171. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">   The plugin name.@n</span></div>

  172. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">   This is used to identify your plugin before a Plugin instance can be created.</span></div>

  173. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">   @note This macro is required.</span></div>

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

  175. <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">   86</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_NAME &quot;Plugin Name&quot;</span></div>

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

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

  178. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">   Number of audio inputs the plugin has.</span></div>

  179. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">   @note This macro is required.</span></div>

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

  181. <div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga5f4f3d9a5dc3c23882d158e636319998">   92</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_NUM_INPUTS 2</span></div>

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

  183. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">/**</span></div>

  184. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment">   Number of audio outputs the plugin has.</span></div>

  185. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment">   @note This macro is required.</span></div>

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

  187. <div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">   98</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_NUM_OUTPUTS 2</span></div>

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

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

  190. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment">   The plugin URI when exporting in LV2 format.</span></div>

  191. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">   @note This macro is required.</span></div>

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

  193. <div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">  104</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_URI &quot;urn:distrho:name&quot;</span></div>

  194. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"></span></div>

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

  196. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment">   Wherever the plugin has a custom %UI.</span></div>

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

  198. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment">   @see UI</span></div>

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

  200. <div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gacf8a1af679c09637ba0bdc5f4f8e37dd">  111</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_HAS_UI 1</span></div>

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

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

  203. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">   Wherever the plugin processing is realtime-safe.@n</span></div>

  204. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">   TODO - list rtsafe requirements</span></div>

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

  206. <div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga82546dd199fcea338b113f2f6da84ced">  117</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_IS_RT_SAFE 1</span></div>

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

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

  209. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">   Wherever the plugin is a synth.@n</span></div>

  210. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment">   @ref DISTRHO_PLUGIN_WANT_MIDI_INPUT is automatically enabled when this is too.</span></div>

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

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

  213. <div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga854bde6b6fdb0d47182149dbab0fed72">  124</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_IS_SYNTH 1</span></div>

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

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

  216. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">   Enable direct access between the %UI and plugin code.</span></div>

  217. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment">   @see UI::d_getPluginInstancePointer()</span></div>

  218. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">   @note DO NOT USE THIS UNLESS STRICTLY NECESSARY!!</span></div>

  219. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment">         Try to avoid it at all costs!</span></div>

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

  221. <div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gac6873a3950f52f3fde8e386af63b69a1">  132</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_DIRECT_ACCESS 0</span></div>

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

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

  224. <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">   Wherever the plugin introduces latency during audio or midi processing.</span></div>

  225. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">   @see Plugin::d_setLatency(uint32_t)</span></div>

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

  227. <div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gad6b0ebf10e048f4742f29735da4d4930">  138</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_LATENCY 1</span></div>

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

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

  230. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment">   Wherever the plugin wants MIDI input.@n</span></div>

  231. <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">   This is automatically enabled if @ref DISTRHO_PLUGIN_IS_SYNTH is true.</span></div>

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

  233. <div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gadf2e2eb7550e4116001c816adfb04a70">  144</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_MIDI_INPUT 1</span></div>

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

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

  236. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">   Wherever the plugin wants MIDI output.</span></div>

  237. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">   @see Plugin::d_writeMidiEvent(const MidiEvent&amp;)</span></div>

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

  239. <div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga548522eb91344a45841a5a95ff4f8073">  150</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_MIDI_OUTPUT 1</span></div>

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

  241. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment">/**</span></div>

  242. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment">   Wherever the plugin provides its own internal programs.</span></div>

  243. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment">   @see Plugin::d_initProgramName(uint32_t, d_string&amp;)</span></div>

  244. <div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment">   @see Plugin::d_setProgram(uint32_t)</span></div>

  245. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"> */</span></div>

  246. <div class="line"><a name="l00157"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gad95e24b17f196260cee15255fdb5b677">  157</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_PROGRAMS 1</span></div>

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

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

  249. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">   Wherever the plugin uses internal non-parameter data.</span></div>

  250. <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">   @see Plugin::d_initState(uint32_t, d_string&amp;, d_string&amp;)</span></div>

  251. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">   @see Plugin::d_setState(const char*, const char*)</span></div>

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

  253. <div class="line"><a name="l00164"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga255f43cc0997af8b56abcca260c875e0">  164</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_STATE 1</span></div>

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

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

  256. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment">   Wherever the plugin wants time position information from the host.</span></div>

  257. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment">   @see Plugin::d_getTimePosition()</span></div>

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

  259. <div class="line"><a name="l00170"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga496610b956d931b1940d07da48d123f2">  170</a></span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_WANT_TIMEPOS 1</span></div>

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

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

  262. <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment">   Wherever the %UI uses NanoVG for drawing instead of the default raw OpenGL calls.@n</span></div>

  263. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment">   When enabled your %UI instance will subclass @ref NanoWidget instead of @ref Widget.</span></div>

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

  265. <div class="line"><a name="l00176"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#gad49e79936a2aa5afa089cbc051426ccd">  176</a></span>&#160;<span class="preprocessor">#define DISTRHO_UI_USE_NANOVG 1</span></div>

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

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

  268. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment">   The %UI URI when exporting in LV2 format.@n</span></div>

  269. <div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment">   By default this is set to @ref DISTRHO_PLUGIN_URI with &quot;#UI&quot; as suffix.</span></div>

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

  271. <div class="line"><a name="l00182"></a><span class="lineno"><a class="line" href="group__PluginMacros.html#ga420a88022da249b9f38a6046998dbd7c">  182</a></span>&#160;<span class="preprocessor">#define DISTRHO_UI_URI DISTRHO_PLUGIN_URI &quot;#UI&quot;</span></div>

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

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

  274. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;</div>

  275. <div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

  278. <div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment"> * Parameter Hints */</span></div>

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

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

  281. <div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment">   @defgroup ParameterHints Parameter Hints</span></div>

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

  283. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment">   Various parameter hints.</span></div>

  284. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment">   @see Parameter::hints</span></div>

  285. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment">   @{</span></div>

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

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

  288. <div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment">/**</span></div>

  289. <div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment">   Parameter is automable (real-time safe).</span></div>

  290. <div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment">   @see Plugin::d_setParameterValue()</span></div>

  291. <div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="comment"> */</span></div>

  292. <div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">  203</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a> = 0x01;</div>

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

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

  295. <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment">   Parameter value is boolean.</span></div>

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

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

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

  299. <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="comment"></span></div>

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

  301. <div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="comment">   Parameter value is integer.</span></div>

  302. <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="comment"> */</span></div>

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

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

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

  306. <div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment">   Parameter value is logarithmic.</span></div>

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

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

  309. <div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;<span class="comment"></span></div>

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

  311. <div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;<span class="comment">   Parameter is of output type.</span></div>

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

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

  314. <div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment">   Parameter inputs are changed by the host and must not be changed by the plugin.</span></div>

  315. <div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment">   The only exception being when changing programs, see Plugin::d_setProgram().</span></div>

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

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

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

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

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

  321. <div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment">   Parameter can be used as control voltage (LV2 only).</span></div>

  322. <div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment"> */</span></div>

  323. <div class="line"><a name="l00234"></a><span class="lineno"><a class="line" href="group__ParameterHints.html#ga1eae4d034f2ff1bc14035d87c4b63b14">  234</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="group__ParameterHints.html#ga1eae4d034f2ff1bc14035d87c4b63b14">kParameterIsCV</a> = 0x20;</div>

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

  325. <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;<span class="comment">/** @} */</span></div>

  326. <div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;</div>

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

  328. <div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;<span class="comment"> * DPF Base structs */</span></div>

  329. <div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment"></span></div>

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

  331. <div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="comment">   @defgroup BaseStructs Base Structs</span></div>

  332. <div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment">   @{</span></div>

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

  334. <div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;<span class="comment"></span></div>

  335. <div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;<span class="comment">/**</span></div>

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

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

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

  339. <div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;<span class="comment">   By default a parameter has 0.0 as minimum, 1.0 as maximum and 0.0 as default.</span></div>

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

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

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

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

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

  345. <div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment">    */</span></div>

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

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

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

  349. <div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;<span class="comment">      Minimum value.</span></div>

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

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

  352. <div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;<span class="comment"></span></div>

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

  354. <div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;<span class="comment">      Maximum value.</span></div>

  355. <div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;<span class="comment">    */</span></div>

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

  357. <div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="comment"></span></div>

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

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

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

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

  362. <div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;        : def(0.0f),</div>

  363. <div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;          min(0.0f),</div>

  364. <div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;          max(1.0f) {}</div>

  365. <div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;<span class="comment"></span></div>

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

  367. <div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;<span class="comment">      Constructor using custom values.</span></div>

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

  369. <div class="line"><a name="l00280"></a><span class="lineno"><a class="line" href="structParameterRanges.html#aad2afc730bee791aab1811744a48f99d">  280</a></span>&#160;    <a class="code" href="structParameterRanges.html#aad2afc730bee791aab1811744a48f99d">ParameterRanges</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> df, <span class="keyword">const</span> <span class="keywordtype">float</span> mn, <span class="keyword">const</span> <span class="keywordtype">float</span> mx) noexcept</div>

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

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

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

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

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

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

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

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

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

  379. <div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;        <a class="code" href="structParameterRanges.html#a1dac84c100f420bfc529a4d2ea60dc7c">fixValue</a>(def);</div>

  380. <div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;    }</div>

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

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

  383. <div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;<span class="comment">      Fix a value within range.</span></div>

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

  385. <div class="line"><a name="l00296"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a1dac84c100f420bfc529a4d2ea60dc7c">  296</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>

  386. <div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;    {</div>

  387. <div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;        <span class="keywordflow">if</span> (value &lt; min)</div>

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

  389. <div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;        <span class="keywordflow">else</span> <span class="keywordflow">if</span> (value &gt; max)</div>

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

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

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

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

  394. <div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="comment">      Get a fixed value within range.</span></div>

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

  396. <div class="line"><a name="l00307"></a><span class="lineno"><a class="line" href="structParameterRanges.html#acd3d977c154ddb3138f36c0b6d2b7626">  307</a></span>&#160;    <span class="keyword">const</span> <span class="keywordtype">float</span>&amp; <a class="code" href="structParameterRanges.html#acd3d977c154ddb3138f36c0b6d2b7626">getFixedValue</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>&amp; value) <span class="keyword">const</span> noexcept</div>

  397. <div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;    {</div>

  398. <div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;        <span class="keywordflow">if</span> (value &lt;= min)</div>

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

  400. <div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;        <span class="keywordflow">if</span> (value &gt;= max)</div>

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

  402. <div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;        <span class="keywordflow">return</span> value;</div>

  403. <div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;    }</div>

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

  405. <div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;<span class="comment">   /**</span></div>

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

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

  408. <div class="line"><a name="l00319"></a><span class="lineno"><a class="line" href="structParameterRanges.html#ad16ef939c1caa2f51e9a4041f769f86e">  319</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>

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

  410. <div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;        <span class="keyword">const</span> <span class="keywordtype">float</span> normValue((value - min) / (max - min));</div>

  411. <div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;</div>

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

  413. <div class="line"><a name="l00324"></a><span class="lineno">  324</span>&#160;            <span class="keywordflow">return</span> 0.0f;</div>

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

  415. <div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;            <span class="keywordflow">return</span> 1.0f;</div>

  416. <div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;        <span class="keywordflow">return</span> normValue;</div>

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

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

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

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

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

  422. <div class="line"><a name="l00333"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a82698a1e07b1b04ccb5df0de4db0d0be">  333</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>

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

  424. <div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;        <span class="keywordflow">if</span> (value &lt;= min)</div>

  425. <div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;            <span class="keywordflow">return</span> 0.0f;</div>

  426. <div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;        <span class="keywordflow">if</span> (value &gt;= max)</div>

  427. <div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;            <span class="keywordflow">return</span> 1.0f;</div>

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

  429. <div class="line"><a name="l00340"></a><span class="lineno">  340</span>&#160;        <span class="keyword">const</span> <span class="keywordtype">float</span> normValue((value - min) / (max - min));</div>

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

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

  432. <div class="line"><a name="l00343"></a><span class="lineno">  343</span>&#160;            <span class="keywordflow">return</span> 0.0f;</div>

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

  434. <div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160;            <span class="keywordflow">return</span> 1.0f;</div>

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

  436. <div class="line"><a name="l00347"></a><span class="lineno">  347</span>&#160;        <span class="keywordflow">return</span> normValue;</div>

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

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

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

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

  441. <div class="line"><a name="l00352"></a><span class="lineno">  352</span>&#160;<span class="comment">    */</span></div>

  442. <div class="line"><a name="l00353"></a><span class="lineno"><a class="line" href="structParameterRanges.html#a992f75a925b3cd5e66544087708ea3c3">  353</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>

  443. <div class="line"><a name="l00354"></a><span class="lineno">  354</span>&#160;    {</div>

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

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

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

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

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

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

  450. <div class="line"><a name="l00361"></a><span class="lineno">  361</span>&#160;    }</div>

  451. <div class="line"><a name="l00362"></a><span class="lineno">  362</span>&#160;};</div>

  452. <div class="line"><a name="l00363"></a><span class="lineno">  363</span>&#160;<span class="comment"></span></div>

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

  454. <div class="line"><a name="l00365"></a><span class="lineno">  365</span>&#160;<span class="comment">   Parameter.</span></div>

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

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

  457. <div class="line"><a name="l00368"></a><span class="lineno">  368</span>&#160;<span class="comment">   /**</span></div>

  458. <div class="line"><a name="l00369"></a><span class="lineno">  369</span>&#160;<span class="comment">      Hints describing this parameter.</span></div>

  459. <div class="line"><a name="l00370"></a><span class="lineno">  370</span>&#160;<span class="comment">      @see ParameterHints</span></div>

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

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

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

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

  464. <div class="line"><a name="l00375"></a><span class="lineno">  375</span>&#160;<span class="comment">      The name of this parameter.</span></div>

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

  466. <div class="line"><a name="l00377"></a><span class="lineno">  377</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>

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

  468. <div class="line"><a name="l00379"></a><span class="lineno"><a class="line" href="structParameter.html#a2e75f234cbbda1ed0517075e67d27191">  379</a></span>&#160;    d_string <a class="code" href="structParameter.html#a2e75f234cbbda1ed0517075e67d27191">name</a>;</div>

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

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

  471. <div class="line"><a name="l00382"></a><span class="lineno">  382</span>&#160;<span class="comment">      The symbol of this parameter.</span></div>

  472. <div class="line"><a name="l00383"></a><span class="lineno">  383</span>&#160;<span class="comment">      A parameter symbol is a short restricted name used as a machine and human readable identifier.</span></div>

  473. <div class="line"><a name="l00384"></a><span class="lineno">  384</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>

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

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

  476. <div class="line"><a name="l00387"></a><span class="lineno"><a class="line" href="structParameter.html#a0b5193e6131f65878dfb6fe4d9f5e970">  387</a></span>&#160;    d_string <a class="code" href="structParameter.html#a0b5193e6131f65878dfb6fe4d9f5e970">symbol</a>;</div>

  477. <div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;<span class="comment"></span></div>

  478. <div class="line"><a name="l00389"></a><span class="lineno">  389</span>&#160;<span class="comment">   /**</span></div>

  479. <div class="line"><a name="l00390"></a><span class="lineno">  390</span>&#160;<span class="comment">      The unit of this parameter.</span></div>

  480. <div class="line"><a name="l00391"></a><span class="lineno">  391</span>&#160;<span class="comment">      This means something like &quot;dB&quot;, &quot;kHz&quot; and &quot;ms&quot;.</span></div>

  481. <div class="line"><a name="l00392"></a><span class="lineno">  392</span>&#160;<span class="comment">      Can be left blank if units do not apply to this parameter.</span></div>

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

  483. <div class="line"><a name="l00394"></a><span class="lineno"><a class="line" href="structParameter.html#aa9ee36848d60d8ddd9185b9a3f2ce93f">  394</a></span>&#160;    d_string <a class="code" href="structParameter.html#aa9ee36848d60d8ddd9185b9a3f2ce93f">unit</a>;</div>

  484. <div class="line"><a name="l00395"></a><span class="lineno">  395</span>&#160;<span class="comment"></span></div>

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

  486. <div class="line"><a name="l00397"></a><span class="lineno">  397</span>&#160;<span class="comment">      Ranges of this parameter.</span></div>

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

  488. <div class="line"><a name="l00399"></a><span class="lineno">  399</span>&#160;<span class="comment">    */</span></div>

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

  490. <div class="line"><a name="l00401"></a><span class="lineno">  401</span>&#160;<span class="comment"></span></div>

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

  492. <div class="line"><a name="l00403"></a><span class="lineno">  403</span>&#160;<span class="comment">      Default constructor for a null parameter.</span></div>

  493. <div class="line"><a name="l00404"></a><span class="lineno">  404</span>&#160;<span class="comment">    */</span></div>

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

  495. <div class="line"><a name="l00406"></a><span class="lineno">  406</span>&#160;        : hints(0x0),</div>

  496. <div class="line"><a name="l00407"></a><span class="lineno">  407</span>&#160;          name(),</div>

  497. <div class="line"><a name="l00408"></a><span class="lineno">  408</span>&#160;          symbol(),</div>

  498. <div class="line"><a name="l00409"></a><span class="lineno">  409</span>&#160;          unit(),</div>

  499. <div class="line"><a name="l00410"></a><span class="lineno">  410</span>&#160;          ranges() {}</div>

  500. <div class="line"><a name="l00411"></a><span class="lineno">  411</span>&#160;};</div>

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

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

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

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

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

  506. <div class="line"><a name="l00417"></a><span class="lineno">  417</span>&#160;<span class="comment">   /**</span></div>

  507. <div class="line"><a name="l00418"></a><span class="lineno">  418</span>&#160;<span class="comment">      Size of internal data.</span></div>

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

  509. <div class="line"><a name="l00420"></a><span class="lineno"><a class="line" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">  420</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>

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

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

  512. <div class="line"><a name="l00423"></a><span class="lineno">  423</span>&#160;<span class="comment">      Time offset in frames.</span></div>

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

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

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

  516. <div class="line"><a name="l00427"></a><span class="lineno">  427</span>&#160;<span class="comment">   /**</span></div>

  517. <div class="line"><a name="l00428"></a><span class="lineno">  428</span>&#160;<span class="comment">      Number of bytes used.</span></div>

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

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

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

  521. <div class="line"><a name="l00432"></a><span class="lineno">  432</span>&#160;<span class="comment">   /**</span></div>

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

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

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

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

  526. <div class="line"><a name="l00437"></a><span class="lineno">  437</span>&#160;    <span class="keyword">const</span> uint8_t* dataExt;</div>

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

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

  529. <div class="line"><a name="l00440"></a><span class="lineno">  440</span>&#160;<span class="comment">/**</span></div>

  530. <div class="line"><a name="l00441"></a><span class="lineno">  441</span>&#160;<span class="comment">   Time position.</span></div>

  531. <div class="line"><a name="l00442"></a><span class="lineno">  442</span>&#160;<span class="comment">   The @a playing and @a frame values are always valid.</span></div>

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

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

  534. <div class="line"><a name="l00445"></a><span class="lineno">  445</span>&#160;<span class="comment">   This struct is inspired by the JACK Transport API.</span></div>

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

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

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

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

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

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

  541. <div class="line"><a name="l00452"></a><span class="lineno">  452</span>&#160;<span class="comment"></span></div>

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

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

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

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

  546. <div class="line"><a name="l00457"></a><span class="lineno">  457</span>&#160;<span class="comment"></span></div>

  547. <div class="line"><a name="l00458"></a><span class="lineno">  458</span>&#160;<span class="comment">   /**</span></div>

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

  549. <div class="line"><a name="l00460"></a><span class="lineno">  460</span>&#160;<span class="comment">    */</span></div>

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

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

  552. <div class="line"><a name="l00463"></a><span class="lineno">  463</span>&#160;<span class="comment">          Wherever the host transport is using BBT.</span></div>

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

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

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

  556. <div class="line"><a name="l00467"></a><span class="lineno">  467</span>&#160;<span class="comment"></span></div>

  557. <div class="line"><a name="l00468"></a><span class="lineno">  468</span>&#160;<span class="comment">       /**</span></div>

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

  559. <div class="line"><a name="l00470"></a><span class="lineno">  470</span>&#160;<span class="comment">          Should always be &gt; 0.</span></div>

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

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

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

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

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

  565. <div class="line"><a name="l00476"></a><span class="lineno">  476</span>&#160;<span class="comment">          Current beat within bar.</span></div>

  566. <div class="line"><a name="l00477"></a><span class="lineno">  477</span>&#160;<span class="comment">          Should always be &gt; 0 and &lt;= @a beatsPerBar.</span></div>

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

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

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

  570. <div class="line"><a name="l00481"></a><span class="lineno">  481</span>&#160;<span class="comment"></span></div>

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

  572. <div class="line"><a name="l00483"></a><span class="lineno">  483</span>&#160;<span class="comment">          Current tick within beat.</span></div>

  573. <div class="line"><a name="l00484"></a><span class="lineno">  484</span>&#160;<span class="comment">          Should always be &gt; 0 and &lt;= @a ticksPerBeat.</span></div>

  574. <div class="line"><a name="l00485"></a><span class="lineno">  485</span>&#160;<span class="comment">          The first tick is tick &#39;0&#39;.</span></div>

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

  576. <div class="line"><a name="l00487"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ad38d7364a5441f1f49c3538f5691a299">  487</a></span>&#160;        int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#ad38d7364a5441f1f49c3538f5691a299">tick</a>;</div>

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

  578. <div class="line"><a name="l00489"></a><span class="lineno">  489</span>&#160;<span class="comment">       /**</span></div>

  579. <div class="line"><a name="l00490"></a><span class="lineno">  490</span>&#160;<span class="comment">          Number of ticks that have elapsed between frame 0 and the first beat of the current measure.</span></div>

  580. <div class="line"><a name="l00491"></a><span class="lineno">  491</span>&#160;<span class="comment">        */</span></div>

  581. <div class="line"><a name="l00492"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">  492</a></span>&#160;        <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">barStartTick</a>;</div>

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

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

  584. <div class="line"><a name="l00495"></a><span class="lineno">  495</span>&#160;<span class="comment">          Time signature &quot;numerator&quot;.</span></div>

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

  586. <div class="line"><a name="l00497"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">  497</a></span>&#160;        <span class="keywordtype">float</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">beatsPerBar</a>;</div>

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

  588. <div class="line"><a name="l00499"></a><span class="lineno">  499</span>&#160;<span class="comment">       /**</span></div>

  589. <div class="line"><a name="l00500"></a><span class="lineno">  500</span>&#160;<span class="comment">          Time signature &quot;denominator&quot;.</span></div>

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

  591. <div class="line"><a name="l00502"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">  502</a></span>&#160;        <span class="keywordtype">float</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">beatType</a>;</div>

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

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

  594. <div class="line"><a name="l00505"></a><span class="lineno">  505</span>&#160;<span class="comment">          Number of ticks within a bar.</span></div>

  595. <div class="line"><a name="l00506"></a><span class="lineno">  506</span>&#160;<span class="comment">          Usually a moderately large integer with many denominators, such as 1920.0.</span></div>

  596. <div class="line"><a name="l00507"></a><span class="lineno">  507</span>&#160;<span class="comment">        */</span></div>

  597. <div class="line"><a name="l00508"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">  508</a></span>&#160;        <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">ticksPerBeat</a>;</div>

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

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

  600. <div class="line"><a name="l00511"></a><span class="lineno">  511</span>&#160;<span class="comment">          Number of beats per minute.</span></div>

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

  602. <div class="line"><a name="l00513"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">  513</a></span>&#160;        <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">beatsPerMinute</a>;</div>

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

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

  605. <div class="line"><a name="l00516"></a><span class="lineno">  516</span>&#160;<span class="comment">          Default constructor for a null BBT time position.</span></div>

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

  607. <div class="line"><a name="l00518"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef">  518</a></span>&#160;        <a class="code" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef">BarBeatTick</a>() noexcept</div>

  608. <div class="line"><a name="l00519"></a><span class="lineno">  519</span>&#160;            : valid(false),</div>

  609. <div class="line"><a name="l00520"></a><span class="lineno">  520</span>&#160;              bar(0),</div>

  610. <div class="line"><a name="l00521"></a><span class="lineno">  521</span>&#160;              beat(0),</div>

  611. <div class="line"><a name="l00522"></a><span class="lineno">  522</span>&#160;              tick(0),</div>

  612. <div class="line"><a name="l00523"></a><span class="lineno">  523</span>&#160;              barStartTick(0.0),</div>

  613. <div class="line"><a name="l00524"></a><span class="lineno">  524</span>&#160;              beatsPerBar(0.0f),</div>

  614. <div class="line"><a name="l00525"></a><span class="lineno">  525</span>&#160;              beatType(0.0f),</div>

  615. <div class="line"><a name="l00526"></a><span class="lineno">  526</span>&#160;              ticksPerBeat(0.0),</div>

  616. <div class="line"><a name="l00527"></a><span class="lineno">  527</span>&#160;              beatsPerMinute(0.0) {}</div>

  617. <div class="line"><a name="l00528"></a><span class="lineno">  528</span>&#160;    } bbt;</div>

  618. <div class="line"><a name="l00529"></a><span class="lineno">  529</span>&#160;<span class="comment"></span></div>

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

  620. <div class="line"><a name="l00531"></a><span class="lineno">  531</span>&#160;<span class="comment">      Default constructor for a time position.</span></div>

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

  622. <div class="line"><a name="l00533"></a><span class="lineno"><a class="line" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae">  533</a></span>&#160;    <a class="code" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae">TimePosition</a>() noexcept</div>

  623. <div class="line"><a name="l00534"></a><span class="lineno">  534</span>&#160;        : playing(false),</div>

  624. <div class="line"><a name="l00535"></a><span class="lineno">  535</span>&#160;          frame(0),</div>

  625. <div class="line"><a name="l00536"></a><span class="lineno">  536</span>&#160;          bbt() {}</div>

  626. <div class="line"><a name="l00537"></a><span class="lineno">  537</span>&#160;};</div>

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

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

  629. <div class="line"><a name="l00540"></a><span class="lineno">  540</span>&#160;</div>

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

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

  632. <div class="line"><a name="l00543"></a><span class="lineno">  543</span>&#160;<span class="comment"></span></div>

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

  634. <div class="line"><a name="l00545"></a><span class="lineno">  545</span>&#160;<span class="comment">   DPF Plugin class from where plugin instances are created.</span></div>

  635. <div class="line"><a name="l00546"></a><span class="lineno">  546</span>&#160;<span class="comment"></span></div>

  636. <div class="line"><a name="l00547"></a><span class="lineno">  547</span>&#160;<span class="comment">   The public methods (Host state) are called from the plugin to get or set host information.</span></div>

  637. <div class="line"><a name="l00548"></a><span class="lineno">  548</span>&#160;<span class="comment">   They can be called from a plugin instance at anytime unless stated otherwise.</span></div>

  638. <div class="line"><a name="l00549"></a><span class="lineno">  549</span>&#160;<span class="comment">   All other methods are to be implemented by the plugin and will be called by the host.</span></div>

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

  640. <div class="line"><a name="l00551"></a><span class="lineno">  551</span>&#160;<span class="comment">   Shortly after a plugin instance is created, the various d_init* functions will be called by the host.</span></div>

  641. <div class="line"><a name="l00552"></a><span class="lineno">  552</span>&#160;<span class="comment">   Host will call d_activate() before d_run(), and d_deactivate() before the plugin instance is destroyed.</span></div>

  642. <div class="line"><a name="l00553"></a><span class="lineno">  553</span>&#160;<span class="comment">   The host may call deactivate right after activate and vice-versa, but never activate/deactivate consecutively.</span></div>

  643. <div class="line"><a name="l00554"></a><span class="lineno">  554</span>&#160;<span class="comment">   There is no limit on how many times d_run() is called, only that activate/deactivate will be called in between.</span></div>

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

  645. <div class="line"><a name="l00556"></a><span class="lineno">  556</span>&#160;<span class="comment">   The buffer size and sample rate values will remain constant between activate and deactivate.</span></div>

  646. <div class="line"><a name="l00557"></a><span class="lineno">  557</span>&#160;<span class="comment">   Buffer size is only a hint though, the host might call d_run() with a higher or lower number of frames.</span></div>

  647. <div class="line"><a name="l00558"></a><span class="lineno">  558</span>&#160;<span class="comment"></span></div>

  648. <div class="line"><a name="l00559"></a><span class="lineno">  559</span>&#160;<span class="comment">   Some of this class functions are only available according to some macros.</span></div>

  649. <div class="line"><a name="l00560"></a><span class="lineno">  560</span>&#160;<span class="comment"></span></div>

  650. <div class="line"><a name="l00561"></a><span class="lineno">  561</span>&#160;<span class="comment">   DISTRHO_PLUGIN_WANT_PROGRAMS activates program related features.</span></div>

  651. <div class="line"><a name="l00562"></a><span class="lineno">  562</span>&#160;<span class="comment">   When enabled you need to implement d_initProgramName() and d_setProgram().</span></div>

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

  653. <div class="line"><a name="l00564"></a><span class="lineno">  564</span>&#160;<span class="comment">   DISTRHO_PLUGIN_WANT_STATE activates internal state features.</span></div>

  654. <div class="line"><a name="l00565"></a><span class="lineno">  565</span>&#160;<span class="comment">   When enabled you need to implement d_initStateKey() and d_setState().</span></div>

  655. <div class="line"><a name="l00566"></a><span class="lineno">  566</span>&#160;<span class="comment"></span></div>

  656. <div class="line"><a name="l00567"></a><span class="lineno">  567</span>&#160;<span class="comment">   The process function d_run() changes wherever DISTRHO_PLUGIN_WANT_MIDI_INPUT is enabled or not.</span></div>

  657. <div class="line"><a name="l00568"></a><span class="lineno">  568</span>&#160;<span class="comment">   When enabled it provides midi input events.</span></div>

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

  659. <div class="line"><a name="l00570"></a><span class="lineno"><a class="line" href="classPlugin.html">  570</a></span>&#160;<span class="keyword">class </span><a class="code" href="classPlugin.html">Plugin</a></div>

  660. <div class="line"><a name="l00571"></a><span class="lineno">  571</span>&#160;{</div>

  661. <div class="line"><a name="l00572"></a><span class="lineno">  572</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>

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

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

  664. <div class="line"><a name="l00575"></a><span class="lineno">  575</span>&#160;<span class="comment">      You must set all parameter values to their defaults, matching ParameterRanges::def.</span></div>

  665. <div class="line"><a name="l00576"></a><span class="lineno">  576</span>&#160;<span class="comment">      If you&#39;re using states you must also set them to their defaults by calling d_setState().</span></div>

  666. <div class="line"><a name="l00577"></a><span class="lineno">  577</span>&#160;<span class="comment">    */</span></div>

  667. <div class="line"><a name="l00578"></a><span class="lineno">  578</span>&#160;    <a class="code" href="classPlugin.html#a3096e491376cb9378be55915d748de57">Plugin</a>(<span class="keyword">const</span> uint32_t parameterCount, <span class="keyword">const</span> uint32_t programCount, <span class="keyword">const</span> uint32_t stateCount);</div>

  668. <div class="line"><a name="l00579"></a><span class="lineno">  579</span>&#160;<span class="comment"></span></div>

  669. <div class="line"><a name="l00580"></a><span class="lineno">  580</span>&#160;<span class="comment">   /**</span></div>

  670. <div class="line"><a name="l00581"></a><span class="lineno">  581</span>&#160;<span class="comment">      Destructor.</span></div>

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

  672. <div class="line"><a name="l00583"></a><span class="lineno">  583</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">~Plugin</a>();</div>

  673. <div class="line"><a name="l00584"></a><span class="lineno">  584</span>&#160;</div>

  674. <div class="line"><a name="l00585"></a><span class="lineno">  585</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  675. <div class="line"><a name="l00586"></a><span class="lineno">  586</span>&#160;<span class="comment">    * Host state */</span></div>

  676. <div class="line"><a name="l00587"></a><span class="lineno">  587</span>&#160;<span class="comment"></span></div>

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

  678. <div class="line"><a name="l00589"></a><span class="lineno">  589</span>&#160;<span class="comment">      Get the current buffer size that will probably be used during processing, in frames.</span></div>

  679. <div class="line"><a name="l00590"></a><span class="lineno">  590</span>&#160;<span class="comment">      This value will remain constant between activate and deactivate.</span></div>

  680. <div class="line"><a name="l00591"></a><span class="lineno">  591</span>&#160;<span class="comment">      @note: This value is only a hint!</span></div>

  681. <div class="line"><a name="l00592"></a><span class="lineno">  592</span>&#160;<span class="comment">             Hosts might call d_run() with a higher or lower number of frames.</span></div>

  682. <div class="line"><a name="l00593"></a><span class="lineno">  593</span>&#160;<span class="comment">      @see d_bufferSizeChanged(uint32_t)</span></div>

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

  684. <div class="line"><a name="l00595"></a><span class="lineno">  595</span>&#160;    uint32_t <a class="code" href="classPlugin.html#aa0feb17c3dcf13a106505eb6d6b2a3ac">d_getBufferSize</a>() <span class="keyword">const</span> noexcept;</div>

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

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

  687. <div class="line"><a name="l00598"></a><span class="lineno">  598</span>&#160;<span class="comment">      Get the current sample rate that will be used during processing.</span></div>

  688. <div class="line"><a name="l00599"></a><span class="lineno">  599</span>&#160;<span class="comment">      This value will remain constant between activate and deactivate.</span></div>

  689. <div class="line"><a name="l00600"></a><span class="lineno">  600</span>&#160;<span class="comment">      @see d_sampleRateChanged(double)</span></div>

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

  691. <div class="line"><a name="l00602"></a><span class="lineno">  602</span>&#160;    <span class="keywordtype">double</span> <a class="code" href="classPlugin.html#ace888940905e8875284e07c52bf7404f">d_getSampleRate</a>() <span class="keyword">const</span> noexcept;</div>

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

  693. <div class="line"><a name="l00604"></a><span class="lineno">  604</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_TIMEPOS</span></div>

  694. <div class="line"><a name="l00605"></a><span class="lineno">  605</span>&#160;<span class="comment">   /**</span></div>

  695. <div class="line"><a name="l00606"></a><span class="lineno">  606</span>&#160;<span class="comment">      Get the current host transport time position.</span></div>

  696. <div class="line"><a name="l00607"></a><span class="lineno">  607</span>&#160;<span class="comment">      This function should only be called during d_run().</span></div>

  697. <div class="line"><a name="l00608"></a><span class="lineno">  608</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>

  698. <div class="line"><a name="l00609"></a><span class="lineno">  609</span>&#160;<span class="comment">      @note: TimePos is not supported in LADSPA and DSSI plugin formats.</span></div>

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

  700. <div class="line"><a name="l00611"></a><span class="lineno">  611</span>&#160;    <span class="keyword">const</span> <a class="code" href="structTimePosition.html">TimePosition</a>&amp; <a class="code" href="classPlugin.html#ade0a082a3a2936286537a04f4b972225">d_getTimePosition</a>() <span class="keyword">const</span> noexcept;</div>

  701. <div class="line"><a name="l00612"></a><span class="lineno">  612</span>&#160;<span class="preprocessor">#endif</span></div>

  702. <div class="line"><a name="l00613"></a><span class="lineno">  613</span>&#160;</div>

  703. <div class="line"><a name="l00614"></a><span class="lineno">  614</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_LATENCY</span></div>

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

  705. <div class="line"><a name="l00616"></a><span class="lineno">  616</span>&#160;<span class="comment">      Change the plugin audio output latency to @a frames.</span></div>

  706. <div class="line"><a name="l00617"></a><span class="lineno">  617</span>&#160;<span class="comment">      This function should only be called in the constructor, d_activate() and d_run().</span></div>

  707. <div class="line"><a name="l00618"></a><span class="lineno">  618</span>&#160;<span class="comment">      @note This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled.</span></div>

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

  709. <div class="line"><a name="l00620"></a><span class="lineno">  620</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a7816b45ffb52b0a6308cabb792b1a56f">d_setLatency</a>(uint32_t frames) noexcept;</div>

  710. <div class="line"><a name="l00621"></a><span class="lineno">  621</span>&#160;<span class="preprocessor">#endif</span></div>

  711. <div class="line"><a name="l00622"></a><span class="lineno">  622</span>&#160;</div>

  712. <div class="line"><a name="l00623"></a><span class="lineno">  623</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</span></div>

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

  714. <div class="line"><a name="l00625"></a><span class="lineno">  625</span>&#160;<span class="comment">      Write a MIDI output event.</span></div>

  715. <div class="line"><a name="l00626"></a><span class="lineno">  626</span>&#160;<span class="comment">      This function must only be called during d_run().</span></div>

  716. <div class="line"><a name="l00627"></a><span class="lineno">  627</span>&#160;<span class="comment">      Returns false when the host buffer is full, in which case do not call this again until the next d_run().</span></div>

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

  718. <div class="line"><a name="l00629"></a><span class="lineno">  629</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#afa10aea18e4036b4a7487f2779d92e0f">d_writeMidiEvent</a>(<span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>&amp; midiEvent) noexcept;</div>

  719. <div class="line"><a name="l00630"></a><span class="lineno">  630</span>&#160;<span class="preprocessor">#endif</span></div>

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

  721. <div class="line"><a name="l00632"></a><span class="lineno">  632</span>&#160;<span class="keyword">protected</span>:</div>

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

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

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

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

  726. <div class="line"><a name="l00637"></a><span class="lineno">  637</span>&#160;<span class="comment">      Get the plugin name.</span></div>

  727. <div class="line"><a name="l00638"></a><span class="lineno">  638</span>&#160;<span class="comment">      Returns DISTRHO_PLUGIN_NAME by default.</span></div>

  728. <div class="line"><a name="l00639"></a><span class="lineno">  639</span>&#160;<span class="comment">    */</span></div>

  729. <div class="line"><a name="l00640"></a><span class="lineno"><a class="line" href="classPlugin.html#a0f8fb7aa5ab05ba246e158b1024dd031">  640</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a0f8fb7aa5ab05ba246e158b1024dd031">d_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>

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

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

  732. <div class="line"><a name="l00643"></a><span class="lineno">  643</span>&#160;<span class="comment">      Get the plugin label.</span></div>

  733. <div class="line"><a name="l00644"></a><span class="lineno">  644</span>&#160;<span class="comment">      A plugin label follows the same rules as Parameter::symbol, with the exception that it can start with numbers.</span></div>

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

  735. <div class="line"><a name="l00646"></a><span class="lineno">  646</span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#ae512b28d1b274a055de33812cf094d81">d_getLabel</a>() <span class="keyword">const</span> = 0;</div>

  736. <div class="line"><a name="l00647"></a><span class="lineno">  647</span>&#160;<span class="comment"></span></div>

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

  738. <div class="line"><a name="l00649"></a><span class="lineno">  649</span>&#160;<span class="comment">      Get the plugin author/maker.</span></div>

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

  740. <div class="line"><a name="l00651"></a><span class="lineno">  651</span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a0eaf2f46f04d60526622afb5a86e026c">d_getMaker</a>() <span class="keyword">const</span> = 0;</div>

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

  742. <div class="line"><a name="l00653"></a><span class="lineno">  653</span>&#160;<span class="comment">   /**</span></div>

  743. <div class="line"><a name="l00654"></a><span class="lineno">  654</span>&#160;<span class="comment">      Get the plugin license name (a single line of text).</span></div>

  744. <div class="line"><a name="l00655"></a><span class="lineno">  655</span>&#160;<span class="comment">    */</span></div>

  745. <div class="line"><a name="l00656"></a><span class="lineno">  656</span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#ae9333c170accfd2a237448a4579d5fef">d_getLicense</a>() <span class="keyword">const</span> = 0;</div>

  746. <div class="line"><a name="l00657"></a><span class="lineno">  657</span>&#160;<span class="comment"></span></div>

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

  748. <div class="line"><a name="l00659"></a><span class="lineno">  659</span>&#160;<span class="comment">      Get the plugin version, in hexadecimal.</span></div>

  749. <div class="line"><a name="l00660"></a><span class="lineno">  660</span>&#160;<span class="comment">      TODO format to be defined</span></div>

  750. <div class="line"><a name="l00661"></a><span class="lineno">  661</span>&#160;<span class="comment">    */</span></div>

  751. <div class="line"><a name="l00662"></a><span class="lineno">  662</span>&#160;    <span class="keyword">virtual</span> uint32_t <a class="code" href="classPlugin.html#af9251f8d90e4df43c6387bd111487e4e">d_getVersion</a>() <span class="keyword">const</span> = 0;</div>

  752. <div class="line"><a name="l00663"></a><span class="lineno">  663</span>&#160;<span class="comment"></span></div>

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

  754. <div class="line"><a name="l00665"></a><span class="lineno">  665</span>&#160;<span class="comment">      Get the plugin unique Id.</span></div>

  755. <div class="line"><a name="l00666"></a><span class="lineno">  666</span>&#160;<span class="comment">      This value is used by LADSPA, DSSI and VST plugin formats.</span></div>

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

  757. <div class="line"><a name="l00668"></a><span class="lineno">  668</span>&#160;    <span class="keyword">virtual</span> int64_t <a class="code" href="classPlugin.html#aea77208248b36c7b8c9dc57ee68ae97a">d_getUniqueId</a>() <span class="keyword">const</span> = 0;</div>

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

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

  760. <div class="line"><a name="l00671"></a><span class="lineno">  671</span>&#160;<span class="comment">    * Init */</span></div>

  761. <div class="line"><a name="l00672"></a><span class="lineno">  672</span>&#160;<span class="comment"></span></div>

  762. <div class="line"><a name="l00673"></a><span class="lineno">  673</span>&#160;<span class="comment">   /**</span></div>

  763. <div class="line"><a name="l00674"></a><span class="lineno">  674</span>&#160;<span class="comment">      Initialize the parameter @a index.</span></div>

  764. <div class="line"><a name="l00675"></a><span class="lineno">  675</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.</span></div>

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

  766. <div class="line"><a name="l00677"></a><span class="lineno">  677</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a3f93a8eb97db3dc9984c357c5ffca5ec">d_initParameter</a>(uint32_t index, <a class="code" href="structParameter.html">Parameter</a>&amp; parameter) = 0;</div>

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

  768. <div class="line"><a name="l00679"></a><span class="lineno">  679</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span></div>

  769. <div class="line"><a name="l00680"></a><span class="lineno">  680</span>&#160;<span class="comment">   /**</span></div>

  770. <div class="line"><a name="l00681"></a><span class="lineno">  681</span>&#160;<span class="comment">      Set the name of the program @a index.</span></div>

  771. <div class="line"><a name="l00682"></a><span class="lineno">  682</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.</span></div>

  772. <div class="line"><a name="l00683"></a><span class="lineno">  683</span>&#160;<span class="comment">      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.</span></div>

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

  774. <div class="line"><a name="l00685"></a><span class="lineno">  685</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a8a1792b7c5c6a3fd9cd626c7156ec3b6">d_initProgramName</a>(uint32_t index, d_string&amp; programName) = 0;</div>

  775. <div class="line"><a name="l00686"></a><span class="lineno">  686</span>&#160;<span class="preprocessor">#endif</span></div>

  776. <div class="line"><a name="l00687"></a><span class="lineno">  687</span>&#160;</div>

  777. <div class="line"><a name="l00688"></a><span class="lineno">  688</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div>

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

  779. <div class="line"><a name="l00690"></a><span class="lineno">  690</span>&#160;<span class="comment">      Set the state key and default value of @a index.</span></div>

  780. <div class="line"><a name="l00691"></a><span class="lineno">  691</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.</span></div>

  781. <div class="line"><a name="l00692"></a><span class="lineno">  692</span>&#160;<span class="comment">      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.</span></div>

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

  783. <div class="line"><a name="l00694"></a><span class="lineno">  694</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a65f9f9d4a30b0a56dfa42703c0b4db76">d_initState</a>(uint32_t index, d_string&amp; stateKey, d_string&amp; defaultStateValue) = 0;</div>

  784. <div class="line"><a name="l00695"></a><span class="lineno">  695</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

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

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

  789. <div class="line"><a name="l00700"></a><span class="lineno">  700</span>&#160;<span class="comment">   /**</span></div>

  790. <div class="line"><a name="l00701"></a><span class="lineno">  701</span>&#160;<span class="comment">      Get the current value of a parameter.</span></div>

  791. <div class="line"><a name="l00702"></a><span class="lineno">  702</span>&#160;<span class="comment">      The host may call this function from any context, including realtime processing.</span></div>

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

  793. <div class="line"><a name="l00704"></a><span class="lineno">  704</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classPlugin.html#af088f855761b67489f19f42fbb585088">d_getParameterValue</a>(uint32_t index) <span class="keyword">const</span> = 0;</div>

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

  795. <div class="line"><a name="l00706"></a><span class="lineno">  706</span>&#160;<span class="comment">   /**</span></div>

  796. <div class="line"><a name="l00707"></a><span class="lineno">  707</span>&#160;<span class="comment">      Change a parameter value.</span></div>

  797. <div class="line"><a name="l00708"></a><span class="lineno">  708</span>&#160;<span class="comment">      The host may call this function from any context, including realtime processing.</span></div>

  798. <div class="line"><a name="l00709"></a><span class="lineno">  709</span>&#160;<span class="comment">      When a parameter is marked as automable, you must ensure no non-realtime operations are called.</span></div>

  799. <div class="line"><a name="l00710"></a><span class="lineno">  710</span>&#160;<span class="comment">      @note This function will only be called for parameter inputs.</span></div>

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

  801. <div class="line"><a name="l00712"></a><span class="lineno">  712</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a4cdd613f58a013429094700f3d83904a">d_setParameterValue</a>(uint32_t index, <span class="keywordtype">float</span> value) = 0;</div>

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

  803. <div class="line"><a name="l00714"></a><span class="lineno">  714</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span></div>

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

  805. <div class="line"><a name="l00716"></a><span class="lineno">  716</span>&#160;<span class="comment">      Change the currently used program to @a index.</span></div>

  806. <div class="line"><a name="l00717"></a><span class="lineno">  717</span>&#160;<span class="comment">      The host may call this function from any context, including realtime processing.</span></div>

  807. <div class="line"><a name="l00718"></a><span class="lineno">  718</span>&#160;<span class="comment">      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.</span></div>

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

  809. <div class="line"><a name="l00720"></a><span class="lineno">  720</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a1d001e50781b35df23f6d9a218f5f804">d_setProgram</a>(uint32_t index) = 0;</div>

  810. <div class="line"><a name="l00721"></a><span class="lineno">  721</span>&#160;<span class="preprocessor">#endif</span></div>

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

  812. <div class="line"><a name="l00723"></a><span class="lineno">  723</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div>

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

  814. <div class="line"><a name="l00725"></a><span class="lineno">  725</span>&#160;<span class="comment">      Change an internal state @a key to @a value.</span></div>

  815. <div class="line"><a name="l00726"></a><span class="lineno">  726</span>&#160;<span class="comment">      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.</span></div>

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

  817. <div class="line"><a name="l00728"></a><span class="lineno">  728</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ad9c46a36cab96f52a0370043093bca68">d_setState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value) = 0;</div>

  818. <div class="line"><a name="l00729"></a><span class="lineno">  729</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

  821. <div class="line"><a name="l00732"></a><span class="lineno">  732</span>&#160;<span class="comment">    * Process */</span></div>

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

  823. <div class="line"><a name="l00734"></a><span class="lineno">  734</span>&#160;<span class="comment">   /**</span></div>

  824. <div class="line"><a name="l00735"></a><span class="lineno">  735</span>&#160;<span class="comment">      Activate this plugin.</span></div>

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

  826. <div class="line"><a name="l00737"></a><span class="lineno"><a class="line" href="classPlugin.html#a15df4876febf5909fe040d401fc704d0">  737</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a15df4876febf5909fe040d401fc704d0">d_activate</a>() {}</div>

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

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

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

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

  831. <div class="line"><a name="l00742"></a><span class="lineno"><a class="line" href="classPlugin.html#a5c008d623e558e7266aecaff22fc787a">  742</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a5c008d623e558e7266aecaff22fc787a">d_deactivate</a>() {}</div>

  832. <div class="line"><a name="l00743"></a><span class="lineno">  743</span>&#160;</div>

  833. <div class="line"><a name="l00744"></a><span class="lineno">  744</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_INPUT</span></div>

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

  835. <div class="line"><a name="l00746"></a><span class="lineno">  746</span>&#160;<span class="comment">      Run/process function for plugins with MIDI input.</span></div>

  836. <div class="line"><a name="l00747"></a><span class="lineno">  747</span>&#160;<span class="comment">      @note: Some parameters might be null if there are no audio inputs/outputs or MIDI events.</span></div>

  837. <div class="line"><a name="l00748"></a><span class="lineno">  748</span>&#160;<span class="comment">    */</span></div>

  838. <div class="line"><a name="l00749"></a><span class="lineno">  749</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames,</div>

  839. <div class="line"><a name="l00750"></a><span class="lineno">  750</span>&#160;                       <span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>* midiEvents, uint32_t midiEventCount) = 0;</div>

  840. <div class="line"><a name="l00751"></a><span class="lineno">  751</span>&#160;<span class="preprocessor">#else</span></div>

  841. <div class="line"><a name="l00752"></a><span class="lineno">  752</span>&#160;<span class="comment">   /**</span></div>

  842. <div class="line"><a name="l00753"></a><span class="lineno">  753</span>&#160;<span class="comment">      Run/process function for plugins without MIDI input.</span></div>

  843. <div class="line"><a name="l00754"></a><span class="lineno">  754</span>&#160;<span class="comment">      @note: Some parameters might be null if there are no audio inputs or outputs.</span></div>

  844. <div class="line"><a name="l00755"></a><span class="lineno">  755</span>&#160;<span class="comment">    */</span></div>

  845. <div class="line"><a name="l00756"></a><span class="lineno">  756</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames) = 0;</div>

  846. <div class="line"><a name="l00757"></a><span class="lineno">  757</span>&#160;<span class="preprocessor">#endif</span></div>

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

  848. <div class="line"><a name="l00759"></a><span class="lineno">  759</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  849. <div class="line"><a name="l00760"></a><span class="lineno">  760</span>&#160;<span class="comment">    * Callbacks (optional) */</span></div>

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

  851. <div class="line"><a name="l00762"></a><span class="lineno">  762</span>&#160;<span class="comment">   /**</span></div>

  852. <div class="line"><a name="l00763"></a><span class="lineno">  763</span>&#160;<span class="comment">      Optional callback to inform the plugin about a buffer size change.</span></div>

  853. <div class="line"><a name="l00764"></a><span class="lineno">  764</span>&#160;<span class="comment">      This function will only be called when the plugin is deactivated.</span></div>

  854. <div class="line"><a name="l00765"></a><span class="lineno">  765</span>&#160;<span class="comment">      @note: This value is only a hint!</span></div>

  855. <div class="line"><a name="l00766"></a><span class="lineno">  766</span>&#160;<span class="comment">             Hosts might call d_run() with a higher or lower number of frames.</span></div>

  856. <div class="line"><a name="l00767"></a><span class="lineno">  767</span>&#160;<span class="comment">      @see d_getBufferSize()</span></div>

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

  858. <div class="line"><a name="l00769"></a><span class="lineno">  769</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2c6ac454e24b667d54eaaf63da252627">d_bufferSizeChanged</a>(uint32_t newBufferSize);</div>

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

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

  861. <div class="line"><a name="l00772"></a><span class="lineno">  772</span>&#160;<span class="comment">      Optional callback to inform the plugin about a sample rate change.</span></div>

  862. <div class="line"><a name="l00773"></a><span class="lineno">  773</span>&#160;<span class="comment">      This function will only be called when the plugin is deactivated.</span></div>

  863. <div class="line"><a name="l00774"></a><span class="lineno">  774</span>&#160;<span class="comment">      @see d_getSampleRate()</span></div>

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

  865. <div class="line"><a name="l00776"></a><span class="lineno">  776</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a469b53e1c1417a32d766cf96d1b3c45e">d_sampleRateChanged</a>(<span class="keywordtype">double</span> newSampleRate);</div>

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

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

  868. <div class="line"><a name="l00779"></a><span class="lineno">  779</span>&#160;</div>

  869. <div class="line"><a name="l00780"></a><span class="lineno">  780</span>&#160;<span class="keyword">private</span>:</div>

  870. <div class="line"><a name="l00781"></a><span class="lineno">  781</span>&#160;    <span class="keyword">struct </span>PrivateData;</div>

  871. <div class="line"><a name="l00782"></a><span class="lineno">  782</span>&#160;    PrivateData* <span class="keyword">const</span> pData;</div>

  872. <div class="line"><a name="l00783"></a><span class="lineno">  783</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span>PluginExporter;</div>

  873. <div class="line"><a name="l00784"></a><span class="lineno">  784</span>&#160;</div>

  874. <div class="line"><a name="l00785"></a><span class="lineno">  785</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classPlugin.html">Plugin</a>)</div>

  875. <div class="line"><a name="l00786"></a><span class="lineno">  786</span>&#160;};</div>

  876. <div class="line"><a name="l00787"></a><span class="lineno">  787</span>&#160;</div>

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

  878. <div class="line"><a name="l00789"></a><span class="lineno">  789</span>&#160;<span class="comment"> * Create plugin, entry point */</span></div>

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

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

  881. <div class="line"><a name="l00792"></a><span class="lineno">  792</span>&#160;<span class="comment">   TODO.</span></div>

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

  883. <div class="line"><a name="l00794"></a><span class="lineno">  794</span>&#160;<span class="keyword">extern</span> <a class="code" href="classPlugin.html">Plugin</a>* createPlugin();</div>

  884. <div class="line"><a name="l00795"></a><span class="lineno">  795</span>&#160;</div>

  885. <div class="line"><a name="l00796"></a><span class="lineno">  796</span>&#160;<span class="comment">// -----------------------------------------------------------------------------------------------------------</span></div>

  886. <div class="line"><a name="l00797"></a><span class="lineno">  797</span>&#160;</div>

  887. <div class="line"><a name="l00798"></a><span class="lineno">  798</span>&#160;END_NAMESPACE_DISTRHO</div>

  888. <div class="line"><a name="l00799"></a><span class="lineno">  799</span>&#160;</div>

  889. <div class="line"><a name="l00800"></a><span class="lineno">  800</span>&#160;<span class="preprocessor">#endif // DISTRHO_PLUGIN_HPP_INCLUDED</span></div>

  890. <div class="ttc" id="structParameterRanges_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:262</div></div>

  891. <div class="ttc" id="classPlugin_html_a0eaf2f46f04d60526622afb5a86e026c"><div class="ttname"><a href="classPlugin.html#a0eaf2f46f04d60526622afb5a86e026c">Plugin::d_getMaker</a></div><div class="ttdeci">virtual const char * d_getMaker() const =0</div></div>

  892. <div class="ttc" id="classPlugin_html_a65f9f9d4a30b0a56dfa42703c0b4db76"><div class="ttname"><a href="classPlugin.html#a65f9f9d4a30b0a56dfa42703c0b4db76">Plugin::d_initState</a></div><div class="ttdeci">virtual void d_initState(uint32_t index, d_string &amp;stateKey, d_string &amp;defaultStateValue)=0</div></div>

  893. <div class="ttc" id="classPlugin_html_a5c008d623e558e7266aecaff22fc787a"><div class="ttname"><a href="classPlugin.html#a5c008d623e558e7266aecaff22fc787a">Plugin::d_deactivate</a></div><div class="ttdeci">virtual void d_deactivate()</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:742</div></div>

  894. <div class="ttc" id="classPlugin_html_a3096e491376cb9378be55915d748de57"><div class="ttname"><a href="classPlugin.html#a3096e491376cb9378be55915d748de57">Plugin::Plugin</a></div><div class="ttdeci">Plugin(const uint32_t parameterCount, const uint32_t programCount, const uint32_t stateCount)</div></div>

  895. <div class="ttc" id="classPlugin_html_ade0a082a3a2936286537a04f4b972225"><div class="ttname"><a href="classPlugin.html#ade0a082a3a2936286537a04f4b972225">Plugin::d_getTimePosition</a></div><div class="ttdeci">const TimePosition &amp; d_getTimePosition() const noexcept</div></div>

  896. <div class="ttc" id="classPlugin_html_aea77208248b36c7b8c9dc57ee68ae97a"><div class="ttname"><a href="classPlugin.html#aea77208248b36c7b8c9dc57ee68ae97a">Plugin::d_getUniqueId</a></div><div class="ttdeci">virtual int64_t d_getUniqueId() const =0</div></div>

  897. <div class="ttc" id="structParameter_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:405</div></div>

  898. <div class="ttc" id="structMidiEvent_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:425</div></div>

  899. <div class="ttc" id="classPlugin_html_af9251f8d90e4df43c6387bd111487e4e"><div class="ttname"><a href="classPlugin.html#af9251f8d90e4df43c6387bd111487e4e">Plugin::d_getVersion</a></div><div class="ttdeci">virtual uint32_t d_getVersion() const =0</div></div>

  900. <div class="ttc" id="structMidiEvent_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:430</div></div>

  901. <div class="ttc" id="classPlugin_html_afa10aea18e4036b4a7487f2779d92e0f"><div class="ttname"><a href="classPlugin.html#afa10aea18e4036b4a7487f2779d92e0f">Plugin::d_writeMidiEvent</a></div><div class="ttdeci">bool d_writeMidiEvent(const MidiEvent &amp;midiEvent) noexcept</div></div>

  902. <div class="ttc" id="structMidiEvent_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:436</div></div>

  903. <div class="ttc" id="classPlugin_html_af088f855761b67489f19f42fbb585088"><div class="ttname"><a href="classPlugin.html#af088f855761b67489f19f42fbb585088">Plugin::d_getParameterValue</a></div><div class="ttdeci">virtual float d_getParameterValue(uint32_t index) const =0</div></div>

  904. <div class="ttc" id="classPlugin_html_a4cdd613f58a013429094700f3d83904a"><div class="ttname"><a href="classPlugin.html#a4cdd613f58a013429094700f3d83904a">Plugin::d_setParameterValue</a></div><div class="ttdeci">virtual void d_setParameterValue(uint32_t index, float value)=0</div></div>

  905. <div class="ttc" id="classPlugin_html_ae512b28d1b274a055de33812cf094d81"><div class="ttname"><a href="classPlugin.html#ae512b28d1b274a055de33812cf094d81">Plugin::d_getLabel</a></div><div class="ttdeci">virtual const char * d_getLabel() const =0</div></div>

  906. <div class="ttc" id="structParameterRanges_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:296</div></div>

  907. <div class="ttc" id="classPlugin_html_a469b53e1c1417a32d766cf96d1b3c45e"><div class="ttname"><a href="classPlugin.html#a469b53e1c1417a32d766cf96d1b3c45e">Plugin::d_sampleRateChanged</a></div><div class="ttdeci">virtual void d_sampleRateChanged(double newSampleRate)</div></div>

  908. <div class="ttc" id="structTimePosition_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:508</div></div>

  909. <div class="ttc" id="classPlugin_html_a0f8fb7aa5ab05ba246e158b1024dd031"><div class="ttname"><a href="classPlugin.html#a0f8fb7aa5ab05ba246e158b1024dd031">Plugin::d_getName</a></div><div class="ttdeci">virtual const char * d_getName() const </div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:640</div></div>

  910. <div class="ttc" id="structMidiEvent_html"><div class="ttname"><a href="structMidiEvent.html">MidiEvent</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:416</div></div>

  911. <div class="ttc" id="structTimePosition_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:473</div></div>

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

  913. <div class="ttc" id="classPlugin_html_ae9333c170accfd2a237448a4579d5fef"><div class="ttname"><a href="classPlugin.html#ae9333c170accfd2a237448a4579d5fef">Plugin::d_getLicense</a></div><div class="ttdeci">virtual const char * d_getLicense() const =0</div></div>

  914. <div class="ttc" id="group__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> DistrhoPlugin.hpp:86</div></div>

  915. <div class="ttc" id="structParameterRanges_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:272</div></div>

  916. <div class="ttc" id="structTimePosition_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:513</div></div>

  917. <div class="ttc" id="structParameter_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:372</div></div>

  918. <div class="ttc" id="group__ParameterHints_html_ga1eae4d034f2ff1bc14035d87c4b63b14"><div class="ttname"><a href="group__ParameterHints.html#ga1eae4d034f2ff1bc14035d87c4b63b14">kParameterIsCV</a></div><div class="ttdeci">static const uint32_t kParameterIsCV</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:234</div></div>

  919. <div class="ttc" id="classPlugin_html"><div class="ttname"><a href="classPlugin.html">Plugin</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:570</div></div>

  920. <div class="ttc" id="structParameterRanges_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:353</div></div>

  921. <div class="ttc" id="structTimePosition_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:451</div></div>

  922. <div class="ttc" id="structTimePosition_1_1BarBeatTick_html_ad38d7364a5441f1f49c3538f5691a299"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html#ad38d7364a5441f1f49c3538f5691a299">TimePosition::BarBeatTick::tick</a></div><div class="ttdeci">int32_t tick</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:487</div></div>

  923. <div class="ttc" id="structTimePosition_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:497</div></div>

  924. <div class="ttc" id="classPlugin_html_a89814b8f0b1c91e49140d42eb8331383"><div class="ttname"><a href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">Plugin::~Plugin</a></div><div class="ttdeci">virtual ~Plugin()</div></div>

  925. <div class="ttc" id="structTimePosition_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:533</div></div>

  926. <div class="ttc" id="classPlugin_html_a1d001e50781b35df23f6d9a218f5f804"><div class="ttname"><a href="classPlugin.html#a1d001e50781b35df23f6d9a218f5f804">Plugin::d_setProgram</a></div><div class="ttdeci">virtual void d_setProgram(uint32_t index)=0</div></div>

  927. <div class="ttc" id="structTimePosition_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:456</div></div>

  928. <div class="ttc" id="structTimePosition_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:518</div></div>

  929. <div class="ttc" id="group__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:203</div></div>

  930. <div class="ttc" id="classPlugin_html_ad9c46a36cab96f52a0370043093bca68"><div class="ttname"><a href="classPlugin.html#ad9c46a36cab96f52a0370043093bca68">Plugin::d_setState</a></div><div class="ttdeci">virtual void d_setState(const char *key, const char *value)=0</div></div>

  931. <div class="ttc" id="structTimePosition_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:502</div></div>

  932. <div class="ttc" id="structParameterRanges_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:319</div></div>

  933. <div class="ttc" id="structParameterRanges_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:257</div></div>

  934. <div class="ttc" id="structTimePosition_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:492</div></div>

  935. <div class="ttc" id="structParameter_html_a2e75f234cbbda1ed0517075e67d27191"><div class="ttname"><a href="structParameter.html#a2e75f234cbbda1ed0517075e67d27191">Parameter::name</a></div><div class="ttdeci">d_string name</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:379</div></div>

  936. <div class="ttc" id="classPlugin_html_a7816b45ffb52b0a6308cabb792b1a56f"><div class="ttname"><a href="classPlugin.html#a7816b45ffb52b0a6308cabb792b1a56f">Plugin::d_setLatency</a></div><div class="ttdeci">void d_setLatency(uint32_t frames) noexcept</div></div>

  937. <div class="ttc" id="structParameter_html_aa9ee36848d60d8ddd9185b9a3f2ce93f"><div class="ttname"><a href="structParameter.html#aa9ee36848d60d8ddd9185b9a3f2ce93f">Parameter::unit</a></div><div class="ttdeci">d_string unit</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:394</div></div>

  938. <div class="ttc" id="structParameter_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:400</div></div>

  939. <div class="ttc" id="structTimePosition_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:480</div></div>

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

  941. <div class="ttc" id="classPlugin_html_a2c6ac454e24b667d54eaaf63da252627"><div class="ttname"><a href="classPlugin.html#a2c6ac454e24b667d54eaaf63da252627">Plugin::d_bufferSizeChanged</a></div><div class="ttdeci">virtual void d_bufferSizeChanged(uint32_t newBufferSize)</div></div>

  942. <div class="ttc" id="structParameterRanges_html_acd3d977c154ddb3138f36c0b6d2b7626"><div class="ttname"><a href="structParameterRanges.html#acd3d977c154ddb3138f36c0b6d2b7626">ParameterRanges::getFixedValue</a></div><div class="ttdeci">const float &amp; getFixedValue(const float &amp;value) const noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:307</div></div>

  943. <div class="ttc" id="group__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:209</div></div>

  944. <div class="ttc" id="structParameterRanges_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:267</div></div>

  945. <div class="ttc" id="structParameterRanges_html"><div class="ttname"><a href="structParameterRanges.html">ParameterRanges</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:253</div></div>

  946. <div class="ttc" id="group__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:214</div></div>

  947. <div class="ttc" id="structParameter_html"><div class="ttname"><a href="structParameter.html">Parameter</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:367</div></div>

  948. <div class="ttc" id="structTimePosition_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:466</div></div>

  949. <div class="ttc" id="structMidiEvent_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:420</div></div>

  950. <div class="ttc" id="structParameter_html_a0b5193e6131f65878dfb6fe4d9f5e970"><div class="ttname"><a href="structParameter.html#a0b5193e6131f65878dfb6fe4d9f5e970">Parameter::symbol</a></div><div class="ttdeci">d_string symbol</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:387</div></div>

  951. <div class="ttc" id="structParameterRanges_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:288</div></div>

  952. <div class="ttc" id="classPlugin_html_ace888940905e8875284e07c52bf7404f"><div class="ttname"><a href="classPlugin.html#ace888940905e8875284e07c52bf7404f">Plugin::d_getSampleRate</a></div><div class="ttdeci">double d_getSampleRate() const noexcept</div></div>

  953. <div class="ttc" id="structParameterRanges_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:333</div></div>

  954. <div class="ttc" id="classPlugin_html_a15df4876febf5909fe040d401fc704d0"><div class="ttname"><a href="classPlugin.html#a15df4876febf5909fe040d401fc704d0">Plugin::d_activate</a></div><div class="ttdeci">virtual void d_activate()</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:737</div></div>

  955. <div class="ttc" id="group__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:229</div></div>

  956. <div class="ttc" id="structTimePosition_1_1BarBeatTick_html"><div class="ttname"><a href="structTimePosition_1_1BarBeatTick.html">TimePosition::BarBeatTick</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:461</div></div>

  957. <div class="ttc" id="structTimePosition_html"><div class="ttname"><a href="structTimePosition.html">TimePosition</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:447</div></div>

  958. <div class="ttc" id="classPlugin_html_a8a1792b7c5c6a3fd9cd626c7156ec3b6"><div class="ttname"><a href="classPlugin.html#a8a1792b7c5c6a3fd9cd626c7156ec3b6">Plugin::d_initProgramName</a></div><div class="ttdeci">virtual void d_initProgramName(uint32_t index, d_string &amp;programName)=0</div></div>

  959. <div class="ttc" id="classPlugin_html_aa0feb17c3dcf13a106505eb6d6b2a3ac"><div class="ttname"><a href="classPlugin.html#aa0feb17c3dcf13a106505eb6d6b2a3ac">Plugin::d_getBufferSize</a></div><div class="ttdeci">uint32_t d_getBufferSize() const noexcept</div></div>

  960. <div class="ttc" id="group__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:219</div></div>

  961. <div class="ttc" id="structParameterRanges_html_aad2afc730bee791aab1811744a48f99d"><div class="ttname"><a href="structParameterRanges.html#aad2afc730bee791aab1811744a48f99d">ParameterRanges::ParameterRanges</a></div><div class="ttdeci">ParameterRanges(const float df, const float mn, const float mx) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:280</div></div>

  962. </div><!-- fragment --></div><!-- contents -->

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

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

  965. Generated on Tue Apr 21 2015 15:18:54 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  967. </a> 1.8.8

  968. </small></address>

  969. </body>

  970. </html>