Mercurial > hg > vamp-docs

annotate code-docs/plugguard_8h.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@1 8 <title>VampPluginSDK: plugguard.h File Reference</title>
Chris@1 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@1 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@1 15 <script type="text/javascript" src="navtree.js"></script>
Chris@1 16 <script type="text/javascript">
Chris@1 17 $(document).ready(initResizable);
Chris@1 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 20 </head>
Chris@1 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@1 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@1 30 </div>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </tbody>
Chris@1 34 </table>
Chris@1 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@1 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 48 <div id="nav-tree">
Chris@1 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@1 51 </div>
Chris@1 52 </div>
Chris@1 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 54 class="ui-resizable-handle">
Chris@1 55 </div>
Chris@1 56 </div>
Chris@1 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('plugguard_8h.html','');});
Chris@1 59 </script>
Chris@1 60 <div id="doc-content">
Chris@1 61 <div class="header">
Chris@1 62 <div class="summary">
Chris@6 63 <a href="#define-members">Macros</a> </div>
Chris@1 64 <div class="headertitle">
Chris@1 65 <div class="title">plugguard.h File Reference</div> </div>
Chris@3 66 </div><!--header-->
Chris@1 67 <div class="contents">
Chris@6 68 <div class="textblock"><div class="dynheader">
Chris@6 69 This graph shows which files directly or indirectly include this file:</div>
Chris@6 70 <div class="dyncontent">
Chris@6 71 <div class="center"><img src="plugguard_8h__dep__incl.png" border="0" usemap="#plugguard_8hdep" alt=""/></div>
Chris@6 72 <map name="plugguard_8hdep" id="plugguard_8hdep">
Chris@6 73 <area shape="rect" id="node2" href="FFT_8h.html" title="FFT.h" alt="" coords="483,79,534,104"/>
Chris@6 74 <area shape="rect" id="node4" href="vamp-sdk_2PluginBase_8h.html" title="PluginBase.h" alt="" coords="366,79,459,104"/>
Chris@6 75 <area shape="rect" id="node5" href="vamp-sdk_2Plugin_8h.html" title="Plugin.h" alt="" coords="794,152,861,177"/>
Chris@6 76 <area shape="rect" id="node6" href="PluginAdapter_8h.html" title="PluginAdapter.h" alt="" coords="1321,225,1429,251"/>
Chris@6 77 <area shape="rect" id="node31" href="vamp-sdk_2RealTime_8h.html" title="RealTime.h" alt="" coords="559,79,643,104"/>
Chris@6 78 <area shape="rect" id="node3" href="vamp-sdk_8h.html" title="vamp&#45;sdk.h" alt="" coords="369,225,456,251"/>
Chris@6 79 <area shape="rect" id="node30" href="vamp-hostsdk_2PluginBase_8h.html" title="PluginBase.h" alt="" coords="110,152,203,177"/>
Chris@6 80 <area shape="rect" id="node8" href="vamp-hostsdk_2Plugin_8h.html" title="Plugin.h" alt="" coords="589,225,655,251"/>
Chris@6 81 <area shape="rect" id="node18" href="AmplitudeFollower_8h.html" title="AmplitudeFollower.h" alt="" coords="1454,225,1587,251"/>
Chris@6 82 <area shape="rect" id="node20" href="FixedTempoEstimator_8h.html" title="FixedTempoEstimator.h" alt="" coords="1611,225,1761,251"/>
Chris@6 83 <area shape="rect" id="node22" href="PercussionOnsetDetector_8h.html" title="PercussionOnsetDetector.h" alt="" coords="1126,225,1297,251"/>
Chris@6 84 <area shape="rect" id="node24" href="ZeroCrossing_8h.html" title="ZeroCrossing.h" alt="" coords="705,225,811,251"/>
Chris@6 85 <area shape="rect" id="node26" href="SpectralCentroid_8h.html" title="SpectralCentroid.h" alt="" coords="835,225,959,251"/>
Chris@6 86 <area shape="rect" id="node28" href="PowerSpectrum_8h.html" title="PowerSpectrum.h" alt="" coords="983,225,1101,251"/>
Chris@6 87 <area shape="rect" id="node7" href="plugins_8cpp.html" title="plugins.cpp" alt="" coords="1354,299,1439,324"/>
Chris@6 88 <area shape="rect" id="node9" href="PluginWrapper_8h.html" title="PluginWrapper.h" alt="" coords="448,299,559,324"/>
Chris@6 89 <area shape="rect" id="node11" href="vamp-hostsdk_8h.html" title="vamp&#45;hostsdk.h" alt="" coords="448,445,559,471"/>
Chris@6 90 <area shape="rect" id="node17" href="PluginHostAdapter_8h.html" title="PluginHostAdapter.h" alt="" coords="1043,372,1177,397"/>
Chris@6 91 <area shape="rect" id="node10" href="PluginBufferingAdapter_8h.html" title="PluginBufferingAdapter.h" alt="" coords="251,372,409,397"/>
Chris@6 92 <area shape="rect" id="node12" href="PluginChannelAdapter_8h.html" title="PluginChannelAdapter.h" alt="" coords="483,372,638,397"/>
Chris@6 93 <area shape="rect" id="node13" href="PluginInputDomainAdapter_8h.html" title="PluginInputDomainAdapter.h" alt="" coords="841,372,1019,397"/>
Chris@6 94 <area shape="rect" id="node15" href="PluginLoader_8h.html" title="PluginLoader.h" alt="" coords="713,372,816,397"/>
Chris@6 95 <area shape="rect" id="node16" href="PluginSummarisingAdapter_8h.html" title="PluginSummarisingAdapter.h" alt="" coords="46,372,227,397"/>
Chris@6 96 <area shape="rect" id="node14" href="vamp-simple-host_8cpp.html" title="vamp&#45;simple&#45;host.cpp" alt="" coords="857,445,1003,471"/>
Chris@6 97 <area shape="rect" id="node19" href="AmplitudeFollower_8cpp.html" title="AmplitudeFollower.cpp" alt="" coords="1463,299,1610,324"/>
Chris@6 98 <area shape="rect" id="node21" href="FixedTempoEstimator_8cpp.html" title="FixedTempoEstimator.cpp" alt="" coords="1634,299,1797,324"/>
Chris@6 99 <area shape="rect" id="node23" href="PercussionOnsetDetector_8cpp.html" title="PercussionOnsetDetector.cpp" alt="" coords="1146,299,1330,324"/>
Chris@6 100 <area shape="rect" id="node25" href="ZeroCrossing_8cpp.html" title="ZeroCrossing.cpp" alt="" coords="685,299,804,324"/>
Chris@6 101 <area shape="rect" id="node27" href="SpectralCentroid_8cpp.html" title="SpectralCentroid.cpp" alt="" coords="828,299,965,324"/>
Chris@6 102 <area shape="rect" id="node29" href="PowerSpectrum_8cpp.html" title="PowerSpectrum.cpp" alt="" coords="989,299,1121,324"/>
Chris@6 103 <area shape="rect" id="node32" href="vamp-hostsdk_2RealTime_8h.html" title="RealTime.h" alt="" coords="556,152,640,177"/>
Chris@6 104 </map>
Chris@6 105 </div>
Chris@6 106 </div>
Chris@1 107 <p><a href="plugguard_8h_source.html">Go to the source code of this file.</a></p>
Chris@1 108 <table class="memberdecls">
Chris@6 109 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Chris@6 110 Macros</h2></td></tr>
Chris@3 111 <tr class="memitem:a3bf4e97f131677e5e1505a7a9582d68a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#a3bf4e97f131677e5e1505a7a9582d68a">_VAMP_IN_PLUGINSDK</a>&#160;&#160;&#160;1</td></tr>
Chris@6 112 <tr class="memdesc:a3bf4e97f131677e5e1505a7a9582d68a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normal usage should be: <a href="#a3bf4e97f131677e5e1505a7a9582d68a">More...</a><br /></td></tr>
Chris@6 113 <tr class="separator:a3bf4e97f131677e5e1505a7a9582d68a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 114 <tr class="memitem:a9b7a8e1ac1c91366bec5f2f33c137a2f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#a9b7a8e1ac1c91366bec5f2f33c137a2f">VAMP_SDK_VERSION</a>&#160;&#160;&#160;&quot;2.7&quot;</td></tr>
Chris@6 115 <tr class="separator:a9b7a8e1ac1c91366bec5f2f33c137a2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 116 <tr class="memitem:ab5f7da6acf45065a6c7b7cd38a0bf588"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#ab5f7da6acf45065a6c7b7cd38a0bf588">VAMP_SDK_MAJOR_VERSION</a>&#160;&#160;&#160;2</td></tr>
Chris@6 117 <tr class="separator:ab5f7da6acf45065a6c7b7cd38a0bf588"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 118 <tr class="memitem:ad5eef1e2154b42769cd642d2a1d42257"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#ad5eef1e2154b42769cd642d2a1d42257">VAMP_SDK_MINOR_VERSION</a>&#160;&#160;&#160;7</td></tr>
Chris@6 119 <tr class="separator:ad5eef1e2154b42769cd642d2a1d42257"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 120 <tr class="memitem:a1a2724ea453971288d3218e4eab3072c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(h)</td></tr>
Chris@6 121 <tr class="separator:a1a2724ea453971288d3218e4eab3072c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 122 <tr class="memitem:ac879bb1077ecc6132ea3581ef9033753"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(h)</td></tr>
Chris@6 123 <tr class="separator:ac879bb1077ecc6132ea3581ef9033753"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 124 </table>
Chris@6 125 <h2 class="groupheader">Macro Definition Documentation</h2>
Chris@6 126 <a id="a3bf4e97f131677e5e1505a7a9582d68a"></a>
Chris@6 127 <h2 class="memtitle"><span class="permalink"><a href="#a3bf4e97f131677e5e1505a7a9582d68a">&#9670;&nbsp;</a></span>_VAMP_IN_PLUGINSDK</h2>
Chris@6 128
Chris@1 129 <div class="memitem">
Chris@1 130 <div class="memproto">
Chris@1 131 <table class="memname">
Chris@1 132 <tr>
Chris@6 133 <td class="memname">#define _VAMP_IN_PLUGINSDK&#160;&#160;&#160;1</td>
Chris@1 134 </tr>
Chris@1 135 </table>
Chris@6 136 </div><div class="memdoc">
Chris@1 137
Chris@1 138 <p>Normal usage should be: </p>
Chris@1 139 <ul>
Chris@1 140 <li>Plugins include <a class="el" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a> or <a class="el" href="vamp-sdk_2PluginBase_8h.html">vamp-sdk/PluginBase.h</a>. These files include this header, which specifies an appropriate namespace for the plugin classes to avoid any risk of conflict with non-plugin class implementations in the host on load.</li>
Chris@1 141 <li>Hosts include <a class="el" href="vamp-hostsdk_2Plugin_8h.html">vamp-hostsdk/Plugin.h</a>, <a class="el" href="vamp-hostsdk_2PluginBase_8h.html">vamp-hostsdk/PluginBase.h</a>, vamp-hostsdk/PluginHostAdapter, <a class="el" href="PluginLoader_8h.html">vamp-hostsdk/PluginLoader.h</a> etc. These files include <a class="el" href="hostguard_8h.html">vamp-hostsdk/hostguard.h</a>, which makes a note that we are in a host. A file such as <a class="el" href="vamp-hostsdk_2Plugin_8h.html">vamp-hostsdk/Plugin.h</a> then simply includes <a class="el" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a>, and this guard header takes notice of the fact that it has been included from a host and leaves the plugin namespace unset.</li>
Chris@1 142 </ul>
Chris@1 143 <p>Problems will occur when a host includes files directly from the vamp-sdk directory. There are two reasons this might happen: mistake, perhaps owing to ignorance of the fact that this isn't allowed (particularly since it was the normal mechanism in v1 of the SDK); and a wish to incorporate plugin code directly into the host rather than having to load it.</p>
Chris@1 144 <p>What if the host does include a vamp-sdk header by mistake? We can catch it if it's included before something from vamp-hostsdk. If it's included after something from vamp-hostsdk, it will work OK anyway. The remaining problem case is where nothing from vamp-hostsdk is included in the same file. We can't catch that. </p>
Chris@1 145
Chris@6 146 <p class="definition">Definition at line <a class="el" href="plugguard_8h_source.html#l00072">72</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@1 147
Chris@1 148 </div>
Chris@1 149 </div>
Chris@6 150 <a id="a9b7a8e1ac1c91366bec5f2f33c137a2f"></a>
Chris@6 151 <h2 class="memtitle"><span class="permalink"><a href="#a9b7a8e1ac1c91366bec5f2f33c137a2f">&#9670;&nbsp;</a></span>VAMP_SDK_VERSION</h2>
Chris@6 152
Chris@1 153 <div class="memitem">
Chris@1 154 <div class="memproto">
Chris@1 155 <table class="memname">
Chris@1 156 <tr>
Chris@6 157 <td class="memname">#define VAMP_SDK_VERSION&#160;&#160;&#160;&quot;2.7&quot;</td>
Chris@3 158 </tr>
Chris@3 159 </table>
Chris@6 160 </div><div class="memdoc">
Chris@3 161
Chris@6 162 <p class="definition">Definition at line <a class="el" href="plugguard_8h_source.html#l00074">74</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@3 163
Chris@6 164 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00140">main()</a>.</p>
Chris@3 165
Chris@3 166 </div>
Chris@3 167 </div>
Chris@6 168 <a id="ab5f7da6acf45065a6c7b7cd38a0bf588"></a>
Chris@6 169 <h2 class="memtitle"><span class="permalink"><a href="#ab5f7da6acf45065a6c7b7cd38a0bf588">&#9670;&nbsp;</a></span>VAMP_SDK_MAJOR_VERSION</h2>
Chris@6 170
Chris@3 171 <div class="memitem">
Chris@3 172 <div class="memproto">
Chris@3 173 <table class="memname">
Chris@3 174 <tr>
Chris@6 175 <td class="memname">#define VAMP_SDK_MAJOR_VERSION&#160;&#160;&#160;2</td>
Chris@3 176 </tr>
Chris@3 177 </table>
Chris@6 178 </div><div class="memdoc">
Chris@3 179
Chris@6 180 <p class="definition">Definition at line <a class="el" href="plugguard_8h_source.html#l00075">75</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@3 181
Chris@3 182 </div>
Chris@3 183 </div>
Chris@6 184 <a id="ad5eef1e2154b42769cd642d2a1d42257"></a>
Chris@6 185 <h2 class="memtitle"><span class="permalink"><a href="#ad5eef1e2154b42769cd642d2a1d42257">&#9670;&nbsp;</a></span>VAMP_SDK_MINOR_VERSION</h2>
Chris@6 186
Chris@3 187 <div class="memitem">
Chris@3 188 <div class="memproto">
Chris@3 189 <table class="memname">
Chris@3 190 <tr>
Chris@6 191 <td class="memname">#define VAMP_SDK_MINOR_VERSION&#160;&#160;&#160;7</td>
Chris@3 192 </tr>
Chris@3 193 </table>
Chris@6 194 </div><div class="memdoc">
Chris@3 195
Chris@6 196 <p class="definition">Definition at line <a class="el" href="plugguard_8h_source.html#l00076">76</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@3 197
Chris@3 198 </div>
Chris@3 199 </div>
Chris@6 200 <a id="a1a2724ea453971288d3218e4eab3072c"></a>
Chris@6 201 <h2 class="memtitle"><span class="permalink"><a href="#a1a2724ea453971288d3218e4eab3072c">&#9670;&nbsp;</a></span>_VAMP_SDK_PLUGSPACE_BEGIN</h2>
Chris@6 202
Chris@3 203 <div class="memitem">
Chris@3 204 <div class="memproto">
Chris@3 205 <table class="memname">
Chris@3 206 <tr>
Chris@6 207 <td class="memname">#define _VAMP_SDK_PLUGSPACE_BEGIN</td>
Chris@1 208 <td>(</td>
Chris@1 209 <td class="paramtype">&#160;</td>
Chris@1 210 <td class="paramname">h</td><td>)</td>
Chris@1 211 <td></td>
Chris@1 212 </tr>
Chris@1 213 </table>
Chris@6 214 </div><div class="memdoc">
Chris@1 215
Chris@6 216 <p class="definition">Definition at line <a class="el" href="plugguard_8h_source.html#l00079">79</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@1 217
Chris@1 218 </div>
Chris@1 219 </div>
Chris@6 220 <a id="ac879bb1077ecc6132ea3581ef9033753"></a>
Chris@6 221 <h2 class="memtitle"><span class="permalink"><a href="#ac879bb1077ecc6132ea3581ef9033753">&#9670;&nbsp;</a></span>_VAMP_SDK_PLUGSPACE_END</h2>
Chris@6 222
Chris@1 223 <div class="memitem">
Chris@1 224 <div class="memproto">
Chris@1 225 <table class="memname">
Chris@1 226 <tr>
Chris@6 227 <td class="memname">#define _VAMP_SDK_PLUGSPACE_END</td>
Chris@1 228 <td>(</td>
Chris@1 229 <td class="paramtype">&#160;</td>
Chris@1 230 <td class="paramname">h</td><td>)</td>
Chris@1 231 <td></td>
Chris@1 232 </tr>
Chris@1 233 </table>
Chris@6 234 </div><div class="memdoc">
Chris@1 235
Chris@6 236 <p class="definition">Definition at line <a class="el" href="plugguard_8h_source.html#l00080">80</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@6 237
Chris@6 238 <p class="reference">Referenced by <a class="el" href="PluginAdapter_8h_source.html#l00102">Vamp::PluginAdapter&lt; P &gt;::createPlugin()</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00248">Vamp::PluginBase::selectProgram()</a>.</p>
Chris@1 239
Chris@1 240 </div>
Chris@1 241 </div>
Chris@3 242 </div><!-- contents -->
Chris@6 243 </div><!-- doc-content -->
Chris@6 244 <!-- start footer part -->
Chris@6 245 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 246 <ul>
Chris@6 247 <li class="navelem"><a class="el" href="dir_8661d6ced9d80e9e8c7982a58cd73404.html">vamp-sdk</a></li><li class="navelem"><a class="el" href="plugguard_8h.html">plugguard.h</a></li>
Chris@6 248 <li class="footer">Generated by
Chris@6 249 <a href="http://www.doxygen.org/index.html">
Chris@6 250 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 251 </ul>
Chris@1 252 </div>
Chris@1 253 </body>
Chris@1 254 </html>