Mercurial > hg > vamp-website

comparison code-doc/plugins_8cpp.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: plugins.cpp File Reference</title> 3 <title>VampPluginSDK: plugins.cpp File Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css"> 5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
38 38
39 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br> 39 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br>
40 &lt; <a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#cee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a></td></tr> 40 &lt; <a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#cee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a></td></tr>
41 41
42 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br> 42 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br>
43 &lt; <a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#937de36d22633261716032570064a4be">fixedTempoAdapter</a></td></tr>
44
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br>
43 &lt; <a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a></td></tr> 46 &lt; <a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a></td></tr>
47
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br>
49 &lt; <a class="el" href="classPowerSpectrum.html">PowerSpectrum</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#77810f485caaae4a8b2303496046d3d7">powerSpectrum</a></td></tr>
44 50
45 </table> 51 </table>
46 <hr><h2>Function Documentation</h2> 52 <hr><h2>Function Documentation</h2>
47 <a class="anchor" name="bb0fd6db76ddd39698bc370e0fd0ea78"></a><!-- doxytag: member="plugins.cpp::vampGetPluginDescriptor" ref="bb0fd6db76ddd39698bc370e0fd0ea78" args="(unsigned int version, unsigned int index)" --> 53 <a class="anchor" name="bb0fd6db76ddd39698bc370e0fd0ea78"></a><!-- doxytag: member="plugins.cpp::vampGetPluginDescriptor" ref="bb0fd6db76ddd39698bc370e0fd0ea78" args="(unsigned int version, unsigned int index)" -->
48 <div class="memitem"> 54 <div class="memitem">
61 <td class="paramname"> <em>index</em></td><td>&nbsp;</td> 67 <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
62 </tr> 68 </tr>
63 <tr> 69 <tr>
64 <td></td> 70 <td></td>
65 <td>)</td> 71 <td>)</td>
66 <td></td><td></td><td width="100%"></td> 72 <td></td><td></td><td></td>
67 </tr> 73 </tr>
68 </table> 74 </table>
69 </div> 75 </div>
70 <div class="memdoc"> 76 <div class="memdoc">
71 77
72 <p> 78 <p>
73 Get the descriptor for a given plugin index in this library. 79 Get the descriptor for a given plugin index in this library.
74 <p> 80 <p>
75 Return NULL if the index is outside the range of valid indices for this plugin library.<p> 81 Return NULL if the index is outside the range of valid indices for this plugin library.<p>
76 The hostApiVersion argument tells the library code the highest <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">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> 82 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>
77 This is the only symbol that a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">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. 83 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.
78 <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> 84 <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>
79 85
80 <p>References <a class="el" href="PluginAdapter_8cpp-source.html#l00138">Vamp::PluginAdapterBase::getDescriptor()</a>.</p> 86 <p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>
81 87
82 </div> 88 </div>
83 </div><p> 89 </div><p>
84 <hr><h2>Variable Documentation</h2> 90 <hr><h2>Variable Documentation</h2>
85 <a class="anchor" name="01871ad1ab2bb64e2c53fe5cce19b780"></a><!-- doxytag: member="plugins.cpp::zeroCrossingAdapter" ref="01871ad1ab2bb64e2c53fe5cce19b780" args="" --> 91 <a class="anchor" name="01871ad1ab2bb64e2c53fe5cce19b780"></a><!-- doxytag: member="plugins.cpp::zeroCrossingAdapter" ref="01871ad1ab2bb64e2c53fe5cce19b780" args="" -->
93 </div> 99 </div>
94 <div class="memdoc"> 100 <div class="memdoc">
95 101
96 <p> 102 <p>
97 103
98 <p>Definition at line <a class="el" href="plugins_8cpp-source.html#l00045">45</a> of file <a class="el" href="plugins_8cpp-source.html">plugins.cpp</a>.</p> 104 <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>
99 105
100 </div> 106 </div>
101 </div><p> 107 </div><p>
102 <a class="anchor" name="c96bdfb6356a153341b29b43c4961cd5"></a><!-- doxytag: member="plugins.cpp::spectralCentroidAdapter" ref="c96bdfb6356a153341b29b43c4961cd5" args="" --> 108 <a class="anchor" name="c96bdfb6356a153341b29b43c4961cd5"></a><!-- doxytag: member="plugins.cpp::spectralCentroidAdapter" ref="c96bdfb6356a153341b29b43c4961cd5" args="" -->
103 <div class="memitem"> 109 <div class="memitem">
110 </div> 116 </div>
111 <div class="memdoc"> 117 <div class="memdoc">
112 118
113 <p> 119 <p>
114 120
115 <p>Definition at line <a class="el" href="plugins_8cpp-source.html#l00046">46</a> of file <a class="el" href="plugins_8cpp-source.html">plugins.cpp</a>.</p> 121 <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>
116 122
117 </div> 123 </div>
118 </div><p> 124 </div><p>
119 <a class="anchor" name="cee3823cb6a43281a2ecf923b69613dd"></a><!-- doxytag: member="plugins.cpp::percussionOnsetAdapter" ref="cee3823cb6a43281a2ecf923b69613dd" args="" --> 125 <a class="anchor" name="cee3823cb6a43281a2ecf923b69613dd"></a><!-- doxytag: member="plugins.cpp::percussionOnsetAdapter" ref="cee3823cb6a43281a2ecf923b69613dd" args="" -->
120 <div class="memitem"> 126 <div class="memitem">
127 </div> 133 </div>
128 <div class="memdoc"> 134 <div class="memdoc">
129 135
130 <p> 136 <p>
131 137
132 <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> 138 <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>
139
140 </div>
141 </div><p>
142 <a class="anchor" name="937de36d22633261716032570064a4be"></a><!-- doxytag: member="plugins.cpp::fixedTempoAdapter" ref="937de36d22633261716032570064a4be" args="" -->
143 <div class="memitem">
144 <div class="memproto">
145 <table class="memname">
146 <tr>
147 <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#937de36d22633261716032570064a4be">fixedTempoAdapter</a><code> [static]</code> </td>
148 </tr>
149 </table>
150 </div>
151 <div class="memdoc">
152
153 <p>
154
155 <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>
133 156
134 </div> 157 </div>
135 </div><p> 158 </div><p>
136 <a class="anchor" name="4e60bb6a99451da5deb18b969e6b16cd"></a><!-- doxytag: member="plugins.cpp::amplitudeAdapter" ref="4e60bb6a99451da5deb18b969e6b16cd" args="" --> 159 <a class="anchor" name="4e60bb6a99451da5deb18b969e6b16cd"></a><!-- doxytag: member="plugins.cpp::amplitudeAdapter" ref="4e60bb6a99451da5deb18b969e6b16cd" args="" -->
137 <div class="memitem"> 160 <div class="memitem">
144 </div> 167 </div>
145 <div class="memdoc"> 168 <div class="memdoc">
146 169
147 <p> 170 <p>
148 171
149 <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> 172 <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>
173
174 </div>
175 </div><p>
176 <a class="anchor" name="77810f485caaae4a8b2303496046d3d7"></a><!-- doxytag: member="plugins.cpp::powerSpectrum" ref="77810f485caaae4a8b2303496046d3d7" args="" -->
177 <div class="memitem">
178 <div class="memproto">
179 <table class="memname">
180 <tr>
181 <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#77810f485caaae4a8b2303496046d3d7">powerSpectrum</a><code> [static]</code> </td>
182 </tr>
183 </table>
184 </div>
185 <div class="memdoc">
186
187 <p>
188
189 <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>
150 190
151 </div> 191 </div>
152 </div><p> 192 </div><p>
153 </div> 193 </div>
154 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by&nbsp; 194 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
155 <a href="http://www.doxygen.org/index.html"> 195 <a href="http://www.doxygen.org/index.html">
156 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 196 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
157 </body> 197 </body>
158 </html> 198 </html>