|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.9.1"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>DISTRHO Plugin Framework: distrho/DistrhoStandaloneUtils.hpp Source File</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">DISTRHO Plugin Framework
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.1 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">DistrhoStandaloneUtils.hpp</div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
- <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
- <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2012-2022 Filipe Coelho <falktx@falktx.com></span></div>
- <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
- <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
- <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * permission notice appear in all copies.</span></div>
- <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
- <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
- <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
- <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
- <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
- <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
- <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
- <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef DISTRHO_STANDALONE_UTILS_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define DISTRHO_STANDALONE_UTILS_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
- <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "src/DistrhoDefines.h"</span></div>
- <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
- <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <a class="code" href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div>
- <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
- <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * Standalone plugin related utilities */</span></div>
- <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> @defgroup StandalonePluginRelatedUtilities Plugin related utilities</span></div>
- <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> When the plugin is running as standalone and JACK is not available, a native audio handling is in place.</span></div>
- <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> It is a very simple handling, auto-connecting to the default audio interface for outputs.</span></div>
- <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> !!EXPERIMENTAL!!</span></div>
- <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> Still under development and testing.</span></div>
- <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> @{</span></div>
- <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> Check if the current standalone is using native audio methods.</span></div>
- <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> If this function returns false, you MUST NOT use any other function from this group.</span></div>
- <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#gae42de84169a5b578063b833caf5a5570"> 44</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#gae42de84169a5b578063b833caf5a5570">isUsingNativeAudio</a>() noexcept;</div>
- <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> Check if the current standalone supports audio input.</span></div>
- <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#ga13301901e329e098883c62de0972d9ec"> 49</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#ga13301901e329e098883c62de0972d9ec">supportsAudioInput</a>();</div>
- <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> Check if the current standalone supports dynamic buffer size changes.</span></div>
- <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#gae30b95b8622bdce705b5e7465548ed4c"> 54</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#gae30b95b8622bdce705b5e7465548ed4c">supportsBufferSizeChanges</a>();</div>
- <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> Check if the current standalone supports MIDI.</span></div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#gadbfa0c2cdcb4c114db1063651e97066e"> 59</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#gadbfa0c2cdcb4c114db1063651e97066e">supportsMIDI</a>();</div>
- <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> Check if the current standalone has audio input enabled.</span></div>
- <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#ga0a61814996c249f0010928afe976950a"> 64</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#ga0a61814996c249f0010928afe976950a">isAudioInputEnabled</a>();</div>
- <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> Check if the current standalone has MIDI enabled.</span></div>
- <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#ga14edff90e67fc028b106c7dc0888d1d3"> 69</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#ga14edff90e67fc028b106c7dc0888d1d3">isMIDIEnabled</a>();</div>
- <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> Get the current buffer size.</span></div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#gaeb5392c82fb90c8f58e07465503ce11b"> 74</a></span> uint <a class="code" href="group__StandalonePluginRelatedUtilities.html#gaeb5392c82fb90c8f58e07465503ce11b">getBufferSize</a>();</div>
- <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> Request permissions to use audio input.</span></div>
- <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> Only valid to call if audio input is supported but not currently enabled.</span></div>
- <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#gaa499fd42799f9d7479917549634c0226"> 80</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#gaa499fd42799f9d7479917549634c0226">requestAudioInput</a>();</div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> Request change to a new buffer size.</span></div>
- <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#ga448fb5c17b53116ff45716884b7a7635"> 85</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#ga448fb5c17b53116ff45716884b7a7635">requestBufferSizeChange</a>(uint newBufferSize);</div>
- <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> Request permissions to use MIDI.</span></div>
- <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> Only valid to call if MIDI is supported but not currently enabled.</span></div>
- <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="group__StandalonePluginRelatedUtilities.html#gac81794c2f59b4a1793ea25b73b76e5e3"> 91</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__StandalonePluginRelatedUtilities.html#gac81794c2f59b4a1793ea25b73b76e5e3">requestMIDI</a>();</div>
- <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/** @} */</span></div>
- <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div>
- <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">// -----------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
- <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <a class="code" href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div>
- <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
- <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif </span><span class="comment">// DISTRHO_STANDALONE_UTILS_HPP_INCLUDED</span></div>
- <div class="ttc" id="agroup__NamespaceMacros_html_ga3ff541a449593e069a29e92d21e38ef3"><div class="ttname"><a href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define END_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:949</div></div>
- <div class="ttc" id="agroup__NamespaceMacros_html_gac4cb97c393d20c28ba19365d844341cd"><div class="ttname"><a href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define START_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:943</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_ga0a61814996c249f0010928afe976950a"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#ga0a61814996c249f0010928afe976950a">isAudioInputEnabled</a></div><div class="ttdeci">bool isAudioInputEnabled()</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_ga13301901e329e098883c62de0972d9ec"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#ga13301901e329e098883c62de0972d9ec">supportsAudioInput</a></div><div class="ttdeci">bool supportsAudioInput()</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_ga14edff90e67fc028b106c7dc0888d1d3"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#ga14edff90e67fc028b106c7dc0888d1d3">isMIDIEnabled</a></div><div class="ttdeci">bool isMIDIEnabled()</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_ga448fb5c17b53116ff45716884b7a7635"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#ga448fb5c17b53116ff45716884b7a7635">requestBufferSizeChange</a></div><div class="ttdeci">bool requestBufferSizeChange(uint newBufferSize)</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_gaa499fd42799f9d7479917549634c0226"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#gaa499fd42799f9d7479917549634c0226">requestAudioInput</a></div><div class="ttdeci">bool requestAudioInput()</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_gac81794c2f59b4a1793ea25b73b76e5e3"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#gac81794c2f59b4a1793ea25b73b76e5e3">requestMIDI</a></div><div class="ttdeci">bool requestMIDI()</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_gadbfa0c2cdcb4c114db1063651e97066e"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#gadbfa0c2cdcb4c114db1063651e97066e">supportsMIDI</a></div><div class="ttdeci">bool supportsMIDI()</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_gae30b95b8622bdce705b5e7465548ed4c"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#gae30b95b8622bdce705b5e7465548ed4c">supportsBufferSizeChanges</a></div><div class="ttdeci">bool supportsBufferSizeChanges()</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_gae42de84169a5b578063b833caf5a5570"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#gae42de84169a5b578063b833caf5a5570">isUsingNativeAudio</a></div><div class="ttdeci">bool isUsingNativeAudio() noexcept</div></div>
- <div class="ttc" id="agroup__StandalonePluginRelatedUtilities_html_gaeb5392c82fb90c8f58e07465503ce11b"><div class="ttname"><a href="group__StandalonePluginRelatedUtilities.html#gaeb5392c82fb90c8f58e07465503ce11b">getBufferSize</a></div><div class="ttdeci">uint getBufferSize()</div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
- </small></address>
- </body>
- </html>
|