_i_plug_w_a_m_8h_source.html

<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iPlug 2: IPlugWAM.h Source File</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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.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: 80px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">iPlug2 - C++ Audio Plug-in Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a8a4892678035c62db3a4af7d9811050.html">IPlug</a></li><li class="navelem"><a class="el" href="dir_f26b9fb677143c9f45268e1ab7f978e8.html">WEB</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">IPlugWAM.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> ==============================================================================</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> </span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers. </span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> </span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> See LICENSE.txt for  more info.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> </span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> ==============================================================================</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment">*/</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#ifndef _IPLUGAPI_</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#define _IPLUGAPI_</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#include &quot;<a class="code" href="_i_plug_a_p_i_base_8h.html">IPlugAPIBase.h</a>&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#include &quot;<a class="code" href="_i_plug_processor_8h.html">IPlugProcessor.h</a>&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#include &quot;processor.h&quot;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="keyword">using namespace </span>WAM;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>BEGIN_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="keyword">struct </span>InstanceInfo</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>{};</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_i_plug_w_a_m.html">   28</a></span><span class="keyword">class </span><a class="code hl_class" href="class_i_plug_w_a_m.html">IPlugWAM</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_i_plug_a_p_i_base.html">IPlugAPIBase</a></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>               , <span class="keyword">public</span> <a class="code hl_class" href="class_i_plug_processor.html">IPlugProcessor</a></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>               , <span class="keyword">public</span> Processor</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>  <a class="code hl_class" href="class_i_plug_w_a_m.html">IPlugWAM</a>(<span class="keyword">const</span> InstanceInfo&amp; info, <span class="keyword">const</span> Config&amp; config);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>  <span class="comment">//WAM</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* init(uint32_t bufsize, uint32_t sr, <span class="keywordtype">void</span>* pDesc) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>  <span class="keywordtype">void</span> terminate()<span class="keyword"> override </span>{ DBGMSG(<span class="stringliteral">&quot;terminate&quot;</span>); }</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>  <span class="keywordtype">void</span> resize(uint32_t bufsize)<span class="keyword"> override </span>{ DBGMSG(<span class="stringliteral">&quot;resize&quot;</span>); }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>  <span class="keywordtype">void</span> onProcess(WAM::AudioBus* pAudio, <span class="keywordtype">void</span>* pData) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>  <span class="keywordtype">void</span> onMidi(<span class="keywordtype">byte</span> status, <span class="keywordtype">byte</span> data1, <span class="keywordtype">byte</span> data2) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>  <span class="keywordtype">void</span> onSysex(<span class="keywordtype">byte</span>* pData, uint32_t size) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  <span class="keywordtype">void</span> onMessage(<span class="keywordtype">char</span>* verb, <span class="keywordtype">char</span>* res, <span class="keywordtype">double</span> data) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>  <span class="keywordtype">void</span> onMessage(<span class="keywordtype">char</span>* verb, <span class="keywordtype">char</span>* res, <span class="keywordtype">char</span>* data) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>  <span class="keywordtype">void</span> onMessage(<span class="keywordtype">char</span>* verb, <span class="keywordtype">char</span>* res, <span class="keywordtype">void</span>* data, uint32_t size) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>  <span class="keywordtype">void</span> onParam(uint32_t idparam, <span class="keywordtype">double</span> value) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>  <span class="comment">//IPlugProcessor</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="class_i_plug_w_a_m.html#aca74eaaee0212128d0dd69ebcc595487">   49</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="class_i_plug_w_a_m.html#aca74eaaee0212128d0dd69ebcc595487">SetLatency</a>(<span class="keywordtype">int</span> samples)<span class="keyword"> override </span>{};</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="class_i_plug_w_a_m.html#a0ae41aa509f8f7bcc4dcb44a21816253">   50</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="class_i_plug_w_a_m.html#a0ae41aa509f8f7bcc4dcb44a21816253">SendMidiMsg</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_i_midi_msg.html">IMidiMsg</a>&amp; msg)<span class="keyword"> override </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="class_i_plug_w_a_m.html#aa47fe866748000dc8899f5d263e25352">   51</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="class_i_plug_w_a_m.html#aa47fe866748000dc8899f5d263e25352">SendSysEx</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_i_sys_ex.html">ISysEx</a>&amp; msg)<span class="keyword"> override </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>  </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>  <span class="comment">//IEditorDelegate - these are overwritten because we need to use WAM messaging system</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>  <span class="keywordtype">void</span> SendControlValueFromDelegate(<span class="keywordtype">int</span> ctrlTag, <span class="keywordtype">double</span> normalizedValue) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>  <span class="keywordtype">void</span> SendControlMsgFromDelegate(<span class="keywordtype">int</span> ctrlTag, <span class="keywordtype">int</span> msgTag, <span class="keywordtype">int</span> dataSize, <span class="keyword">const</span> <span class="keywordtype">void</span>* pData) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>  <span class="keywordtype">void</span> SendParameterValueFromDelegate(<span class="keywordtype">int</span> paramIdx, <span class="keywordtype">double</span> value, <span class="keywordtype">bool</span> normalized) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>  <span class="keywordtype">void</span> SendArbitraryMsgFromDelegate(<span class="keywordtype">int</span> msgTag, <span class="keywordtype">int</span> dataSize = 0, <span class="keyword">const</span> <span class="keywordtype">void</span>* pData = <span class="keyword">nullptr</span>) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>  </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>  <span class="keywordtype">void</span> OnEditorIdleTick();</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>};</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><a class="code hl_class" href="class_i_plug_w_a_m.html">IPlugWAM</a>* MakePlug(<span class="keyword">const</span> InstanceInfo&amp; info);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>END_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="a_i_plug_a_p_i_base_8h_html"><div class="ttname"><a href="_i_plug_a_p_i_base_8h.html">IPlugAPIBase.h</a></div></div>
<div class="ttc" id="a_i_plug_processor_8h_html"><div class="ttname"><a href="_i_plug_processor_8h.html">IPlugProcessor.h</a></div></div>
<div class="ttc" id="aclass_i_plug_a_p_i_base_html"><div class="ttname"><a href="class_i_plug_a_p_i_base.html">IPlugAPIBase</a></div><div class="ttdoc">The base class of an IPlug plug-in, which interacts with the different plug-in APIs.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_a_p_i_base_8h_source.html#l00042">IPlugAPIBase.h:43</a></div></div>
<div class="ttc" id="aclass_i_plug_processor_html"><div class="ttname"><a href="class_i_plug_processor.html">IPlugProcessor</a></div><div class="ttdoc">The base class for IPlug Audio Processing.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_processor_8h_source.html#l00041">IPlugProcessor.h:42</a></div></div>
<div class="ttc" id="aclass_i_plug_w_a_m_html"><div class="ttname"><a href="class_i_plug_w_a_m.html">IPlugWAM</a></div><div class="ttdoc">WebAudioModule (WAM) API base class.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_w_a_m_8h_source.html#l00028">IPlugWAM.h:31</a></div></div>
<div class="ttc" id="aclass_i_plug_w_a_m_html_a0ae41aa509f8f7bcc4dcb44a21816253"><div class="ttname"><a href="class_i_plug_w_a_m.html#a0ae41aa509f8f7bcc4dcb44a21816253">IPlugWAM::SendMidiMsg</a></div><div class="ttdeci">bool SendMidiMsg(const IMidiMsg &amp;msg) override</div><div class="ttdoc">Send a single MIDI message // TODO: info about what thread should this be called on or not called on!</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_w_a_m_8h_source.html#l00050">IPlugWAM.h:50</a></div></div>
<div class="ttc" id="aclass_i_plug_w_a_m_html_aa47fe866748000dc8899f5d263e25352"><div class="ttname"><a href="class_i_plug_w_a_m.html#aa47fe866748000dc8899f5d263e25352">IPlugWAM::SendSysEx</a></div><div class="ttdeci">bool SendSysEx(const ISysEx &amp;msg) override</div><div class="ttdoc">Send a single MIDI System Exclusive (SysEx) message // TODO: info about what thread should this be ca...</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_w_a_m_8h_source.html#l00051">IPlugWAM.h:51</a></div></div>
<div class="ttc" id="aclass_i_plug_w_a_m_html_aca74eaaee0212128d0dd69ebcc595487"><div class="ttname"><a href="class_i_plug_w_a_m.html#aca74eaaee0212128d0dd69ebcc595487">IPlugWAM::SetLatency</a></div><div class="ttdeci">void SetLatency(int samples) override</div><div class="ttdoc">Call this if the latency of your plug-in changes after initialization (perhaps from OnReset() ) This ...</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_w_a_m_8h_source.html#l00049">IPlugWAM.h:49</a></div></div>
<div class="ttc" id="astruct_i_midi_msg_html"><div class="ttname"><a href="struct_i_midi_msg.html">IMidiMsg</a></div><div class="ttdoc">Encapsulates a MIDI message and provides helper functions.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_midi_8h_source.html#l00030">IPlugMidi.h:31</a></div></div>
<div class="ttc" id="astruct_i_sys_ex_html"><div class="ttname"><a href="struct_i_sys_ex.html">ISysEx</a></div><div class="ttdoc">A struct for dealing with SysEx messages.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_midi_8h_source.html#l00538">IPlugMidi.h:539</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.5
</small></address>
</body>
</html>