|
|
|
@@ -68,7 +68,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
|
|
|
onmouseover="return searchBox.OnSearchSelectShow()" |
|
|
|
onmouseout="return searchBox.OnSearchSelectHide()" |
|
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)"> |
|
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</a></div> |
|
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div> |
|
|
|
|
|
|
|
<!-- iframe showing the search results (closed by default) --> |
|
|
|
<div id="MSearchResultsWindow"> |
|
|
|
@@ -387,436 +387,446 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
|
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  symbol(),</div> |
|
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  unit(),</div> |
|
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  ranges() {}</div> |
|
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> };</div> |
|
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> MIDI event.</span></div> |
|
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00306"></a><span class="lineno"><a class="line" href="structMidiEvent.html"> 306</a></span> <span class="keyword">struct </span><a class="code" href="structMidiEvent.html">MidiEvent</a> {<span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> Size of internal data.</span></div> |
|
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00310"></a><span class="lineno"><a class="line" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9"> 310</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">kDataSize</a> = 4;</div> |
|
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> Time offset in frames.</span></div> |
|
|
|
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00315"></a><span class="lineno"><a class="line" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e"> 315</a></span>  uint32_t <a class="code" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">frame</a>;</div> |
|
|
|
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> Constructor using custom values.</span></div> |
|
|
|
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00305"></a><span class="lineno"><a class="line" href="structParameter.html#af0c5eeebedfe0058775a7ff4d904b6ab"> 305</a></span>  <a class="code" href="structParameter.html#af0c5eeebedfe0058775a7ff4d904b6ab">Parameter</a>(uint32_t h, <span class="keyword">const</span> <span class="keywordtype">char</span>* n, <span class="keyword">const</span> <span class="keywordtype">char</span>* s, <span class="keyword">const</span> <span class="keywordtype">char</span>* u, <span class="keywordtype">float</span> def, <span class="keywordtype">float</span> min, <span class="keywordtype">float</span> max) noexcept</div> |
|
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  : <a class="code" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a>(h),</div> |
|
|
|
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <a class="code" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a>(n),</div> |
|
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <a class="code" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a>(s),</div> |
|
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <a class="code" href="structParameter.html#a2f79574998d34504e3a694163b4599a1">unit</a>(u),</div> |
|
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <a class="code" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a>(def, min, max) {}</div> |
|
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> };</div> |
|
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> MIDI event.</span></div> |
|
|
|
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00316"></a><span class="lineno"><a class="line" href="structMidiEvent.html"> 316</a></span> <span class="keyword">struct </span><a class="code" href="structMidiEvent.html">MidiEvent</a> {<span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> Number of bytes used.</span></div> |
|
|
|
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> Size of internal data.</span></div> |
|
|
|
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00320"></a><span class="lineno"><a class="line" href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e"> 320</a></span>  uint32_t <a class="code" href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e">size</a>;</div> |
|
|
|
<div class="line"><a name="l00320"></a><span class="lineno"><a class="line" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9"> 320</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">kDataSize</a> = 4;</div> |
|
|
|
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> MIDI data.@n</span></div> |
|
|
|
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> If size > kDataSize, dataExt is used (otherwise null).</span></div> |
|
|
|
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00326"></a><span class="lineno"><a class="line" href="structMidiEvent.html#aba54410d44eef48c10516f29452ef3a9"> 326</a></span>  uint8_t <a class="code" href="structMidiEvent.html#aba54410d44eef48c10516f29452ef3a9">data</a>[<a class="code" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">kDataSize</a>];</div> |
|
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  <span class="keyword">const</span> uint8_t* dataExt;</div> |
|
|
|
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> };</div> |
|
|
|
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> Time position.@n</span></div> |
|
|
|
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> The @a playing and @a frame values are always valid.@n</span></div> |
|
|
|
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> BBT values are only valid when @a bbt.valid is true.</span></div> |
|
|
|
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> This struct is inspired by the JACK Transport API.</span></div> |
|
|
|
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00337"></a><span class="lineno"><a class="line" href="structTimePosition.html"> 337</a></span> <span class="keyword">struct </span><a class="code" href="structTimePosition.html">TimePosition</a> {<span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> Wherever the host transport is playing/rolling.</span></div> |
|
|
|
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00341"></a><span class="lineno"><a class="line" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574"> 341</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574">playing</a>;</div> |
|
|
|
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> Current host transport position in frames.</span></div> |
|
|
|
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00346"></a><span class="lineno"><a class="line" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b"> 346</a></span>  uint64_t <a class="code" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b">frame</a>;</div> |
|
|
|
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> Time offset in frames.</span></div> |
|
|
|
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00325"></a><span class="lineno"><a class="line" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e"> 325</a></span>  uint32_t <a class="code" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">frame</a>;</div> |
|
|
|
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> Number of bytes used.</span></div> |
|
|
|
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00330"></a><span class="lineno"><a class="line" href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e"> 330</a></span>  uint32_t <a class="code" href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e">size</a>;</div> |
|
|
|
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> MIDI data.@n</span></div> |
|
|
|
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> If size > kDataSize, dataExt is used (otherwise null).</span></div> |
|
|
|
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00336"></a><span class="lineno"><a class="line" href="structMidiEvent.html#aba54410d44eef48c10516f29452ef3a9"> 336</a></span>  uint8_t <a class="code" href="structMidiEvent.html#aba54410d44eef48c10516f29452ef3a9">data</a>[<a class="code" href="structMidiEvent.html#a9e23ce17777c2ff5190670d3262129b9">kDataSize</a>];</div> |
|
|
|
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  <span class="keyword">const</span> uint8_t* dataExt;</div> |
|
|
|
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> };</div> |
|
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> Time position.@n</span></div> |
|
|
|
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> The @a playing and @a frame values are always valid.@n</span></div> |
|
|
|
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> BBT values are only valid when @a bbt.valid is true.</span></div> |
|
|
|
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> This struct is inspired by the JACK Transport API.</span></div> |
|
|
|
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00347"></a><span class="lineno"><a class="line" href="structTimePosition.html"> 347</a></span> <span class="keyword">struct </span><a class="code" href="structTimePosition.html">TimePosition</a> {<span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> Bar-Beat-Tick time position.</span></div> |
|
|
|
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> Wherever the host transport is playing/rolling.</span></div> |
|
|
|
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00351"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html"> 351</a></span>  <span class="keyword">struct </span><a class="code" href="structTimePosition_1_1BarBeatTick.html">BarBeatTick</a> {<span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> Wherever the host transport is using BBT.@n</span></div> |
|
|
|
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> If false you must not read from this struct.</span></div> |
|
|
|
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00356"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e"> 356</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e">valid</a>;</div> |
|
|
|
<div class="line"><a name="l00351"></a><span class="lineno"><a class="line" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574"> 351</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574">playing</a>;</div> |
|
|
|
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> Current host transport position in frames.</span></div> |
|
|
|
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00356"></a><span class="lineno"><a class="line" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b"> 356</a></span>  uint64_t <a class="code" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b">frame</a>;</div> |
|
|
|
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> Current bar.@n</span></div> |
|
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> Should always be > 0.@n</span></div> |
|
|
|
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> The first bar is bar '1'.</span></div> |
|
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00363"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21"> 363</a></span>  int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21">bar</a>;</div> |
|
|
|
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> Current beat within bar.@n</span></div> |
|
|
|
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> Should always be > 0 and <= @a beatsPerBar.@n</span></div> |
|
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> The first beat is beat '1'.</span></div> |
|
|
|
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00370"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c"> 370</a></span>  int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c">beat</a>;</div> |
|
|
|
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> Current tick within beat.@n</span></div> |
|
|
|
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> Should always be > 0 and <= @a ticksPerBeat.@n</span></div> |
|
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> The first tick is tick '0'.</span></div> |
|
|
|
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00377"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ad38d7364a5441f1f49c3538f5691a299"> 377</a></span>  int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#ad38d7364a5441f1f49c3538f5691a299">tick</a>;</div> |
|
|
|
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> Number of ticks that have elapsed between frame 0 and the first beat of the current measure.</span></div> |
|
|
|
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00382"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62"> 382</a></span>  <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">barStartTick</a>;</div> |
|
|
|
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> Time signature "numerator".</span></div> |
|
|
|
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> Bar-Beat-Tick time position.</span></div> |
|
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00361"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html"> 361</a></span>  <span class="keyword">struct </span><a class="code" href="structTimePosition_1_1BarBeatTick.html">BarBeatTick</a> {<span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> Wherever the host transport is using BBT.@n</span></div> |
|
|
|
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> If false you must not read from this struct.</span></div> |
|
|
|
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00366"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e"> 366</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e">valid</a>;</div> |
|
|
|
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> Current bar.@n</span></div> |
|
|
|
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> Should always be > 0.@n</span></div> |
|
|
|
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"> The first bar is bar '1'.</span></div> |
|
|
|
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00373"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21"> 373</a></span>  int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21">bar</a>;</div> |
|
|
|
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> Current beat within bar.@n</span></div> |
|
|
|
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> Should always be > 0 and <= @a beatsPerBar.@n</span></div> |
|
|
|
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> The first beat is beat '1'.</span></div> |
|
|
|
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00380"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c"> 380</a></span>  int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c">beat</a>;</div> |
|
|
|
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> Current tick within beat.@n</span></div> |
|
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> Should always be > 0 and <= @a ticksPerBeat.@n</span></div> |
|
|
|
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> The first tick is tick '0'.</span></div> |
|
|
|
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00387"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88"> 387</a></span>  <span class="keywordtype">float</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">beatsPerBar</a>;</div> |
|
|
|
<div class="line"><a name="l00387"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ad38d7364a5441f1f49c3538f5691a299"> 387</a></span>  int32_t <a class="code" href="structTimePosition_1_1BarBeatTick.html#ad38d7364a5441f1f49c3538f5691a299">tick</a>;</div> |
|
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> Time signature "denominator".</span></div> |
|
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> Number of ticks that have elapsed between frame 0 and the first beat of the current measure.</span></div> |
|
|
|
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00392"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257"> 392</a></span>  <span class="keywordtype">float</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">beatType</a>;</div> |
|
|
|
<div class="line"><a name="l00392"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62"> 392</a></span>  <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">barStartTick</a>;</div> |
|
|
|
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"> Number of ticks within a bar.@n</span></div> |
|
|
|
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> Usually a moderately large integer with many denominators, such as 1920.0.</span></div> |
|
|
|
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00398"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062"> 398</a></span>  <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">ticksPerBeat</a>;</div> |
|
|
|
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> Number of beats per minute.</span></div> |
|
|
|
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00403"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f"> 403</a></span>  <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">beatsPerMinute</a>;</div> |
|
|
|
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> Default constructor for a null BBT time position.</span></div> |
|
|
|
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"> Time signature "numerator".</span></div> |
|
|
|
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00397"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88"> 397</a></span>  <span class="keywordtype">float</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">beatsPerBar</a>;</div> |
|
|
|
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> Time signature "denominator".</span></div> |
|
|
|
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00402"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257"> 402</a></span>  <span class="keywordtype">float</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">beatType</a>;</div> |
|
|
|
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> Number of ticks within a bar.@n</span></div> |
|
|
|
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> Usually a moderately large integer with many denominators, such as 1920.0.</span></div> |
|
|
|
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00408"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef"> 408</a></span>  <a class="code" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef">BarBeatTick</a>() noexcept</div> |
|
|
|
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  : valid(false),</div> |
|
|
|
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  bar(0),</div> |
|
|
|
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  beat(0),</div> |
|
|
|
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  tick(0),</div> |
|
|
|
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  barStartTick(0.0),</div> |
|
|
|
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  beatsPerBar(0.0f),</div> |
|
|
|
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  beatType(0.0f),</div> |
|
|
|
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>  ticksPerBeat(0.0),</div> |
|
|
|
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>  beatsPerMinute(0.0) {}</div> |
|
|
|
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>  } bbt;</div> |
|
|
|
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> Default constructor for a time position.</span></div> |
|
|
|
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00423"></a><span class="lineno"><a class="line" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae"> 423</a></span>  <a class="code" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae">TimePosition</a>() noexcept</div> |
|
|
|
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  : playing(false),</div> |
|
|
|
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  frame(0),</div> |
|
|
|
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  bbt() {}</div> |
|
|
|
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> };</div> |
|
|
|
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment">/** @} */</span></div> |
|
|
|
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> </div> |
|
|
|
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> * DPF Plugin */</span></div> |
|
|
|
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> @defgroup MainClasses Main Classes</span></div> |
|
|
|
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment"> @{</span></div> |
|
|
|
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00408"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062"> 408</a></span>  <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">ticksPerBeat</a>;</div> |
|
|
|
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment"> Number of beats per minute.</span></div> |
|
|
|
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00413"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f"> 413</a></span>  <span class="keywordtype">double</span> <a class="code" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">beatsPerMinute</a>;</div> |
|
|
|
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> Default constructor for a null BBT time position.</span></div> |
|
|
|
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00418"></a><span class="lineno"><a class="line" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef"> 418</a></span>  <a class="code" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef">BarBeatTick</a>() noexcept</div> |
|
|
|
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  : valid(false),</div> |
|
|
|
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>  bar(0),</div> |
|
|
|
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  beat(0),</div> |
|
|
|
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  tick(0),</div> |
|
|
|
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  barStartTick(0.0),</div> |
|
|
|
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  beatsPerBar(0.0f),</div> |
|
|
|
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  beatType(0.0f),</div> |
|
|
|
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  ticksPerBeat(0.0),</div> |
|
|
|
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  beatsPerMinute(0.0) {}</div> |
|
|
|
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  } bbt;</div> |
|
|
|
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> Default constructor for a time position.</span></div> |
|
|
|
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00433"></a><span class="lineno"><a class="line" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae"> 433</a></span>  <a class="code" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae">TimePosition</a>() noexcept</div> |
|
|
|
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>  : playing(false),</div> |
|
|
|
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  frame(0),</div> |
|
|
|
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  bbt() {}</div> |
|
|
|
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> };</div> |
|
|
|
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> DPF Plugin class from where plugin instances are created.</span></div> |
|
|
|
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> The public methods (Host state) are called from the plugin to get or set host information.@n</span></div> |
|
|
|
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> They can be called from a plugin instance at anytime unless stated otherwise.@n</span></div> |
|
|
|
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment"> All other methods are to be implemented by the plugin and will be called by the host.</span></div> |
|
|
|
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment"> Shortly after a plugin instance is created, the various init* functions will be called by the host.@n</span></div> |
|
|
|
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"> Host will call activate() before run(), and deactivate() before the plugin instance is destroyed.@n</span></div> |
|
|
|
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment"> The host may call deactivate right after activate and vice-versa, but never activate/deactivate consecutively.@n</span></div> |
|
|
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="comment"> There is no limit on how many times run() is called, only that activate/deactivate will be called in between.</span></div> |
|
|
|
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment"> The buffer size and sample rate values will remain constant between activate and deactivate.@n</span></div> |
|
|
|
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment"> Buffer size is only a hint though, the host might call run() with a higher or lower number of frames.</span></div> |
|
|
|
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment"> Some of this class functions are only available according to some macros.</span></div> |
|
|
|
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment">/** @} */</span></div> |
|
|
|
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> </div> |
|
|
|
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> * DPF Plugin */</span></div> |
|
|
|
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment"> @defgroup MainClasses Main Classes</span></div> |
|
|
|
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment"> @{</span></div> |
|
|
|
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment"> DPF Plugin class from where plugin instances are created.</span></div> |
|
|
|
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment"> The public methods (Host state) are called from the plugin to get or set host information.@n</span></div> |
|
|
|
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment"> They can be called from a plugin instance at anytime unless stated otherwise.@n</span></div> |
|
|
|
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment"> All other methods are to be implemented by the plugin and will be called by the host.</span></div> |
|
|
|
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"> DISTRHO_PLUGIN_WANT_PROGRAMS activates program related features.@n</span></div> |
|
|
|
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> When enabled you need to implement initProgramName() and loadProgram().</span></div> |
|
|
|
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"> DISTRHO_PLUGIN_WANT_STATE activates internal state features.@n</span></div> |
|
|
|
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> When enabled you need to implement initStateKey() and setState().</span></div> |
|
|
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> The process function run() changes wherever DISTRHO_PLUGIN_WANT_MIDI_INPUT is enabled or not.@n</span></div> |
|
|
|
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"> When enabled it provides midi input events.</span></div> |
|
|
|
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00465"></a><span class="lineno"><a class="line" href="classPlugin.html"> 465</a></span> <span class="keyword">class </span><a class="code" href="classPlugin.html">Plugin</a></div> |
|
|
|
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> {</div> |
|
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="keyword">public</span>:<span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> Plugin class constructor.@n</span></div> |
|
|
|
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> You must set all parameter values to their defaults, matching ParameterRanges::def.</span></div> |
|
|
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  <a class="code" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin</a>(uint32_t parameterCount, uint32_t programCount, uint32_t stateCount);</div> |
|
|
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> Destructor.</span></div> |
|
|
|
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  <span class="keyword">virtual</span> <a class="code" href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">~Plugin</a>();</div> |
|
|
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span> </div> |
|
|
|
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> * Host state */</span></div> |
|
|
|
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> Get the current buffer size that will probably be used during processing, in frames.@n</span></div> |
|
|
|
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> This value will remain constant between activate and deactivate.</span></div> |
|
|
|
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> @note This value is only a hint!@n</span></div> |
|
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> Hosts might call run() with a higher or lower number of frames.</span></div> |
|
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> @see bufferSizeChanged(uint32_t)</span></div> |
|
|
|
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  uint32_t <a class="code" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize</a>() <span class="keyword">const</span> noexcept;</div> |
|
|
|
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> Get the current sample rate that will be used during processing.@n</span></div> |
|
|
|
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> This value will remain constant between activate and deactivate.</span></div> |
|
|
|
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> @see sampleRateChanged(double)</span></div> |
|
|
|
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  <span class="keywordtype">double</span> <a class="code" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">getSampleRate</a>() <span class="keyword">const</span> noexcept;</div> |
|
|
|
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> </div> |
|
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_TIMEPOS</span></div> |
|
|
|
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> Get the current host transport time position.@n</span></div> |
|
|
|
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> This function should only be called during run().@n</span></div> |
|
|
|
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> You can call this during other times, but the returned position is not guaranteed to be in sync.</span></div> |
|
|
|
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> @note TimePosition is not supported in LADSPA and DSSI plugin formats.</span></div> |
|
|
|
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  <span class="keyword">const</span> <a class="code" href="structTimePosition.html">TimePosition</a>& <a class="code" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">getTimePosition</a>() <span class="keyword">const</span> noexcept;</div> |
|
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"> Shortly after a plugin instance is created, the various init* functions will be called by the host.@n</span></div> |
|
|
|
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> Host will call activate() before run(), and deactivate() before the plugin instance is destroyed.@n</span></div> |
|
|
|
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"> The host may call deactivate right after activate and vice-versa, but never activate/deactivate consecutively.@n</span></div> |
|
|
|
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"> There is no limit on how many times run() is called, only that activate/deactivate will be called in between.</span></div> |
|
|
|
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> The buffer size and sample rate values will remain constant between activate and deactivate.@n</span></div> |
|
|
|
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> Buffer size is only a hint though, the host might call run() with a higher or lower number of frames.</span></div> |
|
|
|
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> Some of this class functions are only available according to some macros.</span></div> |
|
|
|
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment"> DISTRHO_PLUGIN_WANT_PROGRAMS activates program related features.@n</span></div> |
|
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"> When enabled you need to implement initProgramName() and loadProgram().</span></div> |
|
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> DISTRHO_PLUGIN_WANT_STATE activates internal state features.@n</span></div> |
|
|
|
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> When enabled you need to implement initStateKey() and setState().</span></div> |
|
|
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> The process function run() changes wherever DISTRHO_PLUGIN_WANT_MIDI_INPUT is enabled or not.@n</span></div> |
|
|
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"> When enabled it provides midi input events.</span></div> |
|
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00475"></a><span class="lineno"><a class="line" href="classPlugin.html"> 475</a></span> <span class="keyword">class </span><a class="code" href="classPlugin.html">Plugin</a></div> |
|
|
|
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> {</div> |
|
|
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="keyword">public</span>:<span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"> Plugin class constructor.@n</span></div> |
|
|
|
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> You must set all parameter values to their defaults, matching ParameterRanges::def.</span></div> |
|
|
|
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  <a class="code" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin</a>(uint32_t parameterCount, uint32_t programCount, uint32_t stateCount);</div> |
|
|
|
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> Destructor.</span></div> |
|
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  <span class="keyword">virtual</span> <a class="code" href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">~Plugin</a>();</div> |
|
|
|
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> </div> |
|
|
|
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"> * Host state */</span></div> |
|
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> Get the current buffer size that will probably be used during processing, in frames.@n</span></div> |
|
|
|
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> This value will remain constant between activate and deactivate.</span></div> |
|
|
|
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> @note This value is only a hint!@n</span></div> |
|
|
|
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> Hosts might call run() with a higher or lower number of frames.</span></div> |
|
|
|
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> @see bufferSizeChanged(uint32_t)</span></div> |
|
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  uint32_t <a class="code" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize</a>() <span class="keyword">const</span> noexcept;</div> |
|
|
|
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> Get the current sample rate that will be used during processing.@n</span></div> |
|
|
|
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> This value will remain constant between activate and deactivate.</span></div> |
|
|
|
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> @see sampleRateChanged(double)</span></div> |
|
|
|
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  <span class="keywordtype">double</span> <a class="code" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">getSampleRate</a>() <span class="keyword">const</span> noexcept;</div> |
|
|
|
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span> </div> |
|
|
|
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_LATENCY</span></div> |
|
|
|
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_TIMEPOS</span></div> |
|
|
|
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> Change the plugin audio output latency to @a frames.@n</span></div> |
|
|
|
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> This function should only be called in the constructor, activate() and run().</span></div> |
|
|
|
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> @note This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span>  <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">setLatency</a>(uint32_t frames) noexcept;</div> |
|
|
|
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> </div> |
|
|
|
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</span></div> |
|
|
|
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> Write a MIDI output event.@n</span></div> |
|
|
|
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"> This function must only be called during run().@n</span></div> |
|
|
|
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment"> Returns false when the host buffer is full, in which case do not call this again until the next run().</span></div> |
|
|
|
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">writeMidiEvent</a>(<span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>& midiEvent) noexcept;</div> |
|
|
|
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span> </div> |
|
|
|
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="keyword">protected</span>:</div> |
|
|
|
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> * Information */</span></div> |
|
|
|
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> Get the plugin name.@n</span></div> |
|
|
|
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> Returns DISTRHO_PLUGIN_NAME by default.</span></div> |
|
|
|
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00534"></a><span class="lineno"><a class="line" href="classPlugin.html#a181bc1b9e4094921da788640955a3018"> 534</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a181bc1b9e4094921da788640955a3018">getName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a>; }</div> |
|
|
|
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"> Get the plugin label.@n</span></div> |
|
|
|
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"> This label is a short restricted name consisting of only _, a-z, A-Z and 0-9 characters.</span></div> |
|
|
|
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">getLabel</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> Get the plugin author/maker.</span></div> |
|
|
|
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">getMaker</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> Get the plugin license name (a single line of text).@n</span></div> |
|
|
|
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"> For commercial plugins this should return some short copyright information.</span></div> |
|
|
|
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">getLicense</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> Get the plugin version, in hexadecimal.@n</span></div> |
|
|
|
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> TODO format to be defined</span></div> |
|
|
|
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span>  <span class="keyword">virtual</span> uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"> Get the plugin unique Id.@n</span></div> |
|
|
|
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"> This value is used by LADSPA, DSSI and VST plugin formats.</span></div> |
|
|
|
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>  <span class="keyword">virtual</span> int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span> </div> |
|
|
|
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> * Init */</span></div> |
|
|
|
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> Initialize the audio port @a index.@n</span></div> |
|
|
|
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> This function will be called once, shortly after the plugin is created.</span></div> |
|
|
|
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">initAudioPort</a>(<span class="keywordtype">bool</span> input, uint32_t index, <a class="code" href="structAudioPort.html">AudioPort</a>& port);</div> |
|
|
|
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"> Initialize the parameter @a index.@n</span></div> |
|
|
|
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> This function will be called once, shortly after the plugin is created.</span></div> |
|
|
|
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a5b0ec59527a1c2f4b01f17fc8c18ea8b">initParameter</a>(uint32_t index, <a class="code" href="structParameter.html">Parameter</a>& parameter) = 0;</div> |
|
|
|
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span> </div> |
|
|
|
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span></div> |
|
|
|
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"> Set the name of the program @a index.@n</span></div> |
|
|
|
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> This function will be called once, shortly after the plugin is created.@n</span></div> |
|
|
|
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">initProgramName</a>(uint32_t index, <a class="code" href="classString.html">String</a>& programName) = 0;</div> |
|
|
|
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span> </div> |
|
|
|
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div> |
|
|
|
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"> Set the state key and default value of @a index.@n</span></div> |
|
|
|
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"> This function will be called once, shortly after the plugin is created.@n</span></div> |
|
|
|
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ae301a970a8b5cff3c7ecef927ea20080">initState</a>(uint32_t index, <a class="code" href="classString.html">String</a>& stateKey, <a class="code" href="classString.html">String</a>& defaultStateValue) = 0;</div> |
|
|
|
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span> </div> |
|
|
|
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment"> * Internal data */</span></div> |
|
|
|
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment"> Get the current value of a parameter.@n</span></div> |
|
|
|
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"> The host may call this function from any context, including realtime processing.</span></div> |
|
|
|
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> Get the current host transport time position.@n</span></div> |
|
|
|
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> This function should only be called during run().@n</span></div> |
|
|
|
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> You can call this during other times, but the returned position is not guaranteed to be in sync.</span></div> |
|
|
|
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> @note TimePosition is not supported in LADSPA and DSSI plugin formats.</span></div> |
|
|
|
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  <span class="keyword">const</span> <a class="code" href="structTimePosition.html">TimePosition</a>& <a class="code" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">getTimePosition</a>() <span class="keyword">const</span> noexcept;</div> |
|
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> </div> |
|
|
|
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_LATENCY</span></div> |
|
|
|
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"> Change the plugin audio output latency to @a frames.@n</span></div> |
|
|
|
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment"> This function should only be called in the constructor, activate() and run().</span></div> |
|
|
|
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"> @note This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">setLatency</a>(uint32_t frames) noexcept;</div> |
|
|
|
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span> </div> |
|
|
|
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</span></div> |
|
|
|
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> Write a MIDI output event.@n</span></div> |
|
|
|
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> This function must only be called during run().@n</span></div> |
|
|
|
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> Returns false when the host buffer is full, in which case do not call this again until the next run().</span></div> |
|
|
|
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  <span class="keywordtype">bool</span> <a class="code" href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">writeMidiEvent</a>(<span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>& midiEvent) noexcept;</div> |
|
|
|
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span> </div> |
|
|
|
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="keyword">protected</span>:</div> |
|
|
|
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"> * Information */</span></div> |
|
|
|
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"> Get the plugin name.@n</span></div> |
|
|
|
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"> Returns DISTRHO_PLUGIN_NAME by default.</span></div> |
|
|
|
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00544"></a><span class="lineno"><a class="line" href="classPlugin.html#a181bc1b9e4094921da788640955a3018"> 544</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a181bc1b9e4094921da788640955a3018">getName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a>; }</div> |
|
|
|
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> Get the plugin label.@n</span></div> |
|
|
|
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> This label is a short restricted name consisting of only _, a-z, A-Z and 0-9 characters.</span></div> |
|
|
|
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">getLabel</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"> Get the plugin author/maker.</span></div> |
|
|
|
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">getMaker</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> Get the plugin license name (a single line of text).@n</span></div> |
|
|
|
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> For commercial plugins this should return some short copyright information.</span></div> |
|
|
|
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">getLicense</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"> Get the plugin version, in hexadecimal.@n</span></div> |
|
|
|
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"> TODO format to be defined</span></div> |
|
|
|
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  <span class="keyword">virtual</span> uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> Get the plugin unique Id.@n</span></div> |
|
|
|
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> This value is used by LADSPA, DSSI and VST plugin formats.</span></div> |
|
|
|
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  <span class="keyword">virtual</span> int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>() <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> </div> |
|
|
|
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> * Init */</span></div> |
|
|
|
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"> Initialize the audio port @a index.@n</span></div> |
|
|
|
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> This function will be called once, shortly after the plugin is created.</span></div> |
|
|
|
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">initAudioPort</a>(<span class="keywordtype">bool</span> input, uint32_t index, <a class="code" href="structAudioPort.html">AudioPort</a>& port);</div> |
|
|
|
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> Initialize the parameter @a index.@n</span></div> |
|
|
|
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> This function will be called once, shortly after the plugin is created.</span></div> |
|
|
|
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a5b0ec59527a1c2f4b01f17fc8c18ea8b">initParameter</a>(uint32_t index, <a class="code" href="structParameter.html">Parameter</a>& parameter) = 0;</div> |
|
|
|
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> </div> |
|
|
|
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span></div> |
|
|
|
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"> Set the name of the program @a index.@n</span></div> |
|
|
|
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> This function will be called once, shortly after the plugin is created.@n</span></div> |
|
|
|
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">initProgramName</a>(uint32_t index, <a class="code" href="classString.html">String</a>& programName) = 0;</div> |
|
|
|
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span> </div> |
|
|
|
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div> |
|
|
|
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span> <span class="comment"> Set the state key and default value of @a index.@n</span></div> |
|
|
|
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment"> This function will be called once, shortly after the plugin is created.@n</span></div> |
|
|
|
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"> Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classPlugin.html#a2d1da98c90568bb4547662bc4f02c31f">getParameterValue</a>(uint32_t index) <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"> Change a parameter value.@n</span></div> |
|
|
|
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> The host may call this function from any context, including realtime processing.@n</span></div> |
|
|
|
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"> When a parameter is marked as automable, you must ensure no non-realtime operations are performed.</span></div> |
|
|
|
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> @note This function will only be called for parameter inputs.</span></div> |
|
|
|
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a6911a881fabb9eca9daf0eadbaad8599">setParameterValue</a>(uint32_t index, <span class="keywordtype">float</span> value) = 0;</div> |
|
|
|
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span> </div> |
|
|
|
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span></div> |
|
|
|
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"> Load a program.@n</span></div> |
|
|
|
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"> The host may call this function from any context, including realtime processing.@n</span></div> |
|
|
|
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment"> Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">loadProgram</a>(uint32_t index) = 0;</div> |
|
|
|
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span> </div> |
|
|
|
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div> |
|
|
|
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> Change an internal state @a key to @a value.@n</span></div> |
|
|
|
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ad25ed64a2f00f48c86d2ae0016ea3e59">setState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value) = 0;</div> |
|
|
|
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span> </div> |
|
|
|
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="comment"> * Audio/MIDI Processing */</span></div> |
|
|
|
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ae301a970a8b5cff3c7ecef927ea20080">initState</a>(uint32_t index, <a class="code" href="classString.html">String</a>& stateKey, <a class="code" href="classString.html">String</a>& defaultStateValue) = 0;</div> |
|
|
|
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span> </div> |
|
|
|
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> * Internal data */</span></div> |
|
|
|
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> Get the current value of a parameter.@n</span></div> |
|
|
|
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"> The host may call this function from any context, including realtime processing.</span></div> |
|
|
|
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classPlugin.html#a2d1da98c90568bb4547662bc4f02c31f">getParameterValue</a>(uint32_t index) <span class="keyword">const</span> = 0;</div> |
|
|
|
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"> Change a parameter value.@n</span></div> |
|
|
|
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment"> The host may call this function from any context, including realtime processing.@n</span></div> |
|
|
|
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment"> When a parameter is marked as automable, you must ensure no non-realtime operations are performed.</span></div> |
|
|
|
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"> @note This function will only be called for parameter inputs.</span></div> |
|
|
|
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a6911a881fabb9eca9daf0eadbaad8599">setParameterValue</a>(uint32_t index, <span class="keywordtype">float</span> value) = 0;</div> |
|
|
|
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> </div> |
|
|
|
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span></div> |
|
|
|
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> Load a program.@n</span></div> |
|
|
|
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment"> The host may call this function from any context, including realtime processing.@n</span></div> |
|
|
|
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment"> Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">loadProgram</a>(uint32_t index) = 0;</div> |
|
|
|
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> </div> |
|
|
|
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div> |
|
|
|
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment"> Activate this plugin.</span></div> |
|
|
|
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00638"></a><span class="lineno"><a class="line" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c"> 638</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">activate</a>() {}</div> |
|
|
|
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment"> Deactivate this plugin.</span></div> |
|
|
|
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00643"></a><span class="lineno"><a class="line" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46"> 643</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46">deactivate</a>() {}</div> |
|
|
|
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> </div> |
|
|
|
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_INPUT</span></div> |
|
|
|
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment"> Run/process function for plugins with MIDI input.</span></div> |
|
|
|
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment"> @note Some parameters might be null if there are no audio inputs/outputs or MIDI events.</span></div> |
|
|
|
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames,</div> |
|
|
|
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span>  <span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>* midiEvents, uint32_t midiEventCount) = 0;</div> |
|
|
|
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="preprocessor">#else</span></div> |
|
|
|
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> Run/process function for plugins without MIDI input.</span></div> |
|
|
|
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> @note Some parameters might be null if there are no audio inputs or outputs.</span></div> |
|
|
|
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames) = 0;</div> |
|
|
|
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> </div> |
|
|
|
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"> * Callbacks (optional) */</span></div> |
|
|
|
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment"> Change an internal state @a key to @a value.@n</span></div> |
|
|
|
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment"> Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.</span></div> |
|
|
|
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#ad25ed64a2f00f48c86d2ae0016ea3e59">setState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value) = 0;</div> |
|
|
|
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> </div> |
|
|
|
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment"> * Audio/MIDI Processing */</span></div> |
|
|
|
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="comment"> Activate this plugin.</span></div> |
|
|
|
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00648"></a><span class="lineno"><a class="line" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c"> 648</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">activate</a>() {}</div> |
|
|
|
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment"> Deactivate this plugin.</span></div> |
|
|
|
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00653"></a><span class="lineno"><a class="line" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46"> 653</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46">deactivate</a>() {}</div> |
|
|
|
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span> </div> |
|
|
|
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_INPUT</span></div> |
|
|
|
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> Run/process function for plugins with MIDI input.</span></div> |
|
|
|
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"> @note Some parameters might be null if there are no audio inputs/outputs or MIDI events.</span></div> |
|
|
|
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames,</div> |
|
|
|
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span>  <span class="keyword">const</span> <a class="code" href="structMidiEvent.html">MidiEvent</a>* midiEvents, uint32_t midiEventCount) = 0;</div> |
|
|
|
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="preprocessor">#else</span></div> |
|
|
|
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> Optional callback to inform the plugin about a buffer size change.@n</span></div> |
|
|
|
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> This function will only be called when the plugin is deactivated.</span></div> |
|
|
|
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> @note This value is only a hint!@n</span></div> |
|
|
|
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment"> Hosts might call run() with a higher or lower number of frames.</span></div> |
|
|
|
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment"> @see getBufferSize()</span></div> |
|
|
|
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297">bufferSizeChanged</a>(uint32_t newBufferSize);</div> |
|
|
|
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> Optional callback to inform the plugin about a sample rate change.@n</span></div> |
|
|
|
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> This function will only be called when the plugin is deactivated.</span></div> |
|
|
|
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> @see getSampleRate()</span></div> |
|
|
|
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc">sampleRateChanged</a>(<span class="keywordtype">double</span> newSampleRate);</div> |
|
|
|
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span> </div> |
|
|
|
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span>  <span class="comment">// -------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span> </div> |
|
|
|
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="keyword">private</span>:</div> |
|
|
|
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span>  <span class="keyword">struct </span>PrivateData;</div> |
|
|
|
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span>  PrivateData* <span class="keyword">const</span> pData;</div> |
|
|
|
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span>  <span class="keyword">friend</span> <span class="keyword">class </span>PluginExporter;</div> |
|
|
|
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> </div> |
|
|
|
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span>  DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classPlugin.html">Plugin</a>)</div> |
|
|
|
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span> };</div> |
|
|
|
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment">/** @} */</span></div> |
|
|
|
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> Run/process function for plugins without MIDI input.</span></div> |
|
|
|
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> @note Some parameters might be null if there are no audio inputs or outputs.</span></div> |
|
|
|
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>** inputs, <span class="keywordtype">float</span>** outputs, uint32_t frames) = 0;</div> |
|
|
|
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="preprocessor">#endif</span></div> |
|
|
|
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span> </div> |
|
|
|
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span>  <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> * Callbacks (optional) */</span></div> |
|
|
|
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> Optional callback to inform the plugin about a buffer size change.@n</span></div> |
|
|
|
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> This function will only be called when the plugin is deactivated.</span></div> |
|
|
|
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> @note This value is only a hint!@n</span></div> |
|
|
|
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment"> Hosts might call run() with a higher or lower number of frames.</span></div> |
|
|
|
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="comment"> @see getBufferSize()</span></div> |
|
|
|
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297">bufferSizeChanged</a>(uint32_t newBufferSize);</div> |
|
|
|
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="comment"> /**</span></div> |
|
|
|
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="comment"> Optional callback to inform the plugin about a sample rate change.@n</span></div> |
|
|
|
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment"> This function will only be called when the plugin is deactivated.</span></div> |
|
|
|
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment"> @see getSampleRate()</span></div> |
|
|
|
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc">sampleRateChanged</a>(<span class="keywordtype">double</span> newSampleRate);</div> |
|
|
|
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span> </div> |
|
|
|
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span>  <span class="comment">// -------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00690"></a><span class="lineno"> 690</span> </div> |
|
|
|
<div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> * Create plugin, entry point */</span></div> |
|
|
|
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment"> @defgroup EntryPoints Entry Points</span></div> |
|
|
|
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment"> @{</span></div> |
|
|
|
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="keyword">private</span>:</div> |
|
|
|
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span>  <span class="keyword">struct </span>PrivateData;</div> |
|
|
|
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span>  PrivateData* <span class="keyword">const</span> pData;</div> |
|
|
|
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span>  <span class="keyword">friend</span> <span class="keyword">class </span>PluginExporter;</div> |
|
|
|
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span> </div> |
|
|
|
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span>  DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classPlugin.html">Plugin</a>)</div> |
|
|
|
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span> };</div> |
|
|
|
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment"> TODO.</span></div> |
|
|
|
<div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="keyword">extern</span> <a class="code" href="classPlugin.html">Plugin</a>* <a class="code" href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee">createPlugin</a>();</div> |
|
|
|
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment">/** @} */</span></div> |
|
|
|
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span> </div> |
|
|
|
<div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="comment"> * Create plugin, entry point */</span></div> |
|
|
|
<div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment">/** @} */</span></div> |
|
|
|
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span> </div> |
|
|
|
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment">// -----------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span> </div> |
|
|
|
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span> END_NAMESPACE_DISTRHO</div> |
|
|
|
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> </div> |
|
|
|
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="preprocessor">#endif // DISTRHO_PLUGIN_HPP_INCLUDED</span></div> |
|
|
|
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment"> @defgroup EntryPoints Entry Points</span></div> |
|
|
|
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment"> @{</span></div> |
|
|
|
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="comment">/**</span></div> |
|
|
|
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment"> TODO.</span></div> |
|
|
|
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment"> */</span></div> |
|
|
|
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="keyword">extern</span> <a class="code" href="classPlugin.html">Plugin</a>* <a class="code" href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee">createPlugin</a>();</div> |
|
|
|
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment"></span></div> |
|
|
|
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment">/** @} */</span></div> |
|
|
|
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span> </div> |
|
|
|
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment">// -----------------------------------------------------------------------------------------------------------</span></div> |
|
|
|
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span> </div> |
|
|
|
<div class="line"><a name="l00718"></a><span class="lineno"> 718</span> END_NAMESPACE_DISTRHO</div> |
|
|
|
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span> </div> |
|
|
|
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="preprocessor">#endif // DISTRHO_PLUGIN_HPP_INCLUDED</span></div> |
|
|
|
<div class="ttc" id="structParameterRanges_html_a63c40988463a8ace9d0e9e55a00f3c7b"><div class="ttname"><a href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">ParameterRanges::min</a></div><div class="ttdeci">float min</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:152</div></div> |
|
|
|
<div class="ttc" id="structAudioPort_html"><div class="ttname"><a href="structAudioPort.html">AudioPort</a></div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:105</div></div> |
|
|
|
<div class="ttc" id="classPlugin_html_aa5c1262f5ca20536bb5850fdd6faa22c"><div class="ttname"><a href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">Plugin::activate</a></div><div class="ttdeci">virtual void activate()</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:638</div></div> |
|
|
|
<div class="ttc" id="classPlugin_html_aa5c1262f5ca20536bb5850fdd6faa22c"><div class="ttname"><a href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">Plugin::activate</a></div><div class="ttdeci">virtual void activate()</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:648</div></div> |
|
|
|
<div class="ttc" id="classPlugin_html_a2d1da98c90568bb4547662bc4f02c31f"><div class="ttname"><a href="classPlugin.html#a2d1da98c90568bb4547662bc4f02c31f">Plugin::getParameterValue</a></div><div class="ttdeci">virtual float getParameterValue(uint32_t index) const =0</div></div> |
|
|
|
<div class="ttc" id="structParameter_html_a12ced87d6d832deccb6c8ce2c8313b2e"><div class="ttname"><a href="structParameter.html#a12ced87d6d832deccb6c8ce2c8313b2e">Parameter::Parameter</a></div><div class="ttdeci">Parameter() noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:295</div></div> |
|
|
|
<div class="ttc" id="group__EntryPoints_html_ga87f1fa9084f2490ca04ea733292c6dee"><div class="ttname"><a href="group__EntryPoints.html#ga87f1fa9084f2490ca04ea733292c6dee">createPlugin</a></div><div class="ttdeci">Plugin * createPlugin()</div></div> |
|
|
|
<div class="ttc" id="structMidiEvent_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> DistrhoPlugin.hpp:315</div></div> |
|
|
|
<div class="ttc" id="structMidiEvent_html_a48b420a6dbca6502113b92c336a3041e"><div class="ttname"><a href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e">MidiEvent::size</a></div><div class="ttdeci">uint32_t size</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:320</div></div> |
|
|
|
<div class="ttc" id="structMidiEvent_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> DistrhoPlugin.hpp:325</div></div> |
|
|
|
<div class="ttc" id="structMidiEvent_html_a48b420a6dbca6502113b92c336a3041e"><div class="ttname"><a href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e">MidiEvent::size</a></div><div class="ttdeci">uint32_t size</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:330</div></div> |
|
|
|
<div class="ttc" id="structAudioPort_html_adb3b58f79131b653d6b2adfa3ea07e5c"><div class="ttname"><a href="structAudioPort.html#adb3b58f79131b653d6b2adfa3ea07e5c">AudioPort::name</a></div><div class="ttdeci">String name</div><div class="ttdef"><b>Definition:</b> DistrhoPlugin.hpp:117</div></div> |
