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.
376 Commits
7 Branches
295MB
Tree: 2c0f450169
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '2c0f450169'
${ noResults }
DPF/DistrhoInfo_8hpp_source.html

351 lines
41KB
Raw Blame History 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

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

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

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

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

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

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

  36. </script>

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

  38.     <ul class="tablist">

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

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

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

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

  43.       <li>

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

  45.         <span class="left">

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

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

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

  49.                alt=""/>

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

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

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

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

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

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

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

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

  62.     <ul class="tablist">

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

  64.     </ul>

  65.   </div>

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

  67. <div id="MSearchSelectWindow"

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

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

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

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

  72. 

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

  74. <div id="MSearchResultsWindow">

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

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

  77. </iframe>

  78. </div>

  79. 

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

  81.   <ul>

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

  83. </div>

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

  85. <div class="header">

  86.   <div class="headertitle">

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

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

  89. <div class="contents">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  108. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;src/DistrhoDefines.h&quot;</span></div>

  109. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>

  110. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;START_NAMESPACE_DISTRHO</div>

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

  112. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

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

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

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

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

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

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

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

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

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

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

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

  124. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">   This file is included in the main DPF code to figure out which features for each plugin format to export.</span></div>

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

  126. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">   For example, a plugin (with %UI) that use states will require LV2 hosts to support Atom and Worker extensions for</span></div>

  127. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">   message passing from the %UI to the plugin.@n</span></div>

  128. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">   If your plugin does not make use of states, the Worker extension is not set as a required feature.</span></div>

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

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

  131. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">   The next step is to create your plugin code by subclassing DPF&#39;s @ref Plugin class.@n</span></div>

  132. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">   You need to pass the number of parameters in the constructor and also the number of programs and states, if any.</span></div>

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

  134. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">   Here&#39;s an example of an audio plugin that simply mutes the host output:</span></div>

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

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

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

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

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

  140. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">          : Plugin(0, 0, 0) // 0 parameters, 0 programs and 0 states</span></div>

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

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

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

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

  145. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">      const char* getLabel() const override</span></div>

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

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

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

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

  150. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">      const char* getMaker() const override</span></div>

  151. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">      {</span></div>

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

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

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

  155. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">      const char* getLicense() const override</span></div>

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

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

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

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

  160. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">      uint32_t getVersion() const override</span></div>

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

  162. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">          return 0x1000;</span></div>

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

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

  165. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">      int64_t getUniqueId() const override</span></div>

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

  167. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">          return cconst(&#39;M&#39;, &#39;u&#39;, &#39;t&#39;, &#39;e&#39;);</span></div>

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

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

  170. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">      void run(const float**, float** outputs, uint32_t frames) override</span></div>

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

  172. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">          // get the left and right audio outputs</span></div>

  173. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">          float* const outL = outputs[0];</span></div>

  174. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">          float* const outR = outputs[1];</span></div>

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

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

  177. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">          std::memset(outL, 0, sizeof(float)*frames);</span></div>

  178. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">          std::memset(outR, 0, sizeof(float)*frames);</span></div>

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

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

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

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

  183. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">   See the @ref Plugin class for more information and to understand what each function does.</span></div>

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

  185. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment">   @section Parameters</span></div>

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

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

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

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

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

  191. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">   @section States</span></div>

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

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

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

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

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

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

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

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

  200. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">   @section Time-Position</span></div>

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

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

  203. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">   @section UI</span></div>

  204. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">   describe them</span></div>

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

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

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

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

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

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

  211. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment">   @defgroup PluginMacros Plugin Macros</span></div>

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

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

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

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

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

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

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

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

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

  221. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">   The values defined in this group are for documentation purposes only.@n</span></div>

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

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

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

  225. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">    - @ref DISTRHO_PLUGIN_NAME</span></div>

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

  227. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment">    - @ref DISTRHO_PLUGIN_NUM_OUTPUTS</span></div>

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

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

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

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

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

  233. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment">   The plugin name.@n</span></div>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  256. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"></span></div>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  279. <div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment">   @see UI::getPluginInstancePointer()</span></div>

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

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

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

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

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

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

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

  287. <div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment">   @see Plugin::setLatency(uint32_t)</span></div>

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

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

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

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

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

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

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

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

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

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

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

  299. <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="comment">   @see Plugin::writeMidiEvent(const MidiEvent&amp;)</span></div>

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

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

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

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

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

  305. <div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment">   @see Plugin::initProgramName(uint32_t, String&amp;)</span></div>

  306. <div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment">   @see Plugin::setProgram(uint32_t)</span></div>

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

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

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

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

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

  312. <div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment">   @see Plugin::initState(uint32_t, String&amp;, String&amp;)</span></div>

  313. <div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment">   @see Plugin::setState(const char*, const char*)</span></div>

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

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

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

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

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

  319. <div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;<span class="comment">   @see Plugin::getTimePosition()</span></div>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  339. <div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;END_NAMESPACE_DISTRHO</div>

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

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

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

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

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

  345. Generated on Sun Apr 26 2015 14:49:34 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  347. </a> 1.8.8

  348. </small></address>

  349. </body>

  350. </html>