annotate code-doc/plugins_8cpp.html @ 128:817c3988afc7 website tip

Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
rev   line source
cannam@50 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@50 2 <html xmlns="http://www.w3.org/1999/xhtml">
cannam@50 3 <head>
cannam@50 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
cannam@0 5 <title>VampPluginSDK: plugins.cpp File Reference</title>
cannam@50 6
cannam@50 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
cannam@50 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
cannam@50 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
cannam@50 10 <script type="text/javascript" src="jquery.js"></script>
cannam@50 11 <script type="text/javascript" src="resize.js"></script>
cannam@50 12 <script type="text/javascript" src="navtree.js"></script>
cannam@50 13 <script type="text/javascript">
cannam@50 14 $(document).ready(initResizable);
cannam@50 15 </script>
cannam@50 16
cannam@50 17
cannam@50 18 </head>
cannam@50 19 <body>
cannam@50 20 <div id="top"><!-- do not remove this div! -->
cannam@50 21
cannam@50 22
cannam@50 23 <div id="titlearea">
cannam@50 24 <table cellspacing="0" cellpadding="0">
cannam@50 25 <tbody>
cannam@50 26 <tr style="height: 56px;">
cannam@50 27
cannam@50 28
cannam@50 29 <td style="padding-left: 0.5em;">
cannam@50 30 <div id="projectname">VampPluginSDK
cannam@50 31 &#160;<span id="projectnumber">2.1</span>
cannam@50 32 </div>
cannam@50 33
cannam@50 34 </td>
cannam@50 35
cannam@50 36
cannam@50 37
cannam@50 38 </tr>
cannam@50 39 </tbody>
cannam@50 40 </table>
cannam@50 41 </div>
cannam@50 42
cannam@50 43 <!-- Generated by Doxygen 1.7.5.1 -->
cannam@50 44 <div id="navrow1" class="tabs">
cannam@50 45 <ul class="tablist">
cannam@50 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
cannam@0 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 48 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 49 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@0 50 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 51 </ul>
cannam@0 52 </div>
cannam@50 53 <div id="navrow2" class="tabs2">
cannam@50 54 <ul class="tablist">
cannam@50 55 <li><a href="files.html"><span>File&#160;List</span></a></li>
cannam@50 56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
cannam@35 57 </ul>
cannam@35 58 </div>
cannam@50 59 </div>
cannam@50 60 <div id="side-nav" class="ui-resizable side-nav-resizable">
cannam@50 61 <div id="nav-tree">
cannam@50 62 <div id="nav-tree-contents">
cannam@50 63 </div>
cannam@50 64 </div>
cannam@50 65 <div id="splitbar" style="-moz-user-select:none;"
cannam@50 66 class="ui-resizable-handle">
cannam@0 67 </div>
cannam@0 68 </div>
cannam@50 69 <script type="text/javascript">
cannam@50 70 initNavTree('plugins_8cpp.html','');
cannam@50 71 </script>
cannam@50 72 <div id="doc-content">
cannam@50 73 <div class="header">
cannam@50 74 <div class="summary">
cannam@50 75 <a href="#func-members">Functions</a> &#124;
cannam@50 76 <a href="#var-members">Variables</a> </div>
cannam@50 77 <div class="headertitle">
cannam@50 78 <div class="title">plugins.cpp File Reference</div> </div>
cannam@50 79 </div>
cannam@0 80 <div class="contents">
cannam@0 81
cannam@50 82 <p><a href="plugins_8cpp_source.html">Go to the source code of this file.</a></p>
cannam@50 83 <table class="memberdecls">
cannam@50 84 <tr><td colspan="2"><h2><a name="func-members"></a>
cannam@50 85 Functions</h2></td></tr>
cannam@50 86 <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a> (unsigned int version, unsigned int index)</td></tr>
cannam@50 87 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library. <a href="#abb0fd6db76ddd39698bc370e0fd0ea78"></a><br/></td></tr>
cannam@50 88 <tr><td colspan="2"><h2><a name="var-members"></a>
cannam@50 89 Variables</h2></td></tr>
cannam@50 90 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
cannam@50 91 &lt; <a class="el" href="classZeroCrossing.html">ZeroCrossing</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a></td></tr>
cannam@50 92 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
cannam@50 93 &lt; <a class="el" href="classSpectralCentroid.html">SpectralCentroid</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a></td></tr>
cannam@50 94 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
cannam@50 95 &lt; <a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a></td></tr>
cannam@50 96 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
cannam@50 97 &lt; <a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a></td></tr>
cannam@50 98 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
cannam@50 99 &lt; <a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a></td></tr>
cannam@50 100 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
cannam@50 101 &lt; <a class="el" href="classPowerSpectrum.html">PowerSpectrum</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a></td></tr>
cannam@0 102 </table>
cannam@50 103 <hr/><h2>Function Documentation</h2>
cannam@50 104 <a class="anchor" id="abb0fd6db76ddd39698bc370e0fd0ea78"></a><!-- doxytag: member="plugins.cpp::vampGetPluginDescriptor" ref="abb0fd6db76ddd39698bc370e0fd0ea78" args="(unsigned int version, unsigned int index)" -->
cannam@0 105 <div class="memitem">
cannam@0 106 <div class="memproto">
cannam@0 107 <table class="memname">
cannam@0 108 <tr>
cannam@50 109 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vampGetPluginDescriptor </td>
cannam@0 110 <td>(</td>
cannam@50 111 <td class="paramtype">unsigned int&#160;</td>
cannam@50 112 <td class="paramname"><em>hostApiVersion</em>, </td>
cannam@0 113 </tr>
cannam@0 114 <tr>
cannam@0 115 <td class="paramkey"></td>
cannam@0 116 <td></td>
cannam@50 117 <td class="paramtype">unsigned int&#160;</td>
cannam@50 118 <td class="paramname"><em>index</em>&#160;</td>
cannam@0 119 </tr>
cannam@0 120 <tr>
cannam@0 121 <td></td>
cannam@0 122 <td>)</td>
cannam@50 123 <td></td><td></td>
cannam@0 124 </tr>
cannam@0 125 </table>
cannam@0 126 </div>
cannam@0 127 <div class="memdoc">
cannam@0 128
cannam@50 129 <p>Get the descriptor for a given plugin index in this library. </p>
cannam@50 130 <p>Return NULL if the index is outside the range of valid indices for this plugin library.</p>
cannam@50 131 <p>The hostApiVersion argument tells the library code the highest <a class="el" href="namespaceVamp.html">Vamp</a> API version supported by the host. The function should return a plugin descriptor compatible with the highest API version supported by the library that is no higher than that supported by the host. Provided the descriptor has the correct vampApiVersion field for its actual compatibility level, the host should be able to do the right thing with it: use it if possible, discard it otherwise.</p>
cannam@50 132 <p>This is the only symbol that a <a class="el" href="namespaceVamp.html">Vamp</a> plugin actually needs to export from its shared object; all others can be hidden. See the accompanying documentation for notes on how to achieve this with certain compilers. </p>
cannam@0 133
cannam@50 134 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00054">54</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
cannam@50 135
cannam@50 136 <p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>
cannam@0 137
cannam@0 138 </div>
cannam@50 139 </div>
cannam@50 140 <hr/><h2>Variable Documentation</h2>
cannam@50 141 <a class="anchor" id="a01871ad1ab2bb64e2c53fe5cce19b780"></a><!-- doxytag: member="plugins.cpp::zeroCrossingAdapter" ref="a01871ad1ab2bb64e2c53fe5cce19b780" args="" -->
cannam@0 142 <div class="memitem">
cannam@0 143 <div class="memproto">
cannam@0 144 <table class="memname">
cannam@0 145 <tr>
cannam@50 146 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classZeroCrossing.html">ZeroCrossing</a>&gt; <a class="el" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a><code> [static]</code></td>
cannam@0 147 </tr>
cannam@0 148 </table>
cannam@0 149 </div>
cannam@0 150 <div class="memdoc">
cannam@0 151
cannam@50 152 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00047">47</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
cannam@0 153
cannam@0 154 </div>
cannam@50 155 </div>
cannam@50 156 <a class="anchor" id="ac96bdfb6356a153341b29b43c4961cd5"></a><!-- doxytag: member="plugins.cpp::spectralCentroidAdapter" ref="ac96bdfb6356a153341b29b43c4961cd5" args="" -->
cannam@0 157 <div class="memitem">
cannam@0 158 <div class="memproto">
cannam@0 159 <table class="memname">
cannam@0 160 <tr>
cannam@50 161 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classSpectralCentroid.html">SpectralCentroid</a>&gt; <a class="el" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a><code> [static]</code></td>
cannam@0 162 </tr>
cannam@0 163 </table>
cannam@0 164 </div>
cannam@0 165 <div class="memdoc">
cannam@0 166
cannam@50 167 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00048">48</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
cannam@0 168
cannam@0 169 </div>
cannam@50 170 </div>
cannam@50 171 <a class="anchor" id="acee3823cb6a43281a2ecf923b69613dd"></a><!-- doxytag: member="plugins.cpp::percussionOnsetAdapter" ref="acee3823cb6a43281a2ecf923b69613dd" args="" -->
cannam@0 172 <div class="memitem">
cannam@0 173 <div class="memproto">
cannam@0 174 <table class="memname">
cannam@0 175 <tr>
cannam@50 176 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a>&gt; <a class="el" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a><code> [static]</code></td>
cannam@0 177 </tr>
cannam@0 178 </table>
cannam@0 179 </div>
cannam@0 180 <div class="memdoc">
cannam@0 181
cannam@50 182 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00049">49</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
cannam@21 183
cannam@21 184 </div>
cannam@50 185 </div>
cannam@50 186 <a class="anchor" id="a937de36d22633261716032570064a4be"></a><!-- doxytag: member="plugins.cpp::fixedTempoAdapter" ref="a937de36d22633261716032570064a4be" args="" -->
cannam@21 187 <div class="memitem">
cannam@21 188 <div class="memproto">
cannam@21 189 <table class="memname">
cannam@21 190 <tr>
cannam@50 191 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a>&gt; <a class="el" href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a><code> [static]</code></td>
cannam@21 192 </tr>
cannam@21 193 </table>
cannam@21 194 </div>
cannam@21 195 <div class="memdoc">
cannam@21 196
cannam@50 197 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00050">50</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
cannam@0 198
cannam@0 199 </div>
cannam@50 200 </div>
cannam@50 201 <a class="anchor" id="a4e60bb6a99451da5deb18b969e6b16cd"></a><!-- doxytag: member="plugins.cpp::amplitudeAdapter" ref="a4e60bb6a99451da5deb18b969e6b16cd" args="" -->
cannam@0 202 <div class="memitem">
cannam@0 203 <div class="memproto">
cannam@0 204 <table class="memname">
cannam@0 205 <tr>
cannam@50 206 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a>&gt; <a class="el" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a><code> [static]</code></td>
cannam@0 207 </tr>
cannam@0 208 </table>
cannam@0 209 </div>
cannam@0 210 <div class="memdoc">
cannam@0 211
cannam@50 212 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00051">51</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
cannam@21 213
cannam@21 214 </div>
cannam@50 215 </div>
cannam@50 216 <a class="anchor" id="a77810f485caaae4a8b2303496046d3d7"></a><!-- doxytag: member="plugins.cpp::powerSpectrum" ref="a77810f485caaae4a8b2303496046d3d7" args="" -->
cannam@21 217 <div class="memitem">
cannam@21 218 <div class="memproto">
cannam@21 219 <table class="memname">
cannam@21 220 <tr>
cannam@50 221 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classPowerSpectrum.html">PowerSpectrum</a>&gt; <a class="el" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a><code> [static]</code></td>
cannam@21 222 </tr>
cannam@21 223 </table>
cannam@21 224 </div>
cannam@21 225 <div class="memdoc">
cannam@21 226
cannam@50 227 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00052">52</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
cannam@0 228
cannam@0 229 </div>
cannam@0 230 </div>
cannam@50 231 </div>
cannam@50 232 </div>
cannam@50 233 <div id="nav-path" class="navpath">
cannam@50 234 <ul>
cannam@50 235 <li class="navelem"><a class="el" href="plugins_8cpp.html">plugins.cpp</a> </li>
cannam@50 236
cannam@50 237 <li class="footer">Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
cannam@50 238 <a href="http://www.doxygen.org/index.html">
cannam@50 239 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
cannam@50 240 </ul>
cannam@50 241 </div>
cannam@50 242
cannam@50 243
cannam@0 244 </body>
cannam@0 245 </html>