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/DistrhoPluginUtils_8hpp_sou...

306 lines
38KB
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/DistrhoPluginUtils.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">DistrhoPluginUtils.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-2021 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_UTILS_HPP_INCLUDED</span></div>

  89. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define DISTRHO_PLUGIN_UTILS_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;DistrhoPlugin.hpp&quot;</span></div>

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

  93. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<a class="code" href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></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;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  96. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * Plugin related utilities */</span></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">/**</span></div>

  99. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">   @defgroup PluginRelatedUtilities Plugin related utilities</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">   @{</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">   Get the absolute filename of the plugin DSP/UI binary.@n</span></div>

  106. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">   Under certain systems or plugin formats the binary will be inside the plugin bundle.@n</span></div>

  107. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">   Also, in some formats or setups, the DSP and UI binaries are in different files.</span></div>

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

  109. <div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="group__PluginRelatedUtilities.html#ga59aac78ab7142a37a7a2c5f0c7fd2a62">   38</a></span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__PluginRelatedUtilities.html#ga59aac78ab7142a37a7a2c5f0c7fd2a62">getBinaryFilename</a>();</div>

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

  111. <div class="line"><a name="l00040"></a><span class="lineno">   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">   Get a string representation of the current plugin format we are building against.@n</span></div>

  113. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">   This can be &quot;JACK/Standalone&quot;, &quot;LADSPA&quot;, &quot;DSSI&quot;, &quot;LV2&quot;, &quot;VST2&quot; or &quot;VST3&quot;.@n</span></div>

  114. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">   This string is purely informational and must not be used to tweak plugin behaviour.</span></div>

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

  116. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">   @note DO NOT CHANGE PLUGIN BEHAVIOUR BASED ON PLUGIN FORMAT.</span></div>

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

  118. <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__PluginRelatedUtilities.html#gac339d6837f2d1a89d4d63b322822e32d">   47</a></span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__PluginRelatedUtilities.html#gac339d6837f2d1a89d4d63b322822e32d">getPluginFormatName</a>() noexcept;</div>

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

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

  121. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">   Get the path to where resources are stored within the plugin bundle.@n</span></div>

  122. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">   Requires a valid plugin bundle path.</span></div>

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

  124. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">   Returns a path inside the bundle where the plugin is meant to store its resources in.@n</span></div>

  125. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">   This path varies between systems and plugin formats, like so:</span></div>

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

  127. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">    - LV2: &lt;bundle&gt;/resources (can be stored anywhere inside the bundle really, DPF just uses this one)</span></div>

  128. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">    - VST2 macOS: &lt;bundle&gt;/Contents/Resources</span></div>

  129. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">    - VST2 non-macOS: &lt;bundle&gt;/resources (see note)</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">   60</span>&#160;<span class="comment">   The other non-mentioned formats do not support bundles.@n</span></div>

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

  133. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">   @note For VST2 on non-macOS systems, this assumes you have your plugin inside a dedicated directory</span></div>

  134. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">         rather than only shipping with the binary (e.g. &lt;myplugin.vst&gt;/myplugin.dll)</span></div>

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

  136. <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="group__PluginRelatedUtilities.html#ga53aa68de85dae4e3102b1c0551950b86">   65</a></span>&#160;const <span class="keywordtype">char</span>* <a class="code" href="group__PluginRelatedUtilities.html#ga53aa68de85dae4e3102b1c0551950b86">getResourcePath</a>(const <span class="keywordtype">char</span>* bundlePath) noexcept;</div>

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

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

  139. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </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"> * Plugin helper classes */</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">   72</span>&#160;<span class="comment">/**</span></div>

  144. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">   @defgroup PluginHelperClasses Plugin helper classes</span></div>

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

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

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

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

  149. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_NUM_OUTPUTS &gt; 0</span><span class="comment"></span></div>

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

  151. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">   Handy class to help keep audio buffer in sync with incoming MIDI events.</span></div>

  152. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">   To use it, create a local variable (on the stack) and call nextEvent() until it returns false.</span></div>

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

  154. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">    for (AudioMidiSyncHelper amsh(outputs, frames, midiEvents, midiEventCount); amsh.nextEvent();)</span></div>

  155. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">    {</span></div>

  156. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">        float* const outL = amsh.outputs[0];</span></div>

  157. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment">        float* const outR = amsh.outputs[1];</span></div>

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

  159. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">        for (uint32_t i=0; i&lt;amsh.midiEventCount; ++i)</span></div>

  160. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">        {</span></div>

  161. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">            const MidiEvent&amp; ev(amsh.midiEvents[i]);</span></div>

  162. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment">            // ... do something with the midi event</span></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">        renderSynth(outL, outR, amsh.frames);</span></div>

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

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

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

  169. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment">   Some important notes when using this class:</span></div>

  170. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment">    1. MidiEvent::frame retains its original value, but it is useless, do not use it.</span></div>

  171. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">    2. The class variable names are the same as the default ones in the run function.</span></div>

  172. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment">       Keep that in mind and try to avoid typos. :)</span></div>

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

  174. <div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="structAudioMidiSyncHelper.html">  103</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structAudioMidiSyncHelper.html">AudioMidiSyncHelper</a></div>

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

  176. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment">    /** Parameters from the run function, adjusted for event sync */</span></div>

  177. <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">  106</a></span>&#160;    <span class="keywordtype">float</span>* <a class="code" href="structAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">outputs</a>[<a class="code" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">DISTRHO_PLUGIN_NUM_OUTPUTS</a>];</div>

  178. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    uint32_t frames;</div>

  179. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    <span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>* midiEvents;</div>

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

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

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

  183. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">       Constructor, using values from the run function.</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"><a class="line" href="structAudioMidiSyncHelper.html#ae75a1d7256c04445ec77176b6505fcb0">  114</a></span>&#160;    <a class="code" href="structAudioMidiSyncHelper.html#ae75a1d7256c04445ec77176b6505fcb0">AudioMidiSyncHelper</a>(<span class="keywordtype">float</span>** <span class="keyword">const</span> o, uint32_t f, <span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>* m, uint32_t mc)</div>

  186. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;        : <a class="code" href="structAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">outputs</a>(),</div>

  187. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;          frames(0),</div>

  188. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;          midiEvents(m),</div>

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

  190. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;          remainingFrames(f),</div>

  191. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;          remainingMidiEventCount(mc),</div>

  192. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;          totalFramesUsed(0)</div>

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

  194. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;        <span class="keywordflow">for</span> (uint i=0; i&lt;<a class="code" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">DISTRHO_PLUGIN_NUM_OUTPUTS</a>; ++i)</div>

  195. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;            <a class="code" href="structAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">outputs</a>[i] = o[i];</div>

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

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

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

  199. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment">       Process a batch of events untill no more are available.</span></div>

  200. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">       You must not read any more values from this class after this function returns false.</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"><a class="line" href="structAudioMidiSyncHelper.html#a43f354c1520893449d81a27b3e7a81fe">  131</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="structAudioMidiSyncHelper.html#a43f354c1520893449d81a27b3e7a81fe">nextEvent</a>()</div>

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

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

  205. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;        <span class="keywordflow">if</span> (remainingFrames == 0)</div>

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

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

  208. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;        <span class="comment">// initial setup, need to find first MIDI event</span></div>

  209. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;        <span class="keywordflow">if</span> (totalFramesUsed == 0)</div>

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

  211. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;            <span class="comment">// no MIDI events at all in this process cycle</span></div>

  212. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;            <span class="keywordflow">if</span> (remainingMidiEventCount == 0)</div>

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

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

  215. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;                remainingFrames = 0;</div>

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

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

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

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

  220. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;            <span class="comment">// render audio until first midi event, if needed</span></div>

  221. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;            <span class="keywordflow">if</span> (<span class="keyword">const</span> uint32_t firstEventFrame = midiEvents[0].frame)</div>

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

  223. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;                DISTRHO_SAFE_ASSERT_UINT2_RETURN(firstEventFrame &lt; remainingFrames,</div>

  224. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;                                                 firstEventFrame, remainingFrames, <span class="keyword">false</span>);</div>

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

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

  227. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;                totalFramesUsed += firstEventFrame;</div>

  228. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;                <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>

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

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

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

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

  233. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;            <span class="keywordflow">for</span> (uint32_t i=0; i&lt;<a class="code" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">DISTRHO_PLUGIN_NUM_OUTPUTS</a>; ++i)</div>

  234. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;                <a class="code" href="structAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">outputs</a>[i] += frames;</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; </div>

  237. <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;        <span class="comment">// no more MIDI events available</span></div>

  238. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;        <span class="keywordflow">if</span> (remainingMidiEventCount == 0)</div>

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

  240. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;            frames = remainingFrames;</div>

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

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

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

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

  245. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>

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

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

  248. <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;        <span class="comment">// if there were midi events before, increment pointer</span></div>

  249. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;        <span class="keywordflow">if</span> (midiEventCount != 0)</div>

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

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

  252. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;        <span class="keyword">const</span> uint32_t firstEventFrame = midiEvents[0].<a class="code" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">frame</a>;</div>

  253. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;        DISTRHO_SAFE_ASSERT_UINT2_RETURN(firstEventFrame &gt;= totalFramesUsed,</div>

  254. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;                                         firstEventFrame, totalFramesUsed, <span class="keyword">false</span>);</div>

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

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

  257. <div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;        <span class="keywordflow">while</span> (midiEventCount &lt; remainingMidiEventCount)</div>

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

  259. <div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;            <span class="keywordflow">if</span> (midiEvents[midiEventCount].frame == firstEventFrame)</div>

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

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

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

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

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

  265. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;        frames = firstEventFrame - totalFramesUsed;</div>

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

  267. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;        remainingMidiEventCount -= midiEventCount;</div>

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

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

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

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

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

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

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

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

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

  277. <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;};</div>

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

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

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

  281. <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160; </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; </div>

  284. <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<a class="code" href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div>

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

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

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

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

  289. <div class="ttc" id="agroup__PluginMacros_html_ga917195804ebcb2bb48c9fad52b20b3ca"><div class="ttname"><a href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">DISTRHO_PLUGIN_NUM_OUTPUTS</a></div><div class="ttdeci">#define DISTRHO_PLUGIN_NUM_OUTPUTS</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:500</div></div>

  290. <div class="ttc" id="agroup__PluginRelatedUtilities_html_ga53aa68de85dae4e3102b1c0551950b86"><div class="ttname"><a href="group__PluginRelatedUtilities.html#ga53aa68de85dae4e3102b1c0551950b86">getResourcePath</a></div><div class="ttdeci">const char * getResourcePath(const char *bundlePath) noexcept</div></div>

  291. <div class="ttc" id="agroup__PluginRelatedUtilities_html_ga59aac78ab7142a37a7a2c5f0c7fd2a62"><div class="ttname"><a href="group__PluginRelatedUtilities.html#ga59aac78ab7142a37a7a2c5f0c7fd2a62">getBinaryFilename</a></div><div class="ttdeci">const char * getBinaryFilename()</div></div>

  292. <div class="ttc" id="agroup__PluginRelatedUtilities_html_gac339d6837f2d1a89d4d63b322822e32d"><div class="ttname"><a href="group__PluginRelatedUtilities.html#gac339d6837f2d1a89d4d63b322822e32d">getPluginFormatName</a></div><div class="ttdeci">const char * getPluginFormatName() noexcept</div></div>

  293. <div class="ttc" id="astructAudioMidiSyncHelper_html"><div class="ttname"><a href="structAudioMidiSyncHelper.html">AudioMidiSyncHelper</a></div><div class="ttdef"><b>Definition:</b> DistrhoPluginUtils.hpp:104</div></div>

  294. <div class="ttc" id="astructAudioMidiSyncHelper_html_a43f354c1520893449d81a27b3e7a81fe"><div class="ttname"><a href="structAudioMidiSyncHelper.html#a43f354c1520893449d81a27b3e7a81fe">AudioMidiSyncHelper::nextEvent</a></div><div class="ttdeci">bool nextEvent()</div><div class="ttdef"><b>Definition:</b> DistrhoPluginUtils.hpp:131</div></div>

  295. <div class="ttc" id="astructAudioMidiSyncHelper_html_a7b54cae0fdaae3d23aaccf2dbb9344ef"><div class="ttname"><a href="structAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">AudioMidiSyncHelper::outputs</a></div><div class="ttdeci">float * outputs[2]</div><div class="ttdef"><b>Definition:</b> DistrhoPluginUtils.hpp:106</div></div>

  296. <div class="ttc" id="astructAudioMidiSyncHelper_html_ae75a1d7256c04445ec77176b6505fcb0"><div class="ttname"><a href="structAudioMidiSyncHelper.html#ae75a1d7256c04445ec77176b6505fcb0">AudioMidiSyncHelper::AudioMidiSyncHelper</a></div><div class="ttdeci">AudioMidiSyncHelper(float **const o, uint32_t f, const MidiEvent *m, uint32_t mc)</div><div class="ttdef"><b>Definition:</b> DistrhoPluginUtils.hpp:114</div></div>

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

  298. <div class="ttc" id="astructMidiEvent_html_aca2f6590b33bd2175ab71f985747d88e"><div class="ttname"><a href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">MidiEvent::frame</a></div><div class="ttdeci">uint32_t frame</div><div class="ttdef"><b>Definition:</b> DistrhoDetails.hpp:900</div></div>

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

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

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

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

  303. </small></address>

  304. </body>

  305. </html>