Mercurial > hg > vamp-website
comparison code-doc/classPercussionOnsetDetector.html @ 21:cc0be37dc9d3 website
* 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: PercussionOnsetDetector Class Reference</title> | 3 <title>VampPluginSDK: PercussionOnsetDetector Class 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 Page</span></a></li> | 11 <li><a href="main.html"><span>Main 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> |
29 <div class="dynheader"> | 29 <div class="dynheader"> |
30 Inheritance diagram for PercussionOnsetDetector:</div> | 30 Inheritance diagram for PercussionOnsetDetector:</div> |
31 <div class="dynsection"> | 31 <div class="dynsection"> |
32 <p><center><img src="classPercussionOnsetDetector__inherit__graph.png" border="0" usemap="#PercussionOnsetDetector__inherit__map" alt="Inheritance graph"></center> | 32 <p><center><img src="classPercussionOnsetDetector__inherit__graph.png" border="0" usemap="#PercussionOnsetDetector__inherit__map" alt="Inheritance graph"></center> |
33 <map name="PercussionOnsetDetector__inherit__map"> | 33 <map name="PercussionOnsetDetector__inherit__map"> |
34 <area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="41,82,140,106"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="27,7,155,31"></map> | 34 <area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="41,80,140,107"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="27,6,155,32"></map> |
35 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> | 35 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> |
36 | 36 |
37 <p> | 37 <p> |
38 <a href="classPercussionOnsetDetector-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> | 38 <a href="classPercussionOnsetDetector-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> |
39 Example plugin that detects percussive events. | 39 Example plugin that detects percussive events. |
123 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> | 123 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> |
124 | 124 |
125 <tr><td class="mdescLeft"> </td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr> | 125 <tr><td class="mdescLeft"> </td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr> |
126 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr> | 126 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr> |
127 | 127 |
128 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <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 compatibility level of the plugin. <a href="#8fd2c48291c64b790f0efb8948508dcf"></a><br></td></tr> | 128 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#8fd2c48291c64b790f0efb8948508dcf"></a><br></td></tr> |
129 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr> | 129 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr> |
130 | 130 |
131 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#bb307c60bdb981d5f5af50c3c4ae84af"></a><br></td></tr> | 131 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#bb307c60bdb981d5f5af50c3c4ae84af"></a><br></td></tr> |
132 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr> | 132 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr> |
133 | 133 |
165 </div> | 165 </div> |
166 <div class="memdoc"> | 166 <div class="memdoc"> |
167 | 167 |
168 <p> | 168 <p> |
169 | 169 |
170 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00309">309</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 170 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00322">322</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> |
171 | 171 |
172 </div> | 172 </div> |
173 </div><p> | 173 </div><p> |
174 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="PercussionOnsetDetector::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> | 174 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="PercussionOnsetDetector::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> |
175 <div class="memitem"> | 175 <div class="memitem"> |
182 </div> | 182 </div> |
183 <div class="memdoc"> | 183 <div class="memdoc"> |
184 | 184 |
185 <p> | 185 <p> |
186 | 186 |
187 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 187 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00380">380</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> |
188 | 188 |
189 </div> | 189 </div> |
190 </div><p> | 190 </div><p> |
191 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="PercussionOnsetDetector::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> | 191 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="PercussionOnsetDetector::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> |
192 <div class="memitem"> | 192 <div class="memitem"> |
199 </div> | 199 </div> |
200 <div class="memdoc"> | 200 <div class="memdoc"> |
201 | 201 |
202 <p> | 202 <p> |
203 | 203 |
204 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00348">348</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 204 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00382">382</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> |
205 | 205 |
206 </div> | 206 </div> |
207 </div><p> | 207 </div><p> |
208 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="PercussionOnsetDetector::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> | 208 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="PercussionOnsetDetector::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> |
209 <div class="memitem"> | 209 <div class="memitem"> |
216 </div> | 216 </div> |
217 <div class="memdoc"> | 217 <div class="memdoc"> |
218 | 218 |
219 <p> | 219 <p> |
220 | 220 |
221 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00195">195</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> | 221 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> |
222 | 222 |
223 </div> | 223 </div> |
224 </div><p> | 224 </div><p> |
225 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="PercussionOnsetDetector::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" --> | 225 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="PercussionOnsetDetector::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" --> |
226 <div class="memitem"> | 226 <div class="memitem"> |
233 </div> | 233 </div> |
234 <div class="memdoc"> | 234 <div class="memdoc"> |
235 | 235 |
236 <p> | 236 <p> |
237 | 237 |
238 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00217">217</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> | 238 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> |
239 | 239 |
240 </div> | 240 </div> |
241 </div><p> | 241 </div><p> |
242 <hr><h2>Member Enumeration Documentation</h2> | 242 <hr><h2>Member Enumeration Documentation</h2> |
243 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="PercussionOnsetDetector::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> | 243 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="PercussionOnsetDetector::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> |
259 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td> | 259 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td> |
260 </td></tr> | 260 </td></tr> |
261 </table> | 261 </table> |
262 </dl> | 262 </dl> |
263 | 263 |
264 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00149">149</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 264 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> |
265 | 265 |
266 </div> | 266 </div> |
267 </div><p> | 267 </div><p> |
268 <hr><h2>Constructor & Destructor Documentation</h2> | 268 <hr><h2>Constructor & Destructor Documentation</h2> |
269 <a class="anchor" name="9f700579805ee5105758d847baab3511"></a><!-- doxytag: member="PercussionOnsetDetector::PercussionOnsetDetector" ref="9f700579805ee5105758d847baab3511" args="(float inputSampleRate)" --> | 269 <a class="anchor" name="9f700579805ee5105758d847baab3511"></a><!-- doxytag: member="PercussionOnsetDetector::PercussionOnsetDetector" ref="9f700579805ee5105758d847baab3511" args="(float inputSampleRate)" --> |
274 <td class="memname">PercussionOnsetDetector::PercussionOnsetDetector </td> | 274 <td class="memname">PercussionOnsetDetector::PercussionOnsetDetector </td> |
275 <td>(</td> | 275 <td>(</td> |
276 <td class="paramtype">float </td> | 276 <td class="paramtype">float </td> |
277 <td class="paramname"> <em>inputSampleRate</em> </td> | 277 <td class="paramname"> <em>inputSampleRate</em> </td> |
278 <td> ) </td> | 278 <td> ) </td> |
279 <td width="100%"></td> | 279 <td></td> |
280 </tr> | 280 </tr> |
281 </table> | 281 </table> |
282 </div> | 282 </div> |
283 <div class="memdoc"> | 283 <div class="memdoc"> |
284 | 284 |
295 <tr> | 295 <tr> |
296 <td class="memname">PercussionOnsetDetector::~PercussionOnsetDetector </td> | 296 <td class="memname">PercussionOnsetDetector::~PercussionOnsetDetector </td> |
297 <td>(</td> | 297 <td>(</td> |
298 <td class="paramname"> </td> | 298 <td class="paramname"> </td> |
299 <td> ) </td> | 299 <td> ) </td> |
300 <td width="100%"><code> [virtual]</code></td> | 300 <td><code> [virtual]</code></td> |
301 </tr> | 301 </tr> |
302 </table> | 302 </table> |
303 </div> | 303 </div> |
304 <div class="memdoc"> | 304 <div class="memdoc"> |
305 | 305 |
335 <td class="paramname"> <em>blockSize</em></td><td> </td> | 335 <td class="paramname"> <em>blockSize</em></td><td> </td> |
336 </tr> | 336 </tr> |
337 <tr> | 337 <tr> |
338 <td></td> | 338 <td></td> |
339 <td>)</td> | 339 <td>)</td> |
340 <td></td><td></td><td width="100%"><code> [virtual]</code></td> | 340 <td></td><td></td><td><code> [virtual]</code></td> |
341 </tr> | 341 </tr> |
342 </table> | 342 </table> |
343 </div> | 343 </div> |
344 <div class="memdoc"> | 344 <div class="memdoc"> |
345 | 345 |
350 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. | 350 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. |
351 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> | 351 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> |
352 | 352 |
353 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">113</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> | 353 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">113</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> |
354 | 354 |
355 <p>References <a class="el" href="Plugin_8h-source.html#l00196">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="Plugin_8h-source.html#l00191">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00086">m_dfMinus2</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00084">m_priorMagnitudes</a>, and <a class="el" href="PercussionOnsetDetector_8h-source.html#l00079">m_stepSize</a>.</p> | 355 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00199">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00194">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00086">m_dfMinus2</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00084">m_priorMagnitudes</a>, and <a class="el" href="PercussionOnsetDetector_8h-source.html#l00079">m_stepSize</a>.</p> |
356 | 356 |
357 </div> | 357 </div> |
358 </div><p> | 358 </div><p> |
359 <a class="anchor" name="9b1075e992cd9599764ef3881fb91d1a"></a><!-- doxytag: member="PercussionOnsetDetector::reset" ref="9b1075e992cd9599764ef3881fb91d1a" args="()" --> | 359 <a class="anchor" name="9b1075e992cd9599764ef3881fb91d1a"></a><!-- doxytag: member="PercussionOnsetDetector::reset" ref="9b1075e992cd9599764ef3881fb91d1a" args="()" --> |
360 <div class="memitem"> | 360 <div class="memitem"> |
363 <tr> | 363 <tr> |
364 <td class="memname">void PercussionOnsetDetector::reset </td> | 364 <td class="memname">void PercussionOnsetDetector::reset </td> |
365 <td>(</td> | 365 <td>(</td> |
366 <td class="paramname"> </td> | 366 <td class="paramname"> </td> |
367 <td> ) </td> | 367 <td> ) </td> |
368 <td width="100%"><code> [virtual]</code></td> | 368 <td><code> [virtual]</code></td> |
369 </tr> | 369 </tr> |
370 </table> | 370 </table> |
371 </div> | 371 </div> |
372 <div class="memdoc"> | 372 <div class="memdoc"> |
373 | 373 |
390 <tr> | 390 <tr> |
391 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> PercussionOnsetDetector::getInputDomain </td> | 391 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> PercussionOnsetDetector::getInputDomain </td> |
392 <td>(</td> | 392 <td>(</td> |
393 <td class="paramname"> </td> | 393 <td class="paramname"> </td> |
394 <td> ) </td> | 394 <td> ) </td> |
395 <td width="100%"> const<code> [inline, virtual]</code></td> | 395 <td> const<code> [inline, virtual]</code></td> |
396 </tr> | 396 </tr> |
397 </table> | 397 </table> |
398 </div> | 398 </div> |
399 <div class="memdoc"> | 399 <div class="memdoc"> |
400 | 400 |
404 If this is TimeDomain, the samples provided to the <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. | 404 If this is TimeDomain, the samples provided to the <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. |
405 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> | 405 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> |
406 | 406 |
407 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h-source.html#l00055">55</a> of file <a class="el" href="PercussionOnsetDetector_8h-source.html">PercussionOnsetDetector.h</a>.</p> | 407 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h-source.html#l00055">55</a> of file <a class="el" href="PercussionOnsetDetector_8h-source.html">PercussionOnsetDetector.h</a>.</p> |
408 | 408 |
409 <p>References <a class="el" href="Plugin_8h-source.html#l00149">Vamp::Plugin::FrequencyDomain</a>.</p> | 409 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">Vamp::Plugin::FrequencyDomain</a>.</p> |
410 | 410 |
411 </div> | 411 </div> |
412 </div><p> | 412 </div><p> |
413 <a class="anchor" name="267c83a7533146c127e2c3be310e0154"></a><!-- doxytag: member="PercussionOnsetDetector::getIdentifier" ref="267c83a7533146c127e2c3be310e0154" args="() const " --> | 413 <a class="anchor" name="267c83a7533146c127e2c3be310e0154"></a><!-- doxytag: member="PercussionOnsetDetector::getIdentifier" ref="267c83a7533146c127e2c3be310e0154" args="() const " --> |
414 <div class="memitem"> | 414 <div class="memitem"> |
417 <tr> | 417 <tr> |
418 <td class="memname">string PercussionOnsetDetector::getIdentifier </td> | 418 <td class="memname">string PercussionOnsetDetector::getIdentifier </td> |
419 <td>(</td> | 419 <td>(</td> |
420 <td class="paramname"> </td> | 420 <td class="paramname"> </td> |
421 <td> ) </td> | 421 <td> ) </td> |
422 <td width="100%"> const<code> [virtual]</code></td> | 422 <td> const<code> [virtual]</code></td> |
423 </tr> | 423 </tr> |
424 </table> | 424 </table> |
425 </div> | 425 </div> |
426 <div class="memdoc"> | 426 <div class="memdoc"> |
427 | 427 |
444 <tr> | 444 <tr> |
445 <td class="memname">string PercussionOnsetDetector::getName </td> | 445 <td class="memname">string PercussionOnsetDetector::getName </td> |
446 <td>(</td> | 446 <td>(</td> |
447 <td class="paramname"> </td> | 447 <td class="paramname"> </td> |
448 <td> ) </td> | 448 <td> ) </td> |
449 <td width="100%"> const<code> [virtual]</code></td> | 449 <td> const<code> [virtual]</code></td> |
450 </tr> | 450 </tr> |
451 </table> | 451 </table> |
452 </div> | 452 </div> |
453 <div class="memdoc"> | 453 <div class="memdoc"> |
454 | 454 |
470 <tr> | 470 <tr> |
471 <td class="memname">string PercussionOnsetDetector::getDescription </td> | 471 <td class="memname">string PercussionOnsetDetector::getDescription </td> |
472 <td>(</td> | 472 <td>(</td> |
473 <td class="paramname"> </td> | 473 <td class="paramname"> </td> |
474 <td> ) </td> | 474 <td> ) </td> |
475 <td width="100%"> const<code> [virtual]</code></td> | 475 <td> const<code> [virtual]</code></td> |
476 </tr> | 476 </tr> |
477 </table> | 477 </table> |
478 </div> | 478 </div> |
479 <div class="memdoc"> | 479 <div class="memdoc"> |
480 | 480 |
496 <tr> | 496 <tr> |
497 <td class="memname">string PercussionOnsetDetector::getMaker </td> | 497 <td class="memname">string PercussionOnsetDetector::getMaker </td> |
498 <td>(</td> | 498 <td>(</td> |
499 <td class="paramname"> </td> | 499 <td class="paramname"> </td> |
500 <td> ) </td> | 500 <td> ) </td> |
501 <td width="100%"> const<code> [virtual]</code></td> | 501 <td> const<code> [virtual]</code></td> |
502 </tr> | 502 </tr> |
503 </table> | 503 </table> |
504 </div> | 504 </div> |
505 <div class="memdoc"> | 505 <div class="memdoc"> |
506 | 506 |
521 <tr> | 521 <tr> |
522 <td class="memname">int PercussionOnsetDetector::getPluginVersion </td> | 522 <td class="memname">int PercussionOnsetDetector::getPluginVersion </td> |
523 <td>(</td> | 523 <td>(</td> |
524 <td class="paramname"> </td> | 524 <td class="paramname"> </td> |
525 <td> ) </td> | 525 <td> ) </td> |
526 <td width="100%"> const<code> [virtual]</code></td> | 526 <td> const<code> [virtual]</code></td> |
527 </tr> | 527 </tr> |
528 </table> | 528 </table> |
529 </div> | 529 </div> |
530 <div class="memdoc"> | 530 <div class="memdoc"> |
531 | 531 |
546 <tr> | 546 <tr> |
547 <td class="memname">string PercussionOnsetDetector::getCopyright </td> | 547 <td class="memname">string PercussionOnsetDetector::getCopyright </td> |
548 <td>(</td> | 548 <td>(</td> |
549 <td class="paramname"> </td> | 549 <td class="paramname"> </td> |
550 <td> ) </td> | 550 <td> ) </td> |
551 <td width="100%"> const<code> [virtual]</code></td> | 551 <td> const<code> [virtual]</code></td> |
552 </tr> | 552 </tr> |
553 </table> | 553 </table> |
554 </div> | 554 </div> |
555 <div class="memdoc"> | 555 <div class="memdoc"> |
556 | 556 |
571 <tr> | 571 <tr> |
572 <td class="memname">size_t PercussionOnsetDetector::getPreferredStepSize </td> | 572 <td class="memname">size_t PercussionOnsetDetector::getPreferredStepSize </td> |
573 <td>(</td> | 573 <td>(</td> |
574 <td class="paramname"> </td> | 574 <td class="paramname"> </td> |
575 <td> ) </td> | 575 <td> ) </td> |
576 <td width="100%"> const<code> [virtual]</code></td> | 576 <td> const<code> [virtual]</code></td> |
577 </tr> | 577 </tr> |
578 </table> | 578 </table> |
579 </div> | 579 </div> |
580 <div class="memdoc"> | 580 <div class="memdoc"> |
581 | 581 |
597 <tr> | 597 <tr> |
598 <td class="memname">size_t PercussionOnsetDetector::getPreferredBlockSize </td> | 598 <td class="memname">size_t PercussionOnsetDetector::getPreferredBlockSize </td> |
599 <td>(</td> | 599 <td>(</td> |
600 <td class="paramname"> </td> | 600 <td class="paramname"> </td> |
601 <td> ) </td> | 601 <td> ) </td> |
602 <td width="100%"> const<code> [virtual]</code></td> | 602 <td> const<code> [virtual]</code></td> |
603 </tr> | 603 </tr> |
604 </table> | 604 </table> |
605 </div> | 605 </div> |
606 <div class="memdoc"> | 606 <div class="memdoc"> |
607 | 607 |
623 <tr> | 623 <tr> |
624 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PercussionOnsetDetector::ParameterList</a> PercussionOnsetDetector::getParameterDescriptors </td> | 624 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PercussionOnsetDetector::ParameterList</a> PercussionOnsetDetector::getParameterDescriptors </td> |
625 <td>(</td> | 625 <td>(</td> |
626 <td class="paramname"> </td> | 626 <td class="paramname"> </td> |
627 <td> ) </td> | 627 <td> ) </td> |
628 <td width="100%"> const<code> [virtual]</code></td> | 628 <td> const<code> [virtual]</code></td> |
629 </tr> | 629 </tr> |
630 </table> | 630 </table> |
631 </div> | 631 </div> |
632 <div class="memdoc"> | 632 <div class="memdoc"> |
633 | 633 |
637 | 637 |
638 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> | 638 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> |
639 | 639 |
640 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">145</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> | 640 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">145</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> |
641 | 641 |
642 <p>References <a class="el" href="PluginBase_8h-source.html#l00166">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="PluginBase_8h-source.html#l00143">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="PluginBase_8h-source.html#l00132">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="PluginBase_8h-source.html#l00172">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="PluginBase_8h-source.html#l00158">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="PluginBase_8h-source.html#l00153">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="PluginBase_8h-source.html#l00137">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="PluginBase_8h-source.html#l00148">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p> | 642 <p>References <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00171">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00148">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00137">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00177">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00163">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00158">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00142">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00153">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p> |
643 | 643 |
644 </div> | 644 </div> |
645 </div><p> | 645 </div><p> |
646 <a class="anchor" name="9b28da8315fcde46ce7644d6592ba527"></a><!-- doxytag: member="PercussionOnsetDetector::getParameter" ref="9b28da8315fcde46ce7644d6592ba527" args="(std::string id) const " --> | 646 <a class="anchor" name="9b28da8315fcde46ce7644d6592ba527"></a><!-- doxytag: member="PercussionOnsetDetector::getParameter" ref="9b28da8315fcde46ce7644d6592ba527" args="(std::string id) const " --> |
647 <div class="memitem"> | 647 <div class="memitem"> |
651 <td class="memname">float PercussionOnsetDetector::getParameter </td> | 651 <td class="memname">float PercussionOnsetDetector::getParameter </td> |
652 <td>(</td> | 652 <td>(</td> |
653 <td class="paramtype">std::string </td> | 653 <td class="paramtype">std::string </td> |
654 <td class="paramname"> </td> | 654 <td class="paramname"> </td> |
655 <td> ) </td> | 655 <td> ) </td> |
656 <td width="100%"> const<code> [virtual]</code></td> | 656 <td> const<code> [virtual]</code></td> |
657 </tr> | 657 </tr> |
658 </table> | 658 </table> |
659 </div> | 659 </div> |
660 <div class="memdoc"> | 660 <div class="memdoc"> |
661 | 661 |
688 <td class="paramname"></td><td> </td> | 688 <td class="paramname"></td><td> </td> |
689 </tr> | 689 </tr> |
690 <tr> | 690 <tr> |
691 <td></td> | 691 <td></td> |
692 <td>)</td> | 692 <td>)</td> |
693 <td></td><td></td><td width="100%"><code> [virtual]</code></td> | 693 <td></td><td></td><td><code> [virtual]</code></td> |
694 </tr> | 694 </tr> |
695 </table> | 695 </table> |
696 </div> | 696 </div> |
697 <div class="memdoc"> | 697 <div class="memdoc"> |
698 | 698 |
715 <tr> | 715 <tr> |
716 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">PercussionOnsetDetector::OutputList</a> PercussionOnsetDetector::getOutputDescriptors </td> | 716 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">PercussionOnsetDetector::OutputList</a> PercussionOnsetDetector::getOutputDescriptors </td> |
717 <td>(</td> | 717 <td>(</td> |
718 <td class="paramname"> </td> | 718 <td class="paramname"> </td> |
719 <td> ) </td> | 719 <td> ) </td> |
720 <td width="100%"> const<code> [virtual]</code></td> | 720 <td> const<code> [virtual]</code></td> |
721 </tr> | 721 </tr> |
722 </table> | 722 </table> |
723 </div> | 723 </div> |
724 <div class="memdoc"> | 724 <div class="memdoc"> |
725 | 725 |
729 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> call. | 729 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> call. |
730 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> | 730 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> |
731 | 731 |
732 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">196</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> | 732 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">196</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> |
733 | 733 |
734 <p>References <a class="el" href="Plugin_8h-source.html#l00239">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="Plugin_8h-source.html#l00219">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="Plugin_8h-source.html#l00231">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="Plugin_8h-source.html#l00252">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="Plugin_8h-source.html#l00206">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="Plugin_8h-source.html#l00270">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="Plugin_8h-source.html#l00397">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="Plugin_8h-source.html#l00212">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="Plugin_8h-source.html#l00282">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="Plugin_8h-source.html#l00277">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="Plugin_8h-source.html#l00306">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="Plugin_8h-source.html#l00294">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="Plugin_8h-source.html#l00224">Vamp::Plugin::OutputDescriptor::unit</a>, and <a class="el" href="Plugin_8h-source.html#l00288">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p> | 734 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00242">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00222">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00234">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00255">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00209">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00273">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00215">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00285">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00280">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00309">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00297">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00227">Vamp::Plugin::OutputDescriptor::unit</a>, and <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00291">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p> |
735 | 735 |
736 </div> | 736 </div> |
737 </div><p> | 737 </div><p> |
738 <a class="anchor" name="dfd989812b3e0cb8f4b498f56a5a9614"></a><!-- doxytag: member="PercussionOnsetDetector::process" ref="dfd989812b3e0cb8f4b498f56a5a9614" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" --> | 738 <a class="anchor" name="dfd989812b3e0cb8f4b498f56a5a9614"></a><!-- doxytag: member="PercussionOnsetDetector::process" ref="dfd989812b3e0cb8f4b498f56a5a9614" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" --> |
739 <div class="memitem"> | 739 <div class="memitem"> |
752 <td class="paramname"> <em>timestamp</em></td><td> </td> | 752 <td class="paramname"> <em>timestamp</em></td><td> </td> |
753 </tr> | 753 </tr> |
754 <tr> | 754 <tr> |
755 <td></td> | 755 <td></td> |
756 <td>)</td> | 756 <td>)</td> |
757 <td></td><td></td><td width="100%"><code> [virtual]</code></td> | 757 <td></td><td></td><td><code> [virtual]</code></td> |
758 </tr> | 758 </tr> |
759 </table> | 759 </table> |
760 </div> | 760 </div> |
761 <div class="memdoc"> | 761 <div class="memdoc"> |
762 | 762 |
763 <p> | 763 <p> |
764 Process a single block of input data. | 764 Process a single block of input data. |
765 <p> | 765 <p> |
766 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp will be the real time in seconds of the start of the supplied block of samples.<p> | 766 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp in this case will be the real time in seconds of the start of the supplied block of samples.<p> |
767 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p> | 767 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p> |
768 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.) | 768 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.) |
769 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> | 769 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> |
770 | 770 |
771 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">226</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> | 771 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">226</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> |
772 | 772 |
773 <p>References <a class="el" href="RealTime_8cpp-source.html#l00232">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="Plugin_8h-source.html#l00325">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00086">m_dfMinus2</a>, <a class="el" href="Plugin_8h-source.html#l00397">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00084">m_priorMagnitudes</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00083">m_sensitivity</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00079">m_stepSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00082">m_threshold</a>, <a class="el" href="Plugin_8h-source.html#l00332">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="Plugin_8h-source.html#l00339">Vamp::Plugin::Feature::values</a>.</p> | 773 <p>References <a class="el" href="structVamp_1_1RealTime.html#939b4b1d1ca190db69a418883f16ce8a">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00339">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00086">m_dfMinus2</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00084">m_priorMagnitudes</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00083">m_sensitivity</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00079">m_stepSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00082">m_threshold</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00347">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00369">Vamp::Plugin::Feature::values</a>.</p> |
774 | 774 |
775 </div> | 775 </div> |
776 </div><p> | 776 </div><p> |
777 <a class="anchor" name="d3d6767ed137783e84f842b4d4732ffa"></a><!-- doxytag: member="PercussionOnsetDetector::getRemainingFeatures" ref="d3d6767ed137783e84f842b4d4732ffa" args="()" --> | 777 <a class="anchor" name="d3d6767ed137783e84f842b4d4732ffa"></a><!-- doxytag: member="PercussionOnsetDetector::getRemainingFeatures" ref="d3d6767ed137783e84f842b4d4732ffa" args="()" --> |
778 <div class="memitem"> | 778 <div class="memitem"> |
781 <tr> | 781 <tr> |
782 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a> PercussionOnsetDetector::getRemainingFeatures </td> | 782 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a> PercussionOnsetDetector::getRemainingFeatures </td> |
783 <td>(</td> | 783 <td>(</td> |
784 <td class="paramname"> </td> | 784 <td class="paramname"> </td> |
785 <td> ) </td> | 785 <td> ) </td> |
786 <td width="100%"><code> [virtual]</code></td> | 786 <td><code> [virtual]</code></td> |
787 </tr> | 787 </tr> |
788 </table> | 788 </table> |
789 </div> | 789 </div> |
790 <div class="memdoc"> | 790 <div class="memdoc"> |
791 | 791 |
793 After all blocks have been processed, calculate and return any remaining features derived from the complete input. | 793 After all blocks have been processed, calculate and return any remaining features derived from the complete input. |
794 <p> | 794 <p> |
795 | 795 |
796 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> | 796 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> |
797 | 797 |
798 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00281">281</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> | 798 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00283">283</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p> |
799 | 799 |
800 </div> | 800 </div> |
801 </div><p> | 801 </div><p> |
802 <a class="anchor" name="267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="PercussionOnsetDetector::getMinChannelCount" ref="267b42e866df3cf0d190893e8096f525" args="() const " --> | 802 <a class="anchor" name="267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="PercussionOnsetDetector::getMinChannelCount" ref="267b42e866df3cf0d190893e8096f525" args="() const " --> |
803 <div class="memitem"> | 803 <div class="memitem"> |
806 <tr> | 806 <tr> |
807 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td> | 807 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td> |
808 <td>(</td> | 808 <td>(</td> |
809 <td class="paramname"> </td> | 809 <td class="paramname"> </td> |
810 <td> ) </td> | 810 <td> ) </td> |
811 <td width="100%"> const<code> [inline, virtual, inherited]</code></td> | 811 <td> const<code> [inline, virtual, inherited]</code></td> |
812 </tr> | 812 </tr> |
813 </table> | 813 </table> |
814 </div> | 814 </div> |
815 <div class="memdoc"> | 815 <div class="memdoc"> |
816 | 816 |
818 Get the minimum supported number of input channels. | 818 Get the minimum supported number of input channels. |
819 <p> | 819 <p> |
820 | 820 |
821 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p> | 821 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p> |
822 | 822 |
823 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00191">191</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 823 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00194">194</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> |
824 | 824 |
825 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00170">Vamp::HostExt::PluginWrapper::getMinChannelCount()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00093">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00095">SpectralCentroid::initialise()</a>, <a class="el" href="PluginChannelAdapter_8cpp-source.html#l00119">Vamp::HostExt::PluginChannelAdapter::Impl::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p> | 825 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00099">SpectralCentroid::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">PowerSpectrum::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00676">FixedTempoEstimator::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> |
826 | 826 |
827 </div> | 827 </div> |
828 </div><p> | 828 </div><p> |
829 <a class="anchor" name="2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="PercussionOnsetDetector::getMaxChannelCount" ref="2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " --> | 829 <a class="anchor" name="2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="PercussionOnsetDetector::getMaxChannelCount" ref="2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " --> |
830 <div class="memitem"> | 830 <div class="memitem"> |
833 <tr> | 833 <tr> |
834 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td> | 834 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td> |
835 <td>(</td> | 835 <td>(</td> |
836 <td class="paramname"> </td> | 836 <td class="paramname"> </td> |
837 <td> ) </td> | 837 <td> ) </td> |
838 <td width="100%"> const<code> [inline, virtual, inherited]</code></td> | 838 <td> const<code> [inline, virtual, inherited]</code></td> |
839 </tr> | 839 </tr> |
840 </table> | 840 </table> |
841 </div> | 841 </div> |
842 <div class="memdoc"> | 842 <div class="memdoc"> |
843 | 843 |
845 Get the maximum supported number of input channels. | 845 Get the maximum supported number of input channels. |
846 <p> | 846 <p> |
847 | 847 |
848 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p> | 848 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p> |
849 | 849 |
850 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00196">196</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 850 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> |
851 | 851 |
852 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00175">Vamp::HostExt::PluginWrapper::getMaxChannelCount()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00093">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00095">SpectralCentroid::initialise()</a>, <a class="el" href="PluginChannelAdapter_8cpp-source.html#l00119">Vamp::HostExt::PluginChannelAdapter::Impl::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p> | 852 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00099">SpectralCentroid::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">PowerSpectrum::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00676">FixedTempoEstimator::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> |
853 | 853 |
854 </div> | 854 </div> |
855 </div><p> | 855 </div><p> |
856 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="PercussionOnsetDetector::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " --> | 856 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="PercussionOnsetDetector::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " --> |
857 <div class="memitem"> | 857 <div class="memitem"> |
860 <tr> | 860 <tr> |
861 <td class="memname">virtual std::string Vamp::Plugin::getType </td> | 861 <td class="memname">virtual std::string Vamp::Plugin::getType </td> |
862 <td>(</td> | 862 <td>(</td> |
863 <td class="paramname"> </td> | 863 <td class="paramname"> </td> |
864 <td> ) </td> | 864 <td> ) </td> |
865 <td width="100%"> const<code> [inline, virtual, inherited]</code></td> | 865 <td> const<code> [inline, virtual, inherited]</code></td> |
866 </tr> | 866 </tr> |
867 </table> | 867 </table> |
868 </div> | 868 </div> |
869 <div class="memdoc"> | 869 <div class="memdoc"> |
870 | 870 |
872 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. | 872 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. |
873 <p> | 873 <p> |
874 Do not reimplement this function in your subclass. | 874 Do not reimplement this function in your subclass. |
875 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> | 875 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> |
876 | 876 |
877 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00391">391</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 877 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00425">425</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> |
878 | 878 |
879 </div> | 879 </div> |
880 </div><p> | 880 </div><p> |
881 <a class="anchor" name="8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="PercussionOnsetDetector::getVampApiVersion" ref="8fd2c48291c64b790f0efb8948508dcf" args="() const " --> | 881 <a class="anchor" name="8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="PercussionOnsetDetector::getVampApiVersion" ref="8fd2c48291c64b790f0efb8948508dcf" args="() const " --> |
882 <div class="memitem"> | 882 <div class="memitem"> |
885 <tr> | 885 <tr> |
886 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td> | 886 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td> |
887 <td>(</td> | 887 <td>(</td> |
888 <td class="paramname"> </td> | 888 <td class="paramname"> </td> |
889 <td> ) </td> | 889 <td> ) </td> |
890 <td width="100%"> const<code> [inline, virtual, inherited]</code></td> | 890 <td> const<code> [inline, virtual, inherited]</code></td> |
891 </tr> | 891 </tr> |
892 </table> | 892 </table> |
893 </div> | 893 </div> |
894 <div class="memdoc"> | 894 <div class="memdoc"> |
895 | 895 |
896 <p> | 896 <p> |
897 Get the <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 compatibility level of the plugin. | 897 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. |
898 <p> | 898 <p> |
899 | 899 |
900 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p> | 900 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p> |
901 | 901 |
902 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00067">67</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> | 902 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00072">72</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> |
903 | 903 |
904 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00080">Vamp::HostExt::PluginWrapper::getVampApiVersion()</a>.</p> | 904 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p> |
905 | 905 |
906 </div> | 906 </div> |
907 </div><p> | 907 </div><p> |
908 <a class="anchor" name="bb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="PercussionOnsetDetector::getPrograms" ref="bb307c60bdb981d5f5af50c3c4ae84af" args="() const " --> | 908 <a class="anchor" name="bb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="PercussionOnsetDetector::getPrograms" ref="bb307c60bdb981d5f5af50c3c4ae84af" args="() const " --> |
909 <div class="memitem"> | 909 <div class="memitem"> |
912 <tr> | 912 <tr> |
913 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td> | 913 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td> |
914 <td>(</td> | 914 <td>(</td> |
915 <td class="paramname"> </td> | 915 <td class="paramname"> </td> |
916 <td> ) </td> | 916 <td> ) </td> |
917 <td width="100%"> const<code> [inline, virtual, inherited]</code></td> | 917 <td> const<code> [inline, virtual, inherited]</code></td> |
918 </tr> | 918 </tr> |
919 </table> | 919 </table> |
920 </div> | 920 </div> |
921 <div class="memdoc"> | 921 <div class="memdoc"> |
922 | 922 |
923 <p> | 923 <p> |
924 Get the program settings available in this plugin. | 924 Get the program settings available in this plugin. |
925 <p> | 925 <p> |
926 A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.<p> | 926 A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.<p> |
927 The programs must have unique names. | 927 The programs must have unique names. |
928 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#7ac5681dcfe08b7b8a796bffc0aff3e3">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#f3abaf717dc4b00cad5770ed6dfa01e1">Vamp::HostExt::PluginWrapper</a>.</p> | 928 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#e0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p> |
929 | 929 |
930 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00229">229</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> | 930 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00237">237</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> |
931 | |
932 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00140">Vamp::HostExt::PluginWrapper::getPrograms()</a>.</p> | |
933 | 931 |
934 </div> | 932 </div> |
935 </div><p> | 933 </div><p> |
936 <a class="anchor" name="24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="PercussionOnsetDetector::getCurrentProgram" ref="24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " --> | 934 <a class="anchor" name="24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="PercussionOnsetDetector::getCurrentProgram" ref="24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " --> |
937 <div class="memitem"> | 935 <div class="memitem"> |
940 <tr> | 938 <tr> |
941 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td> | 939 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td> |
942 <td>(</td> | 940 <td>(</td> |
943 <td class="paramname"> </td> | 941 <td class="paramname"> </td> |
944 <td> ) </td> | 942 <td> ) </td> |
945 <td width="100%"> const<code> [inline, virtual, inherited]</code></td> | 943 <td> const<code> [inline, virtual, inherited]</code></td> |
946 </tr> | 944 </tr> |
947 </table> | 945 </table> |
948 </div> | 946 </div> |
949 <div class="memdoc"> | 947 <div class="memdoc"> |
950 | 948 |
952 Get the current program. | 950 Get the current program. |
953 <p> | 951 <p> |
954 | 952 |
955 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p> | 953 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p> |
956 | 954 |
957 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00234">234</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> | 955 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00242">242</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> |
958 | |
959 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00146">Vamp::HostExt::PluginWrapper::getCurrentProgram()</a>.</p> | |
960 | 956 |
961 </div> | 957 </div> |
962 </div><p> | 958 </div><p> |
963 <a class="anchor" name="add3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="PercussionOnsetDetector::selectProgram" ref="add3a547ef140bae200473a9518e3353" args="(std::string)" --> | 959 <a class="anchor" name="add3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="PercussionOnsetDetector::selectProgram" ref="add3a547ef140bae200473a9518e3353" args="(std::string)" --> |
964 <div class="memitem"> | 960 <div class="memitem"> |
968 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td> | 964 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td> |
969 <td>(</td> | 965 <td>(</td> |
970 <td class="paramtype">std::string </td> | 966 <td class="paramtype">std::string </td> |
971 <td class="paramname"> </td> | 967 <td class="paramname"> </td> |
972 <td> ) </td> | 968 <td> ) </td> |
973 <td width="100%"><code> [inline, virtual, inherited]</code></td> | 969 <td><code> [inline, virtual, inherited]</code></td> |
974 </tr> | 970 </tr> |
975 </table> | 971 </table> |
976 </div> | 972 </div> |
977 <div class="memdoc"> | 973 <div class="memdoc"> |
978 | 974 |
979 <p> | 975 <p> |
980 Select a program. | 976 Select a program. |
981 <p> | 977 <p> |
982 (If the given program name is not one of the available programs, do nothing.) | 978 (If the given program name is not one of the available programs, do nothing.) |
983 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> | 979 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> |
984 | 980 |
985 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00240">240</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> | 981 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00248">248</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> |
986 | |
987 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00152">Vamp::HostExt::PluginWrapper::selectProgram()</a>.</p> | |
988 | 982 |
989 </div> | 983 </div> |
990 </div><p> | 984 </div><p> |
991 <hr><h2>Member Data Documentation</h2> | 985 <hr><h2>Member Data Documentation</h2> |
992 <a class="anchor" name="abac0cf7e961482b075777e5f0686e6c"></a><!-- doxytag: member="PercussionOnsetDetector::m_stepSize" ref="abac0cf7e961482b075777e5f0686e6c" args="" --> | 986 <a class="anchor" name="abac0cf7e961482b075777e5f0686e6c"></a><!-- doxytag: member="PercussionOnsetDetector::m_stepSize" ref="abac0cf7e961482b075777e5f0686e6c" args="" --> |
1133 </div> | 1127 </div> |
1134 <div class="memdoc"> | 1128 <div class="memdoc"> |
1135 | 1129 |
1136 <p> | 1130 <p> |
1137 | 1131 |
1138 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00397">397</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 1132 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">431</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> |
1139 | 1133 |
1140 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00047">Vamp::HostExt::PluginRateExtractor::getRate()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00113">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">process()</a>.</p> | 1134 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">process()</a>.</p> |
1141 | 1135 |
1142 </div> | 1136 </div> |
1143 </div><p> | 1137 </div><p> |
1144 <hr>The documentation for this class was generated from the following files:<ul> | 1138 <hr>The documentation for this class was generated from the following files:<ul> |
1145 <li><a class="el" href="PercussionOnsetDetector_8h-source.html">PercussionOnsetDetector.h</a><li><a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a></ul> | 1139 <li><a class="el" href="PercussionOnsetDetector_8h-source.html">PercussionOnsetDetector.h</a><li><a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a></ul> |
1146 </div> | 1140 </div> |
1147 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by | 1141 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:19 2008 for VampPluginSDK by |
1148 <a href="http://www.doxygen.org/index.html"> | 1142 <a href="http://www.doxygen.org/index.html"> |
1149 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> | 1143 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> |
1150 </body> | 1144 </body> |
1151 </html> | 1145 </html> |