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.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/DistrhoPlugin_8hpp_source.html

548 lines
87KB
Raw Permalink Blame History 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

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

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

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

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63.   <ul>

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

  65. </div>

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

  67. <div class="header">

  68.   <div class="headertitle">

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

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

  71. <div class="contents">

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

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

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

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

  76. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>

  77. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>

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

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

  80. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>

  81. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>

  82. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>

  83. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>

  84. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>

  85. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  101. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">   @defgroup MainClasses Main Classes</span></div>

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

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

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

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

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

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

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

  109. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">   They can be called from a plugin instance at anytime unless stated otherwise.@n</span></div>

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

  111. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment"></span> </div>

  112. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">   Shortly after a plugin instance is created, the various init* functions will be called by the host.@n</span></div>

  113. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">   Host will call activate() before run(), and deactivate() before the plugin instance is destroyed.@n</span></div>

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

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

  116. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"></span> </div>

  117. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">   The buffer size and sample rate values will remain constant between activate and deactivate.@n</span></div>

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

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

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

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

  122. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">   DISTRHO_PLUGIN_WANT_PROGRAMS activates program related features.@n</span></div>

  123. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">   When enabled you need to implement initProgramName() and loadProgram().</span></div>

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

  125. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">   DISTRHO_PLUGIN_WANT_STATE activates internal state features.@n</span></div>

  126. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">   When enabled you need to implement initState() and setState().</span></div>

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

  128. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">   The process function run() changes wherever DISTRHO_PLUGIN_WANT_MIDI_INPUT is enabled or not.@n</span></div>

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

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

  131. <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classPlugin.html">   60</a></span>&#160;<span class="keyword">class </span><a class="code" href="classPlugin.html">Plugin</a></div>

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

  133. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>

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

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

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

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

  138. <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">   67</a></span>&#160;    <a class="code" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin</a>(uint32_t parameterCount, uint32_t programCount, uint32_t stateCount);</div>

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

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

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

  142. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">    */</span></div>

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

  144. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160; </div>

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

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

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

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

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

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

  151. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">      @note This value is only a hint!@n</span></div>

  152. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">            Hosts might call run() with a higher or lower number of frames.</span></div>

  153. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">      @see bufferSizeChanged(uint32_t)</span></div>

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

  155. <div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">   84</a></span>&#160;    uint32_t <a class="code" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize</a>() const noexcept;</div>

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

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

  158. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment">      Get the current sample rate that will be used during processing.@n</span></div>

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

  160. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">      @see sampleRateChanged(double)</span></div>

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

  162. <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">   91</a></span>&#160;    <span class="keywordtype">double</span> <a class="code" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">getSampleRate</a>() const noexcept;</div>

  163. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"></span> </div>

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

  165. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">      Get the bundle path where the plugin resides.</span></div>

  166. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment">      Can return null if the plugin is not available in a bundle (if it is a single binary).</span></div>

  167. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment">      @see getBinaryFilename</span></div>

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

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

  170. <div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classPlugin.html#a5fd60c82f5a50f12312c57729885fc2f">   99</a></span>&#160;    const <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a5fd60c82f5a50f12312c57729885fc2f">getBundlePath</a>() const noexcept;</div>

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

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

  173. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">      Check if this plugin instance is a &quot;dummy&quot; one used for plugin meta-data/information export.@n</span></div>

  174. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment">      When true no processing will be done, the plugin is created only to extract information.@n</span></div>

  175. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment">      In DPF, LADSPA/DSSI, VST2 and VST3 formats create one global instance per plugin binary</span></div>

  176. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment">      while LV2 creates one when generating turtle meta-data.</span></div>

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

  178. <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classPlugin.html#ab2c6b7bc2e0cdcd589cf9d03be831042">  107</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#ab2c6b7bc2e0cdcd589cf9d03be831042">isDummyInstance</a>() const noexcept;</div>

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

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

  181. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment">      Check if this plugin instance is a &quot;selftest&quot; one used for automated plugin tests.@n</span></div>

  182. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">      To enable this mode build with `DPF_RUNTIME_TESTING` macro defined (i.e. set as compiler build flag),</span></div>

  183. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">      and run the JACK/Standalone executable with &quot;selftest&quot; as its only and single argument.</span></div>

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

  185. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">      A few basic DSP and UI tests will run in self-test mode, with once instance having this function returning true.@n</span></div>

  186. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">      You can use this chance to do a few tests of your own as well.</span></div>

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

  188. <div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classPlugin.html#a8d07561f935bf9918e8b395e6eaabfa0">  117</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#a8d07561f935bf9918e8b395e6eaabfa0">isSelfTestInstance</a>() const noexcept;</div>

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

  190. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_TIMEPOS</span><span class="comment"></span></div>

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

  192. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment">      Get the current host transport time position.@n</span></div>

  193. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment">      This function should only be called during run().@n</span></div>

  194. <div class="line"><a name="l00123"></a><span class="lineno">  123</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>

  195. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment">      @note TimePosition is not supported in LADSPA and DSSI plugin formats.</span></div>

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

  197. <div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">  126</a></span>&#160;    <span class="keyword">const</span> <a class="code" href="structTimePosition.html">TimePosition</a>&amp; <a class="code" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">getTimePosition</a>() const noexcept;</div>

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

  199. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160; </div>

  200. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_LATENCY</span><span class="comment"></span></div>

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

  202. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">      Change the plugin audio output latency to @a frames.@n</span></div>

  203. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">      This function should only be called in the constructor, activate() and run().</span></div>

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

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

  206. <div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">  135</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">setLatency</a>(uint32_t frames) noexcept;</div>

  207. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

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

  211. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment">      Write a MIDI output event.@n</span></div>

  212. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment">      This function must only be called during run().@n</span></div>

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

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

  215. <div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">  144</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">writeMidiEvent</a>(<span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>&amp; midiEvent) noexcept;</div>

  216. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

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

  220. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment">      Check if parameter value change requests will work with the current plugin host.</span></div>

  221. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment">      @note This function is only available if DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST is enabled.</span></div>

  222. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment">      @see requestParameterValueChange(uint32_t, float)</span></div>

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

  224. <div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classPlugin.html#a581614e1d301ee613a988855c61b2517">  153</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#a581614e1d301ee613a988855c61b2517">canRequestParameterValueChanges</a>() const noexcept;</div>

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

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

  227. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment">      Request a parameter value change from the host.</span></div>

  228. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">      If successful, this function will automatically trigger a parameter update on the UI side as well.</span></div>

  229. <div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">      This function can fail, for example if the host is busy with the parameter for read-only automation.</span></div>

  230. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">      Some hosts simply do not have this functionality, which can be verified with canRequestParameterValueChanges().</span></div>

  231. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">      @note This function is only available if DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST is enabled.</span></div>

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

  233. <div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">  162</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">requestParameterValueChange</a>(uint32_t index, <span class="keywordtype">float</span> value) noexcept;</div>

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

  235. <div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160; </div>

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

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

  238. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment">      Set state value and notify the host about the change.@n</span></div>

  239. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment">      This function will call `setState()` and also trigger an update on the UI side as necessary.@n</span></div>

  240. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment">      It must not be called during run.@n</span></div>

  241. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment">      The state must be host readable.</span></div>

  242. <div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment">      @note this function does nothing on DSSI plugin format, as DSSI only supports UI-&gt;DSP messages.</span></div>

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

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

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

  246. <div class="line"><a name="l00175"></a><span class="lineno"><a class="line" href="classPlugin.html#aa85c50c732d9083f57b72d6b4cd7c5ae">  175</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#aa85c50c732d9083f57b72d6b4cd7c5ae">updateStateValue</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value) noexcept;</div>

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

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

  249. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="keyword">protected</span>:</div>

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

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

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

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

  254. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment">      Get the plugin name.@n</span></div>

  255. <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment">      Returns DISTRHO_PLUGIN_NAME by default.</span></div>

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

  257. <div class="line"><a name="l00186"></a><span class="lineno"><a class="line" href="classPlugin.html#aebb5df5cde162462dc460d4fd45dae75">  186</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#aebb5df5cde162462dc460d4fd45dae75">getName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a>; }</div>

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

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

  260. <div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">      Get the plugin label.@n</span></div>

  261. <div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment">      This label is a short restricted name consisting of only _, a-z, A-Z and 0-9 characters.</span></div>

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

  263. <div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">  192</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">getLabel</a>() <span class="keyword">const</span> = 0;</div>

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

  265. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment">   /**</span></div>

  266. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment">      Get an extensive comment/description about the plugin.@n</span></div>

  267. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment">      Optional, returns nothing by default.</span></div>

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

  269. <div class="line"><a name="l00198"></a><span class="lineno"><a class="line" href="classPlugin.html#a30db5eef9de617f4c81d5c6925facea3">  198</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a30db5eef9de617f4c81d5c6925facea3">getDescription</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; }</div>

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

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

  272. <div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment">      Get the plugin author/maker.</span></div>

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

  274. <div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">  203</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">getMaker</a>() <span class="keyword">const</span> = 0;</div>

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

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

  277. <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment">      Get the plugin homepage.@n</span></div>

  278. <div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment">      Optional, returns nothing by default.</span></div>

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

  280. <div class="line"><a name="l00209"></a><span class="lineno"><a class="line" href="classPlugin.html#ad12c681ce31004da0badd609763f45c5">  209</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#ad12c681ce31004da0badd609763f45c5">getHomePage</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; }</div>

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

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

  283. <div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="comment">      Get the plugin license (a single line of text or a URL).@n</span></div>

  284. <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="comment">      For commercial plugins this should return some short copyright information.</span></div>

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

  286. <div class="line"><a name="l00215"></a><span class="lineno"><a class="line" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">  215</a></span>&#160;    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">getLicense</a>() <span class="keyword">const</span> = 0;</div>

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

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

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

  290. <div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment">      @see d_version()</span></div>

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

  292. <div class="line"><a name="l00221"></a><span class="lineno"><a class="line" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">  221</a></span>&#160;    <span class="keyword">virtual</span> uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>() <span class="keyword">const</span> = 0;</div>

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

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

  295. <div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment">      Get the plugin unique Id.@n</span></div>

  296. <div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment">      This value is used by LADSPA, DSSI, VST2, VST3 and AUv2 plugin formats.@n</span></div>

  297. <div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment">      @note It is preferred that you set DISTRHO_PLUGIN_UNIQUE_ID macro instead of overriding this call,</span></div>

  298. <div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment">            as that is required for AUv2 plugins anyhow.</span></div>

  299. <div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="comment">      @see d_cconst()</span></div>

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

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

  302. <div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;    <span class="keyword">virtual</span> int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>()<span class="keyword"> const</span></div>

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

  304. <div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;         <span class="keywordflow">return</span> <a class="code" href="group__MiscellaneousFunctions.html#ga6827e90feb9bdcb6f76175a245fbf12c">d_cconst</a>(STRINGIFY(<a class="code" href="group__PluginMacros.html#ga096d7684289e65485311a427ad8772f3">DISTRHO_PLUGIN_UNIQUE_ID</a>));</div>

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

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

  307. <div class="line"><a name="l00236"></a><span class="lineno"><a class="line" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">  236</a></span>&#160;    <span class="keyword">virtual</span> int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>() <span class="keyword">const</span> = 0;</div>

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

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

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

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

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

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

  314. <div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment">      Initialize the audio port @a index.@n</span></div>

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

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

  317. <div class="line"><a name="l00246"></a><span class="lineno"><a class="line" href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">  246</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">initAudioPort</a>(<span class="keywordtype">bool</span> input, uint32_t index, <a class="code" href="structAudioPort.html">AudioPort</a>&amp; port);</div>

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

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

  320. <div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;<span class="comment">      Initialize the parameter @a index.@n</span></div>

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

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

  323. <div class="line"><a name="l00252"></a><span class="lineno"><a class="line" href="classPlugin.html#aacf87bd0037efeb3b60d204940f3f4a0">  252</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aacf87bd0037efeb3b60d204940f3f4a0">initParameter</a>(uint32_t index, <a class="code" href="structParameter.html">Parameter</a>&amp; parameter);</div>

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

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

  326. <div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment">      Initialize the port group @a groupId.@n</span></div>

  327. <div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment">      This function will be called once,</span></div>

  328. <div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment">      shortly after the plugin is created and all audio ports and parameters have been enumerated.</span></div>

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

  330. <div class="line"><a name="l00259"></a><span class="lineno"><a class="line" href="classPlugin.html#a71b876c8157b087b3552960f2877a44d">  259</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a71b876c8157b087b3552960f2877a44d">initPortGroup</a>(uint32_t groupId, <a class="code" href="structPortGroup.html">PortGroup</a>&amp; portGroup);</div>

  331. <div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160; </div>

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

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

  334. <div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;<span class="comment">      Set the name of the program @a index.@n</span></div>

  335. <div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.@n</span></div>

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

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

  338. <div class="line"><a name="l00267"></a><span class="lineno"><a class="line" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">  267</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">initProgramName</a>(uint32_t index, <a class="code" href="classString.html">String</a>&amp; programName) = 0;</div>

  339. <div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

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

  343. <div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;<span class="comment">      Initialize the state @a index.@n</span></div>

  344. <div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;<span class="comment">      This function will be called once, shortly after the plugin is created.@n</span></div>

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

  346. <div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;<span class="comment">    */</span></div>

  347. <div class="line"><a name="l00276"></a><span class="lineno"><a class="line" href="classPlugin.html#ad4ab623187f905c250a42284704eb840">  276</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ad4ab623187f905c250a42284704eb840">initState</a>(uint32_t index, <a class="code" href="structState.html">State</a>&amp; state);</div>

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

  349. <div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;    DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;initState(uint32_t,State&amp;)&quot;</span>)</div>

  350. <div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;    virtual <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ad4ab623187f905c250a42284704eb840">initState</a>(uint32_t, <a class="code" href="classString.html">String</a>&amp;, <a class="code" href="classString.html">String</a>&amp;) {}</div>

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

  352. <div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;    DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;initState(uint32_t,State&amp;)&quot;</span>)</div>

  353. <div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;    virtual <span class="keywordtype">bool</span> isStateFile(uint32_t) { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>

  354. <div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

  357. <div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;<span class="comment">    * Internal data */</span></div>

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

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

  360. <div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;<span class="comment">      Get the current value of a parameter.@n</span></div>

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

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

  363. <div class="line"><a name="l00292"></a><span class="lineno"><a class="line" href="classPlugin.html#af9e9f5438e2e0c2352052eb5f95832aa">  292</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classPlugin.html#af9e9f5438e2e0c2352052eb5f95832aa">getParameterValue</a>(uint32_t index) <span class="keyword">const</span>;</div>

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

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

  366. <div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;<span class="comment">      Change a parameter value.@n</span></div>

  367. <div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;<span class="comment">      The host may call this function from any context, including realtime processing.@n</span></div>

  368. <div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;<span class="comment">      When a parameter is marked as automatable, you must ensure no non-realtime operations are performed.</span></div>

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

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

  371. <div class="line"><a name="l00300"></a><span class="lineno"><a class="line" href="classPlugin.html#a7e9e26ceafc7603ef6163483a9dc39be">  300</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a7e9e26ceafc7603ef6163483a9dc39be">setParameterValue</a>(uint32_t index, <span class="keywordtype">float</span> value);</div>

  372. <div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160; </div>

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

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

  375. <div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="comment">      Load a program.@n</span></div>

  376. <div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="comment">      The host may call this function from any context, including realtime processing.@n</span></div>

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

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

  379. <div class="line"><a name="l00308"></a><span class="lineno"><a class="line" href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8">  308</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8">loadProgram</a>(uint32_t index);</div>

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

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

  382. <div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_FULL_STATE</span><span class="comment"></span></div>

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

  384. <div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;<span class="comment">      Get the value of an internal state.@n</span></div>

  385. <div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;<span class="comment">      The host may call this function from any non-realtime context.@n</span></div>

  386. <div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;<span class="comment">      Must be implemented by your plugin class if DISTRHO_PLUGIN_WANT_FULL_STATE is enabled.</span></div>

  387. <div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;<span class="comment">      @note The use of this function breaks compatibility with the DSSI format.</span></div>

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

  389. <div class="line"><a name="l00318"></a><span class="lineno"><a class="line" href="classPlugin.html#a9cf24d4880f200eaeacd08a591d00d1f">  318</a></span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classString.html">String</a> <a class="code" href="classPlugin.html#a9cf24d4880f200eaeacd08a591d00d1f">getState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key) <span class="keyword">const</span>;</div>

  390. <div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

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

  394. <div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;<span class="comment">      Change an internal state @a key to @a value.@n</span></div>

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

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

  397. <div class="line"><a name="l00326"></a><span class="lineno"><a class="line" href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">  326</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">setState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value);</div>

  398. <div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;<span class="preprocessor">#endif</span></div>

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

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

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

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

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

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

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

  406. <div class="line"><a name="l00335"></a><span class="lineno"><a class="line" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">  335</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">activate</a>() {}</div>

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

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

  409. <div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;<span class="comment">      Deactivate this plugin.</span></div>

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

  411. <div class="line"><a name="l00340"></a><span class="lineno"><a class="line" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46">  340</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46">deactivate</a>() {}</div>

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

  413. <div class="line"><a name="l00342"></a><span class="lineno">  342</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_INPUT</span><span class="comment"></span></div>

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

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

  416. <div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160;<span class="comment">      @note Some parameters might be null if there are no audio inputs/outputs or MIDI events.</span></div>

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

  418. <div class="line"><a name="l00347"></a><span class="lineno"><a class="line" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">  347</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames,</div>

  419. <div class="line"><a name="l00348"></a><span class="lineno">  348</span>&#160;                     <span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>* midiEvents, uint32_t midiEventCount) = 0;</div>

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

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

  422. <div class="line"><a name="l00351"></a><span class="lineno">  351</span>&#160;<span class="comment">      Run/process function for plugins without MIDI input.</span></div>

  423. <div class="line"><a name="l00352"></a><span class="lineno">  352</span>&#160;<span class="comment">      @note Some parameters might be null if there are no audio inputs or outputs.</span></div>

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

  425. <div class="line"><a name="l00354"></a><span class="lineno">  354</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames) = 0;</div>

  426. <div class="line"><a name="l00355"></a><span class="lineno">  355</span>&#160;<span class="preprocessor">#endif</span></div>

  427. <div class="line"><a name="l00356"></a><span class="lineno">  356</span>&#160; </div>

  428. <div class="line"><a name="l00357"></a><span class="lineno">  357</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  429. <div class="line"><a name="l00358"></a><span class="lineno">  358</span>&#160;<span class="comment">    * Callbacks (optional) */</span></div>

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

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

  432. <div class="line"><a name="l00361"></a><span class="lineno">  361</span>&#160;<span class="comment">      Optional callback to inform the plugin about a buffer size change.@n</span></div>

  433. <div class="line"><a name="l00362"></a><span class="lineno">  362</span>&#160;<span class="comment">      This function will only be called when the plugin is deactivated.</span></div>

  434. <div class="line"><a name="l00363"></a><span class="lineno">  363</span>&#160;<span class="comment">      @note This value is only a hint!@n</span></div>

  435. <div class="line"><a name="l00364"></a><span class="lineno">  364</span>&#160;<span class="comment">            Hosts might call run() with a higher or lower number of frames.</span></div>

  436. <div class="line"><a name="l00365"></a><span class="lineno">  365</span>&#160;<span class="comment">      @see getBufferSize()</span></div>

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

  438. <div class="line"><a name="l00367"></a><span class="lineno"><a class="line" href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297">  367</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297">bufferSizeChanged</a>(uint32_t newBufferSize);</div>

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

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

  441. <div class="line"><a name="l00370"></a><span class="lineno">  370</span>&#160;<span class="comment">      Optional callback to inform the plugin about a sample rate change.@n</span></div>

  442. <div class="line"><a name="l00371"></a><span class="lineno">  371</span>&#160;<span class="comment">      This function will only be called when the plugin is deactivated.</span></div>

  443. <div class="line"><a name="l00372"></a><span class="lineno">  372</span>&#160;<span class="comment">      @see getSampleRate()</span></div>

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

  445. <div class="line"><a name="l00374"></a><span class="lineno"><a class="line" href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc">  374</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc">sampleRateChanged</a>(<span class="keywordtype">double</span> newSampleRate);</div>

  446. <div class="line"><a name="l00375"></a><span class="lineno">  375</span>&#160;<span class="comment"></span> </div>

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

  448. <div class="line"><a name="l00377"></a><span class="lineno">  377</span>&#160;<span class="comment">      Optional callback to inform the plugin about audio port IO changes.@n</span></div>

  449. <div class="line"><a name="l00378"></a><span class="lineno">  378</span>&#160;<span class="comment">      This function will only be called when the plugin is deactivated.@n</span></div>

  450. <div class="line"><a name="l00379"></a><span class="lineno">  379</span>&#160;<span class="comment">      Only used in AU (AudioUnit) format when DISTRHO_PLUGIN_EXTRA_IO is defined.</span></div>

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

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

  453. <div class="line"><a name="l00382"></a><span class="lineno"><a class="line" href="classPlugin.html#ac3a55830c3474a3dc663365d43b581c1">  382</a></span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ac3a55830c3474a3dc663365d43b581c1">ioChanged</a>(uint16_t numInputs, uint16_t numOutputs);</div>

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

  455. <div class="line"><a name="l00384"></a><span class="lineno">  384</span>&#160;    <span class="comment">// -------------------------------------------------------------------------------------------------------</span></div>

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

  457. <div class="line"><a name="l00386"></a><span class="lineno">  386</span>&#160;<span class="keyword">private</span>:</div>

  458. <div class="line"><a name="l00387"></a><span class="lineno">  387</span>&#160;    <span class="keyword">struct </span>PrivateData;</div>

  459. <div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;    PrivateData* <span class="keyword">const</span> pData;</div>

  460. <div class="line"><a name="l00389"></a><span class="lineno">  389</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span>PluginExporter;</div>

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

  462. <div class="line"><a name="l00391"></a><span class="lineno">  391</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classPlugin.html">Plugin</a>)</div>

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

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

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

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

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

  468. <div class="line"><a name="l00397"></a><span class="lineno">  397</span>&#160;<span class="comment"> * Create plugin, entry point */</span></div>

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

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

  471. <div class="line"><a name="l00400"></a><span class="lineno">  400</span>&#160;<span class="comment">   @defgroup EntryPoints Entry Points</span></div>

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

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

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

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

  476. <div class="line"><a name="l00405"></a><span class="lineno">  405</span>&#160;<span class="comment">   Create an instance of the Plugin class.@n</span></div>

  477. <div class="line"><a name="l00406"></a><span class="lineno">  406</span>&#160;<span class="comment">   This is the entry point for DPF plugins.@n</span></div>

  478. <div class="line"><a name="l00407"></a><span class="lineno">  407</span>&#160;<span class="comment">   DPF will call this to either create an instance of your plugin for the host</span></div>

  479. <div class="line"><a name="l00408"></a><span class="lineno">  408</span>&#160;<span class="comment">   or to fetch some initial information for internal caching.</span></div>

  480. <div class="line"><a name="l00409"></a><span class="lineno">  409</span>&#160;<span class="comment"> */</span></div>

  481. <div class="line"><a name="l00410"></a><span class="lineno"><a class="line" href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee">  410</a></span>&#160;<span class="keyword">extern</span> <a class="code" href="classPlugin.html">Plugin</a>* <a class="code" href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee">createPlugin</a>();</div>

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

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

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

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

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

  487. <div class="line"><a name="l00416"></a><span class="lineno">  416</span>&#160;<a class="code" href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div>

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

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

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

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

  492. <div class="ttc" id="aclassPlugin_html_a0467eef817ac130cbbe1c0fbe09660c6"><div class="ttname"><a href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">Plugin::writeMidiEvent</a></div><div class="ttdeci">bool writeMidiEvent(const MidiEvent &amp;midiEvent) noexcept</div></div>

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

  494. <div class="ttc" id="aclassPlugin_html_a2643e638f62cfd4990247ec66bed60d2"><div class="ttname"><a href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">Plugin::getBufferSize</a></div><div class="ttdeci">uint32_t getBufferSize() const noexcept</div></div>

  495. <div class="ttc" id="aclassPlugin_html_a2a70c4ec55d74d9bc26862975d8df8a7"><div class="ttname"><a href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">Plugin::setLatency</a></div><div class="ttdeci">void setLatency(uint32_t frames) noexcept</div></div>

  496. <div class="ttc" id="aclassPlugin_html_a2fcbfa1893f44e661d0d8cd53391dadc"><div class="ttname"><a href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc">Plugin::sampleRateChanged</a></div><div class="ttdeci">virtual void sampleRateChanged(double newSampleRate)</div></div>

  497. <div class="ttc" id="aclassPlugin_html_a30db5eef9de617f4c81d5c6925facea3"><div class="ttname"><a href="classPlugin.html#a30db5eef9de617f4c81d5c6925facea3">Plugin::getDescription</a></div><div class="ttdeci">virtual const char * getDescription() const</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:198</div></div>

  498. <div class="ttc" id="aclassPlugin_html_a3e162cfe8f1c52bf09805fd327bcc3c4"><div class="ttname"><a href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">Plugin::getSampleRate</a></div><div class="ttdeci">double getSampleRate() const noexcept</div></div>

  499. <div class="ttc" id="aclassPlugin_html_a44eb1bfcc3a3e5949ad053fc9ce55ce8"><div class="ttname"><a href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8">Plugin::loadProgram</a></div><div class="ttdeci">virtual void loadProgram(uint32_t index)</div></div>

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

  501. <div class="ttc" id="aclassPlugin_html_a581614e1d301ee613a988855c61b2517"><div class="ttname"><a href="classPlugin.html#a581614e1d301ee613a988855c61b2517">Plugin::canRequestParameterValueChanges</a></div><div class="ttdeci">bool canRequestParameterValueChanges() const noexcept</div></div>

  502. <div class="ttc" id="aclassPlugin_html_a5fd60c82f5a50f12312c57729885fc2f"><div class="ttname"><a href="classPlugin.html#a5fd60c82f5a50f12312c57729885fc2f">Plugin::getBundlePath</a></div><div class="ttdeci">const char * getBundlePath() const noexcept</div></div>

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

  504. <div class="ttc" id="aclassPlugin_html_a71b876c8157b087b3552960f2877a44d"><div class="ttname"><a href="classPlugin.html#a71b876c8157b087b3552960f2877a44d">Plugin::initPortGroup</a></div><div class="ttdeci">virtual void initPortGroup(uint32_t groupId, PortGroup &amp;portGroup)</div></div>

  505. <div class="ttc" id="aclassPlugin_html_a75f30935198a0acba25f4ea92af72dc4"><div class="ttname"><a href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">Plugin::initAudioPort</a></div><div class="ttdeci">virtual void initAudioPort(bool input, uint32_t index, AudioPort &amp;port)</div></div>

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

  507. <div class="ttc" id="aclassPlugin_html_a89814b8f0b1c91e49140d42eb8331383"><div class="ttname"><a href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">Plugin::~Plugin</a></div><div class="ttdeci">virtual ~Plugin()</div></div>

  508. <div class="ttc" id="aclassPlugin_html_a8d07561f935bf9918e8b395e6eaabfa0"><div class="ttname"><a href="classPlugin.html#a8d07561f935bf9918e8b395e6eaabfa0">Plugin::isSelfTestInstance</a></div><div class="ttdeci">bool isSelfTestInstance() const noexcept</div></div>

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

  510. <div class="ttc" id="aclassPlugin_html_a9cf24d4880f200eaeacd08a591d00d1f"><div class="ttname"><a href="classPlugin.html#a9cf24d4880f200eaeacd08a591d00d1f">Plugin::getState</a></div><div class="ttdeci">virtual String getState(const char *key) const</div></div>

  511. <div class="ttc" id="aclassPlugin_html_a9f6c8ad6b054056649d0250e527e1297"><div class="ttname"><a href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297">Plugin::bufferSizeChanged</a></div><div class="ttdeci">virtual void bufferSizeChanged(uint32_t newBufferSize)</div></div>

  512. <div class="ttc" id="aclassPlugin_html_aa089a56572bc8f1cb7e4b538c0d19c46"><div class="ttname"><a href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46">Plugin::deactivate</a></div><div class="ttdeci">virtual void deactivate()</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:340</div></div>

  513. <div class="ttc" id="aclassPlugin_html_aa5c1262f5ca20536bb5850fdd6faa22c"><div class="ttname"><a href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">Plugin::activate</a></div><div class="ttdeci">virtual void activate()</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:335</div></div>

  514. <div class="ttc" id="aclassPlugin_html_aa85c50c732d9083f57b72d6b4cd7c5ae"><div class="ttname"><a href="classPlugin.html#aa85c50c732d9083f57b72d6b4cd7c5ae">Plugin::updateStateValue</a></div><div class="ttdeci">bool updateStateValue(const char *key, const char *value) noexcept</div></div>

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

  516. <div class="ttc" id="aclassPlugin_html_ab2c6b7bc2e0cdcd589cf9d03be831042"><div class="ttname"><a href="classPlugin.html#ab2c6b7bc2e0cdcd589cf9d03be831042">Plugin::isDummyInstance</a></div><div class="ttdeci">bool isDummyInstance() const noexcept</div></div>

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

  518. <div class="ttc" id="aclassPlugin_html_ac3a55830c3474a3dc663365d43b581c1"><div class="ttname"><a href="classPlugin.html#ac3a55830c3474a3dc663365d43b581c1">Plugin::ioChanged</a></div><div class="ttdeci">virtual void ioChanged(uint16_t numInputs, uint16_t numOutputs)</div></div>

  519. <div class="ttc" id="aclassPlugin_html_acb5a3632da5a5c4110172a3a78e1fd32"><div class="ttname"><a href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin::Plugin</a></div><div class="ttdeci">Plugin(uint32_t parameterCount, uint32_t programCount, uint32_t stateCount)</div></div>

  520. <div class="ttc" id="aclassPlugin_html_ad12c681ce31004da0badd609763f45c5"><div class="ttname"><a href="classPlugin.html#ad12c681ce31004da0badd609763f45c5">Plugin::getHomePage</a></div><div class="ttdeci">virtual const char * getHomePage() const</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:209</div></div>

  521. <div class="ttc" id="aclassPlugin_html_ad4ab623187f905c250a42284704eb840"><div class="ttname"><a href="classPlugin.html#ad4ab623187f905c250a42284704eb840">Plugin::initState</a></div><div class="ttdeci">virtual void initState(uint32_t index, State &amp;state)</div></div>

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

  523. <div class="ttc" id="aclassPlugin_html_ae65d8603022c09d1ce2ee5cf568de70f"><div class="ttname"><a href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">Plugin::requestParameterValueChange</a></div><div class="ttdeci">bool requestParameterValueChange(uint32_t index, float value) noexcept</div></div>

  524. <div class="ttc" id="aclassPlugin_html_ae85d602c430b1a4361a88d714d3a42c1"><div class="ttname"><a href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">Plugin::getTimePosition</a></div><div class="ttdeci">const TimePosition &amp; getTimePosition() const noexcept</div></div>

  525. <div class="ttc" id="aclassPlugin_html_aebb5df5cde162462dc460d4fd45dae75"><div class="ttname"><a href="classPlugin.html#aebb5df5cde162462dc460d4fd45dae75">Plugin::getName</a></div><div class="ttdeci">virtual const char * getName() const</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:186</div></div>

  526. <div class="ttc" id="aclassPlugin_html_af9e9f5438e2e0c2352052eb5f95832aa"><div class="ttname"><a href="classPlugin.html#af9e9f5438e2e0c2352052eb5f95832aa">Plugin::getParameterValue</a></div><div class="ttdeci">virtual float getParameterValue(uint32_t index) const</div></div>

  527. <div class="ttc" id="aclassPlugin_html_afcbb504b824bacea622de9bac09b2331"><div class="ttname"><a href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">Plugin::setState</a></div><div class="ttdeci">virtual void setState(const char *key, const char *value)</div></div>

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

  529. <div class="ttc" id="agroup__EntryPoints_html_ga87f1fa9084f2490ca04ea733292c6dee"><div class="ttname"><a href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee">createPlugin</a></div><div class="ttdeci">Plugin * createPlugin()</div></div>

  530. <div class="ttc" id="agroup__MiscellaneousFunctions_html_ga6827e90feb9bdcb6f76175a245fbf12c"><div class="ttname"><a href="group__MiscellaneousFunctions.html#ga6827e90feb9bdcb6f76175a245fbf12c">d_cconst</a></div><div class="ttdeci">static constexpr int64_t d_cconst(const uint8_t a, const uint8_t b, const uint8_t c, const uint8_t d) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoUtils.hpp:72</div></div>

  531. <div class="ttc" id="agroup__NamespaceMacros_html_ga3ff541a449593e069a29e92d21e38ef3"><div class="ttname"><a href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define END_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:949</div></div>

  532. <div class="ttc" id="agroup__NamespaceMacros_html_gac4cb97c393d20c28ba19365d844341cd"><div class="ttname"><a href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define START_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:943</div></div>

  533. <div class="ttc" id="agroup__PluginMacros_html_ga096d7684289e65485311a427ad8772f3"><div class="ttname"><a href="group__PluginMacros.html#ga096d7684289e65485311a427ad8772f3">DISTRHO_PLUGIN_UNIQUE_ID</a></div><div class="ttdeci">#define DISTRHO_PLUGIN_UNIQUE_ID</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:691</div></div>

  534. <div class="ttc" id="agroup__PluginMacros_html_ga888482a9f695c2ca2f433e5f3172dcc4"><div class="ttname"><a href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a></div><div class="ttdeci">#define DISTRHO_PLUGIN_NAME</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:488</div></div>

  535. <div class="ttc" id="astructAudioPort_html"><div class="ttname"><a href="structAudioPort.html">AudioPort</a></div><div class="ttdef"><b>Definition:</b> DistrhoDetails.hpp:275</div></div>

  536. <div class="ttc" id="astructMidiEvent_html"><div class="ttname"><a href="structMidiEvent.html">MidiEvent</a></div><div class="ttdef"><b>Definition:</b> DistrhoDetails.hpp:891</div></div>

  537. <div class="ttc" id="astructParameter_html"><div class="ttname"><a href="structParameter.html">Parameter</a></div><div class="ttdef"><b>Definition:</b> DistrhoDetails.hpp:588</div></div>

  538. <div class="ttc" id="astructPortGroup_html"><div class="ttname"><a href="structPortGroup.html">PortGroup</a></div><div class="ttdef"><b>Definition:</b> DistrhoDetails.hpp:797</div></div>

  539. <div class="ttc" id="astructState_html"><div class="ttname"><a href="structState.html">State</a></div><div class="ttdef"><b>Definition:</b> DistrhoDetails.hpp:823</div></div>

  540. <div class="ttc" id="astructTimePosition_html"><div class="ttname"><a href="structTimePosition.html">TimePosition</a></div><div class="ttdef"><b>Definition:</b> DistrhoDetails.hpp:925</div></div>

  541. </div><!-- fragment --></div><!-- contents -->

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

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

  544. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  545. </small></address>

  546. </body>

  547. </html>