-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_i_plug_v_s_t3___processor_8h_source.html
188 lines (186 loc) · 20.3 KB
/
_i_plug_v_s_t3___processor_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!-- 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: IPlugVST3_Processor.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&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&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_b8b37e024f559980bd14da047db80fdb.html">VST3</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IPlugVST3_Processor.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_plug_v_s_t3___processor_8h.html">Go to the documentation of this file.</a><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">#undef stricmp</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#undef strnicmp</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include "public.sdk/source/vst/vstaudioeffect.h"</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include "public.sdk/source/vst/hosting/parameterchanges.h"</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include "pluginterfaces/vst/ivstprocesscontext.h"</span></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><span class="preprocessor">#include "<a class="code" href="_i_plug_a_p_i_base_8h.html">IPlugAPIBase.h</a>"</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include "IPlugVST3_ProcessorBase.h"</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include "IPlugVST3_Common.h"</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>BEGIN_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_i_plug_v_s_t3_processor.html"> 34</a></span><span class="keyword">class </span><a class="code hl_class" href="class_i_plug_v_s_t3_processor.html">IPlugVST3Processor</a> : <span class="keyword">public</span> Steinberg::Vst::AudioEffect</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> , <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="l00036" name="l00036"></a><span class="lineno"> 36</span> , <span class="keyword">public</span> <a class="code hl_class" href="class_i_plug_v_s_t3_processor_base.html">IPlugVST3ProcessorBase</a></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>{</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">struct </span>InstanceInfo</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> {</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> Steinberg::FUID mOtherGUID;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> };</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="class_i_plug_v_s_t3_processor.html">IPlugVST3Processor</a>(<span class="keyword">const</span> InstanceInfo& info, <span class="keyword">const</span> Config& config);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_i_plug_v_s_t3_processor.html">~IPlugVST3Processor</a>();</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// AudioEffect overrides:</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> Steinberg::tresult PLUGIN_API initialize(FUnknown* context) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> Steinberg::tresult PLUGIN_API terminate() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> Steinberg::tresult PLUGIN_API setBusArrangements(Steinberg::Vst::SpeakerArrangement* inputs, Steinberg::int32 numIns, Steinberg::Vst::SpeakerArrangement* outputs, Steinberg::int32 numOuts) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> Steinberg::tresult PLUGIN_API setActive(Steinberg::TBool state) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> Steinberg::tresult PLUGIN_API setupProcessing(Steinberg::Vst::ProcessSetup& newSetup) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> Steinberg::tresult PLUGIN_API setProcessing (Steinberg::TBool state) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> Steinberg::tresult PLUGIN_API process(Steinberg::Vst::ProcessData& data) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> Steinberg::tresult PLUGIN_API canProcessSampleSize(Steinberg::int32 symbolicSampleSize) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> Steinberg::uint32 PLUGIN_API getLatencySamples()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> <a class="code hl_function" href="class_i_plug_processor.html#ae5e3ea6bb26f3719f69d8bcfa359263e">GetLatency</a>(); }</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> Steinberg::uint32 PLUGIN_API getTailSamples() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> Steinberg::tresult PLUGIN_API setState(Steinberg::IBStream* pState) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> Steinberg::tresult PLUGIN_API getState(Steinberg::IBStream* pState) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// IEditorDelegate - these methods are overridden because we need to hook into VST3 messaging system</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</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="l00063" name="l00063"></a><span class="lineno"> 63</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="l00064" name="l00064"></a><span class="lineno"> 64</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>{} <span class="comment">// NOOP in VST3 processor -> param change gets there via IPlugVST3Controller::setParamNormalized</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</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="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">void</span> removeAudioInputBus(Steinberg::Vst::AudioBus* pBus)</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> {</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> audioInputs.erase(std::remove(audioInputs.begin(), audioInputs.end(), pBus));</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">void</span> removeAudioOutputBus(Steinberg::Vst::AudioBus* pBus)</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> {</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> audioOutputs.erase(std::remove(audioOutputs.begin(), audioOutputs.end(), pBus));</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> }</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">void</span> TransmitMidiMsgFromProcessor(<span class="keyword">const</span> <a class="code hl_struct" href="struct_i_midi_msg.html">IMidiMsg</a>& msg) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">void</span> TransmitSysExDataFromProcessor(<span class="keyword">const</span> <a class="code hl_struct" href="struct_sys_ex_data.html">SysExData</a>& data) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// IConnectionPoint</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> Steinberg::tresult PLUGIN_API notify(Steinberg::Vst::IMessage* message) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment">// Steinberg::Vst::ParameterChanges mOutputParamChanges;</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_class" href="class_i_midi_queue_base.html">IMidiQueue</a> mMidiOutputQueue;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>};</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>Steinberg::FUnknown* MakeProcessor();</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="keyword">extern</span> Steinberg::FUnknown* MakeController();</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>END_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#endif </span><span class="comment">//_IPLUGAPI_</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="aclass_i_midi_queue_base_html"><div class="ttname"><a href="class_i_midi_queue_base.html">IMidiQueueBase< IMidiMsg ></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_ae5e3ea6bb26f3719f69d8bcfa359263e"><div class="ttname"><a href="class_i_plug_processor.html#ae5e3ea6bb26f3719f69d8bcfa359263e">IPlugProcessor::GetLatency</a></div><div class="ttdeci">int GetLatency() const</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_processor_8h_source.html#l00115">IPlugProcessor.h:115</a></div></div>
<div class="ttc" id="aclass_i_plug_v_s_t3_processor_base_html"><div class="ttname"><a href="class_i_plug_v_s_t3_processor_base.html">IPlugVST3ProcessorBase</a></div><div class="ttdoc">Shared VST3 processor code.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_v_s_t3___processor_base_8h_source.html#l00035">IPlugVST3_ProcessorBase.h:36</a></div></div>
<div class="ttc" id="aclass_i_plug_v_s_t3_processor_html"><div class="ttname"><a href="class_i_plug_v_s_t3_processor.html">IPlugVST3Processor</a></div><div class="ttdoc">VST3 Processor API-base class for a distributed IPlug VST3 plug-in.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_v_s_t3___processor_8h_source.html#l00034">IPlugVST3_Processor.h:37</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_sys_ex_data_html"><div class="ttname"><a href="struct_sys_ex_data.html">SysExData</a></div><div class="ttdoc">This structure is used when queueing Sysex messages.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_structs_8h_source.html#l00044">IPlugStructs.h:45</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <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>