DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: AudioMidiSyncHelper Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classAudioMidiSyncHelper-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">AudioMidiSyncHelper Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="DistrhoPluginUtils_8hpp_source.html">DistrhoPluginUtils.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae75a1d7256c04445ec77176b6505fcb0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMidiSyncHelper.html#ae75a1d7256c04445ec77176b6505fcb0">AudioMidiSyncHelper</a> (float **const o, uint32_t f, const <a class="el" href="structMidiEvent.html">MidiEvent</a> *m, uint32_t mc)</td></tr>
<tr class="separator:ae75a1d7256c04445ec77176b6505fcb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43f354c1520893449d81a27b3e7a81fe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMidiSyncHelper.html#a43f354c1520893449d81a27b3e7a81fe">nextEvent</a> ()</td></tr>
<tr class="separator:a43f354c1520893449d81a27b3e7a81fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7b54cae0fdaae3d23aaccf2dbb9344ef"><td class="memItemLeft" align="right" valign="top">float *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">outputs</a> [2]</td></tr>
<tr class="separator:a7b54cae0fdaae3d23aaccf2dbb9344ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ee6ef7e6f4d93e2e8860a0ed6ca8f09"><td class="memItemLeft" align="right" valign="top"><a id="a6ee6ef7e6f4d93e2e8860a0ed6ca8f09"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>frames</b></td></tr>
<tr class="separator:a6ee6ef7e6f4d93e2e8860a0ed6ca8f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0a4a51fd808712d5a2b3b1b9ae893b7"><td class="memItemLeft" align="right" valign="top"><a id="ad0a4a51fd808712d5a2b3b1b9ae893b7"></a>
const <a class="el" href="structMidiEvent.html">MidiEvent</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>midiEvents</b></td></tr>
<tr class="separator:ad0a4a51fd808712d5a2b3b1b9ae893b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8483428a37a7e8aa4573289bddaed6d8"><td class="memItemLeft" align="right" valign="top"><a id="a8483428a37a7e8aa4573289bddaed6d8"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>midiEventCount</b></td></tr>
<tr class="separator:a8483428a37a7e8aa4573289bddaed6d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Handy class to help keep audio buffer in sync with incoming MIDI events. To use it, create a local variable (on the stack) and call <a class="el" href="classAudioMidiSyncHelper.html#a43f354c1520893449d81a27b3e7a81fe">nextEvent()</a> until it returns false. </p><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<a class="code" href="classAudioMidiSyncHelper.html">AudioMidiSyncHelper</a> amsh(<a class="code" href="classAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">outputs</a>, frames, midiEvents, midiEventCount); amsh.<a class="code" href="classAudioMidiSyncHelper.html#a43f354c1520893449d81a27b3e7a81fe">nextEvent</a>();)</div>
<div class="line">{</div>
<div class="line">    <span class="keywordtype">float</span>* <span class="keyword">const</span> outL = amsh.outputs[0];</div>
<div class="line">    <span class="keywordtype">float</span>* <span class="keyword">const</span> outR = amsh.outputs[1];</div>
<div class="line"> </div>
<div class="line">    <span class="keywordflow">for</span> (uint32_t i=0; i&lt;amsh.midiEventCount; ++i)</div>
<div class="line">    {</div>
<div class="line">        <span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>&amp; ev(amsh.midiEvents[i]);</div>
<div class="line">        <span class="comment">// ... do something with the midi event</span></div>
<div class="line">    }</div>
<div class="line"> </div>
<div class="line">    renderSynth(outL, outR, amsh.frames);</div>
<div class="line">}</div>
</div><!-- fragment --><p>Some important notes when using this class:</p><ol type="1">
<li><a class="el" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">MidiEvent::frame</a> retains its original value, but it is useless, do not use it.</li>
<li>The class variables names are be the same as the default ones in the run function. Keep that in mind and try to avoid typos. :) </li>
</ol>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae75a1d7256c04445ec77176b6505fcb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae75a1d7256c04445ec77176b6505fcb0">&#9670;&nbsp;</a></span>AudioMidiSyncHelper()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">AudioMidiSyncHelper::AudioMidiSyncHelper </td>
          <td>(</td>
          <td class="paramtype">float **const&#160;</td>
          <td class="paramname"><em>o</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structMidiEvent.html">MidiEvent</a> *&#160;</td>
          <td class="paramname"><em>m</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>mc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor, using values from the run function. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a43f354c1520893449d81a27b3e7a81fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43f354c1520893449d81a27b3e7a81fe">&#9670;&nbsp;</a></span>nextEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool AudioMidiSyncHelper::nextEvent </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Process a batch of events untill no more are available. You must not read any more values from this class after this function returns false. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7b54cae0fdaae3d23aaccf2dbb9344ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b54cae0fdaae3d23aaccf2dbb9344ef">&#9670;&nbsp;</a></span>outputs</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float* AudioMidiSyncHelper::outputs[2]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Parameters from the run function, adjusted for event sync </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>distrho/<a class="el" href="DistrhoPluginUtils_8hpp_source.html">DistrhoPluginUtils.hpp</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="astructMidiEvent_html"><div class="ttname"><a href="structMidiEvent.html">MidiEvent</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:616</div></div>
<div class="ttc" id="aclassAudioMidiSyncHelper_html_a7b54cae0fdaae3d23aaccf2dbb9344ef"><div class="ttname"><a href="classAudioMidiSyncHelper.html#a7b54cae0fdaae3d23aaccf2dbb9344ef">AudioMidiSyncHelper::outputs</a></div><div class="ttdeci">float * outputs[2]</div><div class="ttdef"><b>Definition:</b> DistrhoPluginUtils.hpp:53</div></div>
<div class="ttc" id="aclassAudioMidiSyncHelper_html_a43f354c1520893449d81a27b3e7a81fe"><div class="ttname"><a href="classAudioMidiSyncHelper.html#a43f354c1520893449d81a27b3e7a81fe">AudioMidiSyncHelper::nextEvent</a></div><div class="ttdeci">bool nextEvent()</div><div class="ttdef"><b>Definition:</b> DistrhoPluginUtils.hpp:78</div></div>
<div class="ttc" id="aclassAudioMidiSyncHelper_html"><div class="ttname"><a href="classAudioMidiSyncHelper.html">AudioMidiSyncHelper</a></div><div class="ttdef"><b>Definition:</b> DistrhoPluginUtils.hpp:50</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 3 2021 11:46:15 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>