annotate code-docs/classPercussionOnsetDetector.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@1 6 <title>VampPluginSDK: PercussionOnsetDetector Class Reference</title>
Chris@1 7
Chris@1 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 11 <script type="text/javascript" src="jquery.js"></script>
Chris@1 12 <script type="text/javascript" src="resize.js"></script>
Chris@1 13 <script type="text/javascript" src="navtree.js"></script>
Chris@1 14 <script type="text/javascript">
Chris@1 15 $(document).ready(initResizable);
Chris@1 16 </script>
Chris@1 17
Chris@1 18
Chris@1 19 </head>
Chris@1 20 <body>
Chris@1 21 <div id="top"><!-- do not remove this div! -->
Chris@1 22
Chris@1 23
Chris@1 24 <div id="titlearea">
Chris@1 25 <table cellspacing="0" cellpadding="0">
Chris@1 26 <tbody>
Chris@1 27 <tr style="height: 56px;">
Chris@1 28
Chris@1 29
Chris@1 30 <td style="padding-left: 0.5em;">
Chris@1 31 <div id="projectname">VampPluginSDK
Chris@3 32 &#160;<span id="projectnumber">2.4</span>
Chris@1 33 </div>
Chris@1 34
Chris@1 35 </td>
Chris@1 36
Chris@1 37
Chris@1 38
Chris@1 39 </tr>
Chris@1 40 </tbody>
Chris@1 41 </table>
Chris@1 42 </div>
Chris@1 43
Chris@3 44 <!-- Generated by Doxygen 1.8.0 -->
Chris@1 45 <div id="navrow1" class="tabs">
Chris@1 46 <ul class="tablist">
Chris@1 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 50 <li><a href="files.html"><span>Files</span></a></li>
Chris@1 51 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 52 </ul>
Chris@1 53 </div>
Chris@1 54 <div id="navrow2" class="tabs2">
Chris@1 55 <ul class="tablist">
Chris@1 56 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 59 </ul>
Chris@1 60 </div>
Chris@1 61 </div>
Chris@1 62 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 63 <div id="nav-tree">
Chris@1 64 <div id="nav-tree-contents">
Chris@1 65 </div>
Chris@1 66 </div>
Chris@1 67 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 68 class="ui-resizable-handle">
Chris@1 69 </div>
Chris@1 70 </div>
Chris@1 71 <script type="text/javascript">
Chris@1 72 initNavTree('classPercussionOnsetDetector.html','');
Chris@1 73 </script>
Chris@1 74 <div id="doc-content">
Chris@1 75 <div class="header">
Chris@1 76 <div class="summary">
Chris@1 77 <a href="#pub-types">Public Types</a> &#124;
Chris@1 78 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@1 79 <a href="#pro-attribs">Protected Attributes</a> </div>
Chris@1 80 <div class="headertitle">
Chris@1 81 <div class="title">PercussionOnsetDetector Class Reference</div> </div>
Chris@3 82 </div><!--header-->
Chris@1 83 <div class="contents">
Chris@3 84
Chris@1 85 <p>Example plugin that detects percussive events.
Chris@1 86 <a href="classPercussionOnsetDetector.html#details">More...</a></p>
Chris@1 87
Chris@1 88 <p><code>#include &lt;<a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>&gt;</code></p>
Chris@1 89 <div class="dynheader">
Chris@1 90 Inheritance diagram for PercussionOnsetDetector:</div>
Chris@1 91 <div class="dyncontent">
Chris@1 92 <div class="center"><img src="classPercussionOnsetDetector__inherit__graph.png" border="0" usemap="#PercussionOnsetDetector_inherit__map" alt="Inheritance graph"/></div>
Chris@1 93 <map name="PercussionOnsetDetector_inherit__map" id="PercussionOnsetDetector_inherit__map">
Chris@1 94 <area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="35,81,127,106"/><area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="22,6,140,31"/></map>
Chris@1 95 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
Chris@1 96
Chris@1 97 <p><a href="classPercussionOnsetDetector-members.html">List of all members.</a></p>
Chris@1 98 <table class="memberdecls">
Chris@1 99 <tr><td colspan="2"><h2><a name="pub-types"></a>
Chris@1 100 Public Types</h2></td></tr>
Chris@3 101 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
Chris@1 102 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
Chris@1 103 }</td></tr>
Chris@3 104 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
Chris@1 105 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
Chris@3 106 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
Chris@3 107 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
Chris@1 108 <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
Chris@3 109 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
Chris@1 110 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
Chris@3 111 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
Chris@1 112 <tr><td colspan="2"><h2><a name="pub-methods"></a>
Chris@1 113 Public Member Functions</h2></td></tr>
Chris@3 114 <tr class="memitem:a9f700579805ee5105758d847baab3511"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a9f700579805ee5105758d847baab3511">PercussionOnsetDetector</a> (float inputSampleRate)</td></tr>
Chris@3 115 <tr class="memitem:a99f833667cf8185e879d735216c7642b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a99f833667cf8185e879d735216c7642b">~PercussionOnsetDetector</a> ()</td></tr>
Chris@3 116 <tr class="memitem:a349c528260622308f3850bcda8a448ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
Chris@3 117 <tr class="memdesc:a349c528260622308f3850bcda8a448ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#a349c528260622308f3850bcda8a448ab"></a><br/></td></tr>
Chris@3 118 <tr class="memitem:a9b1075e992cd9599764ef3881fb91d1a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a9b1075e992cd9599764ef3881fb91d1a">reset</a> ()</td></tr>
Chris@3 119 <tr class="memdesc:a9b1075e992cd9599764ef3881fb91d1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a9b1075e992cd9599764ef3881fb91d1a"></a><br/></td></tr>
Chris@3 120 <tr class="memitem:a4f6954267696ee5bfa7dd1c4a6cfa92a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a4f6954267696ee5bfa7dd1c4a6cfa92a">getInputDomain</a> () const </td></tr>
Chris@3 121 <tr class="memdesc:a4f6954267696ee5bfa7dd1c4a6cfa92a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a4f6954267696ee5bfa7dd1c4a6cfa92a"></a><br/></td></tr>
Chris@3 122 <tr class="memitem:a267c83a7533146c127e2c3be310e0154"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a267c83a7533146c127e2c3be310e0154">getIdentifier</a> () const </td></tr>
Chris@3 123 <tr class="memdesc:a267c83a7533146c127e2c3be310e0154"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a267c83a7533146c127e2c3be310e0154"></a><br/></td></tr>
Chris@3 124 <tr class="memitem:aa98f1ad061a11af98c054011a8844e6f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#aa98f1ad061a11af98c054011a8844e6f">getName</a> () const </td></tr>
Chris@3 125 <tr class="memdesc:aa98f1ad061a11af98c054011a8844e6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#aa98f1ad061a11af98c054011a8844e6f"></a><br/></td></tr>
Chris@3 126 <tr class="memitem:a9061d189705802a48973a7ccab6360db"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a9061d189705802a48973a7ccab6360db">getDescription</a> () const </td></tr>
Chris@3 127 <tr class="memdesc:a9061d189705802a48973a7ccab6360db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#a9061d189705802a48973a7ccab6360db"></a><br/></td></tr>
Chris@3 128 <tr class="memitem:a63d63f2cb7ea8d8b09d58cc13b541375"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a63d63f2cb7ea8d8b09d58cc13b541375">getMaker</a> () const </td></tr>
Chris@3 129 <tr class="memdesc:a63d63f2cb7ea8d8b09d58cc13b541375"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a63d63f2cb7ea8d8b09d58cc13b541375"></a><br/></td></tr>
Chris@3 130 <tr class="memitem:ad6b818dbd81867ce7be71c99cae861be"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#ad6b818dbd81867ce7be71c99cae861be">getPluginVersion</a> () const </td></tr>
Chris@3 131 <tr class="memdesc:ad6b818dbd81867ce7be71c99cae861be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#ad6b818dbd81867ce7be71c99cae861be"></a><br/></td></tr>
Chris@3 132 <tr class="memitem:a1a22ece271330c94cc08798a77416351"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a1a22ece271330c94cc08798a77416351">getCopyright</a> () const </td></tr>
Chris@3 133 <tr class="memdesc:a1a22ece271330c94cc08798a77416351"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#a1a22ece271330c94cc08798a77416351"></a><br/></td></tr>
Chris@3 134 <tr class="memitem:a733824891e11c306a7a678534b89b968"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968">getPreferredStepSize</a> () const </td></tr>
Chris@3 135 <tr class="memdesc:a733824891e11c306a7a678534b89b968"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a733824891e11c306a7a678534b89b968"></a><br/></td></tr>
Chris@3 136 <tr class="memitem:a410c0b47c6c849d7ed9b726b84402ad0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0">getPreferredBlockSize</a> () const </td></tr>
Chris@3 137 <tr class="memdesc:a410c0b47c6c849d7ed9b726b84402ad0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function). <a href="#a410c0b47c6c849d7ed9b726b84402ad0"></a><br/></td></tr>
Chris@3 138 <tr class="memitem:abceae88cc9762b0ea310d7aad71de815"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815">getParameterDescriptors</a> () const </td></tr>
Chris@3 139 <tr class="memdesc:abceae88cc9762b0ea310d7aad71de815"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#abceae88cc9762b0ea310d7aad71de815"></a><br/></td></tr>
Chris@3 140 <tr class="memitem:a9b28da8315fcde46ce7644d6592ba527"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527">getParameter</a> (std::string id) const </td></tr>
Chris@3 141 <tr class="memdesc:a9b28da8315fcde46ce7644d6592ba527"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a9b28da8315fcde46ce7644d6592ba527"></a><br/></td></tr>
Chris@3 142 <tr class="memitem:aa097d72488e1211f05fc661ff5c6dc01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">setParameter</a> (std::string id, float value)</td></tr>
Chris@3 143 <tr class="memdesc:aa097d72488e1211f05fc661ff5c6dc01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#aa097d72488e1211f05fc661ff5c6dc01"></a><br/></td></tr>
Chris@3 144 <tr class="memitem:aa4537aa0eb58a67d6e824d46924cf782"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#aa4537aa0eb58a67d6e824d46924cf782">getOutputDescriptors</a> () const </td></tr>
Chris@3 145 <tr class="memdesc:aa4537aa0eb58a67d6e824d46924cf782"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#aa4537aa0eb58a67d6e824d46924cf782"></a><br/></td></tr>
Chris@3 146 <tr class="memitem:adfd989812b3e0cb8f4b498f56a5a9614"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
Chris@3 147 <tr class="memdesc:adfd989812b3e0cb8f4b498f56a5a9614"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#adfd989812b3e0cb8f4b498f56a5a9614"></a><br/></td></tr>
Chris@3 148 <tr class="memitem:ad3d6767ed137783e84f842b4d4732ffa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#ad3d6767ed137783e84f842b4d4732ffa">getRemainingFeatures</a> ()</td></tr>
Chris@3 149 <tr class="memdesc:ad3d6767ed137783e84f842b4d4732ffa"><td class="mdescLeft">&#160;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#ad3d6767ed137783e84f842b4d4732ffa"></a><br/></td></tr>
Chris@3 150 <tr class="memitem:a267b42e866df3cf0d190893e8096f525"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr>
Chris@3 151 <tr class="memdesc:a267b42e866df3cf0d190893e8096f525"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a267b42e866df3cf0d190893e8096f525"></a><br/></td></tr>
Chris@3 152 <tr class="memitem:a2c5ab12b6fa4847cb244bd1e9cb3ae5e"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr>
Chris@3 153 <tr class="memdesc:a2c5ab12b6fa4847cb244bd1e9cb3ae5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br/></td></tr>
Chris@3 154 <tr class="memitem:abe13b3997a69fbcc09e2213faa352f91"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
Chris@3 155 <tr class="memdesc:abe13b3997a69fbcc09e2213faa352f91"><td class="mdescLeft">&#160;</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 from audio o...">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="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr>
Chris@3 156 <tr class="memitem:a8fd2c48291c64b790f0efb8948508dcf"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr>
Chris@3 157 <tr class="memdesc:a8fd2c48291c64b790f0efb8948508dcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr>
Chris@3 158 <tr class="memitem:abb307c60bdb981d5f5af50c3c4ae84af"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr>
Chris@3 159 <tr class="memdesc:abb307c60bdb981d5f5af50c3c4ae84af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr>
Chris@3 160 <tr class="memitem:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr>
Chris@3 161 <tr class="memdesc:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr>
Chris@3 162 <tr class="memitem:aadd3a547ef140bae200473a9518e3353"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
Chris@3 163 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr>
Chris@1 164 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
Chris@1 165 Protected Attributes</h2></td></tr>
Chris@3 166 <tr class="memitem:aabac0cf7e961482b075777e5f0686e6c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#aabac0cf7e961482b075777e5f0686e6c">m_stepSize</a></td></tr>
Chris@3 167 <tr class="memitem:a920de543dbcf70a2edd80b5b31313285"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">m_blockSize</a></td></tr>
Chris@3 168 <tr class="memitem:ab04119adad56d87f2e633de289aab507"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#ab04119adad56d87f2e633de289aab507">m_threshold</a></td></tr>
Chris@3 169 <tr class="memitem:a4e9770f246ba3bc75e7fc2cb8f9010af"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a4e9770f246ba3bc75e7fc2cb8f9010af">m_sensitivity</a></td></tr>
Chris@3 170 <tr class="memitem:a30daa717267251a9d49afe57c328e989"><td class="memItemLeft" align="right" valign="top">float *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a></td></tr>
Chris@3 171 <tr class="memitem:acd80162c65212be7fa91251263fb9c3d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a></td></tr>
Chris@3 172 <tr class="memitem:a6ad7d8353cc681ff42a63b127cca5779"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a6ad7d8353cc681ff42a63b127cca5779">m_dfMinus2</a></td></tr>
Chris@3 173 <tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
Chris@1 174 </table>
Chris@1 175 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 176 <div class="textblock"><p>Example plugin that detects percussive events. </p>
Chris@1 177
Chris@1 178 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00046">46</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 179 </div><hr/><h2>Member Typedef Documentation</h2>
Chris@3 180 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
Chris@1 181 <div class="memitem">
Chris@1 182 <div class="memproto">
Chris@1 183 <table class="memname">
Chris@1 184 <tr>
Chris@1 185 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code></td>
Chris@1 186 </tr>
Chris@1 187 </table>
Chris@1 188 </div>
Chris@1 189 <div class="memdoc">
Chris@1 190
Chris@1 191 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00327">327</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 192
Chris@1 193 </div>
Chris@1 194 </div>
Chris@3 195 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
Chris@1 196 <div class="memitem">
Chris@1 197 <div class="memproto">
Chris@1 198 <table class="memname">
Chris@1 199 <tr>
Chris@1 200 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code></td>
Chris@1 201 </tr>
Chris@1 202 </table>
Chris@1 203 </div>
Chris@1 204 <div class="memdoc">
Chris@1 205
Chris@1 206 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00385">385</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 207
Chris@1 208 </div>
Chris@1 209 </div>
Chris@3 210 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
Chris@1 211 <div class="memitem">
Chris@1 212 <div class="memproto">
Chris@1 213 <table class="memname">
Chris@1 214 <tr>
Chris@1 215 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code></td>
Chris@1 216 </tr>
Chris@1 217 </table>
Chris@1 218 </div>
Chris@1 219 <div class="memdoc">
Chris@1 220
Chris@1 221 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 222
Chris@1 223 </div>
Chris@1 224 </div>
Chris@3 225 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
Chris@1 226 <div class="memitem">
Chris@1 227 <div class="memproto">
Chris@1 228 <table class="memname">
Chris@1 229 <tr>
Chris@1 230 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code></td>
Chris@1 231 </tr>
Chris@1 232 </table>
Chris@1 233 </div>
Chris@1 234 <div class="memdoc">
Chris@1 235
Chris@3 236 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 237
Chris@1 238 </div>
Chris@1 239 </div>
Chris@3 240 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a>
Chris@1 241 <div class="memitem">
Chris@1 242 <div class="memproto">
Chris@1 243 <table class="memname">
Chris@1 244 <tr>
Chris@1 245 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code></td>
Chris@1 246 </tr>
Chris@1 247 </table>
Chris@1 248 </div>
Chris@1 249 <div class="memdoc">
Chris@1 250
Chris@3 251 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00221">221</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 252
Chris@1 253 </div>
Chris@1 254 </div>
Chris@1 255 <hr/><h2>Member Enumeration Documentation</h2>
Chris@3 256 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
Chris@1 257 <div class="memitem">
Chris@1 258 <div class="memproto">
Chris@1 259 <table class="memname">
Chris@1 260 <tr>
Chris@1 261 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
Chris@1 262 </tr>
Chris@1 263 </table>
Chris@1 264 </div>
Chris@1 265 <div class="memdoc">
Chris@1 266 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
Chris@3 267 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em>&nbsp;</td><td>
Chris@1 268 </td></tr>
Chris@3 269 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em>&nbsp;</td><td>
Chris@1 270 </td></tr>
Chris@1 271 </table>
Chris@1 272 </dd>
Chris@1 273 </dl>
Chris@1 274
Chris@1 275 <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>
Chris@1 276
Chris@1 277 </div>
Chris@1 278 </div>
Chris@1 279 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
Chris@3 280 <a class="anchor" id="a9f700579805ee5105758d847baab3511"></a>
Chris@1 281 <div class="memitem">
Chris@1 282 <div class="memproto">
Chris@1 283 <table class="memname">
Chris@1 284 <tr>
Chris@3 285 <td class="memname"><a class="el" href="classPercussionOnsetDetector.html#a9f700579805ee5105758d847baab3511">PercussionOnsetDetector::PercussionOnsetDetector</a> </td>
Chris@1 286 <td>(</td>
Chris@1 287 <td class="paramtype">float&#160;</td>
Chris@1 288 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
Chris@1 289 <td></td>
Chris@1 290 </tr>
Chris@1 291 </table>
Chris@1 292 </div>
Chris@1 293 <div class="memdoc">
Chris@1 294
Chris@1 295 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00047">47</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 296
Chris@1 297 </div>
Chris@1 298 </div>
Chris@3 299 <a class="anchor" id="a99f833667cf8185e879d735216c7642b"></a>
Chris@1 300 <div class="memitem">
Chris@1 301 <div class="memproto">
Chris@1 302 <table class="memname">
Chris@1 303 <tr>
Chris@3 304 <td class="memname"><a class="el" href="classPercussionOnsetDetector.html#a99f833667cf8185e879d735216c7642b">PercussionOnsetDetector::~PercussionOnsetDetector</a> </td>
Chris@1 305 <td>(</td>
Chris@1 306 <td class="paramname"></td><td>)</td>
Chris@1 307 <td><code> [virtual]</code></td>
Chris@1 308 </tr>
Chris@1 309 </table>
Chris@1 310 </div>
Chris@1 311 <div class="memdoc">
Chris@1 312
Chris@1 313 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00059">59</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 314
Chris@1 315 <p>References <a class="el" href="PercussionOnsetDetector_8h_source.html#l00084">m_priorMagnitudes</a>.</p>
Chris@1 316
Chris@1 317 </div>
Chris@1 318 </div>
Chris@1 319 <hr/><h2>Member Function Documentation</h2>
Chris@3 320 <a class="anchor" id="a349c528260622308f3850bcda8a448ab"></a>
Chris@1 321 <div class="memitem">
Chris@1 322 <div class="memproto">
Chris@1 323 <table class="memname">
Chris@1 324 <tr>
Chris@3 325 <td class="memname">bool <a class="el" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab">PercussionOnsetDetector::initialise</a> </td>
Chris@1 326 <td>(</td>
Chris@1 327 <td class="paramtype">size_t&#160;</td>
Chris@1 328 <td class="paramname"><em>inputChannels</em>, </td>
Chris@1 329 </tr>
Chris@1 330 <tr>
Chris@1 331 <td class="paramkey"></td>
Chris@1 332 <td></td>
Chris@1 333 <td class="paramtype">size_t&#160;</td>
Chris@1 334 <td class="paramname"><em>stepSize</em>, </td>
Chris@1 335 </tr>
Chris@1 336 <tr>
Chris@1 337 <td class="paramkey"></td>
Chris@1 338 <td></td>
Chris@1 339 <td class="paramtype">size_t&#160;</td>
Chris@1 340 <td class="paramname"><em>blockSize</em>&#160;</td>
Chris@1 341 </tr>
Chris@1 342 <tr>
Chris@1 343 <td></td>
Chris@1 344 <td>)</td>
Chris@1 345 <td></td><td><code> [virtual]</code></td>
Chris@1 346 </tr>
Chris@1 347 </table>
Chris@1 348 </div>
Chris@1 349 <div class="memdoc">
Chris@1 350
Chris@1 351 <p>Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). </p>
Chris@1 352 <p>The input sample rate should have been already specified at construction time.</p>
Chris@1 353 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
Chris@1 354
Chris@1 355 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
Chris@1 356
Chris@1 357 <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>
Chris@1 358
Chris@1 359 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">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>
Chris@1 360
Chris@1 361 </div>
Chris@1 362 </div>
Chris@3 363 <a class="anchor" id="a9b1075e992cd9599764ef3881fb91d1a"></a>
Chris@1 364 <div class="memitem">
Chris@1 365 <div class="memproto">
Chris@1 366 <table class="memname">
Chris@1 367 <tr>
Chris@3 368 <td class="memname">void <a class="el" href="classPercussionOnsetDetector.html#a9b1075e992cd9599764ef3881fb91d1a">PercussionOnsetDetector::reset</a> </td>
Chris@1 369 <td>(</td>
Chris@1 370 <td class="paramname"></td><td>)</td>
Chris@1 371 <td><code> [virtual]</code></td>
Chris@1 372 </tr>
Chris@1 373 </table>
Chris@1 374 </div>
Chris@1 375 <div class="memdoc">
Chris@1 376
Chris@1 377 <p>Reset the plugin after use, to prepare it for another clean run. </p>
Chris@1 378 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
Chris@1 379
Chris@1 380 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
Chris@1 381
Chris@1 382 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">134</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 383
Chris@1 384 <p>References <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>, and <a class="el" href="PercussionOnsetDetector_8h_source.html#l00084">m_priorMagnitudes</a>.</p>
Chris@1 385
Chris@1 386 </div>
Chris@1 387 </div>
Chris@3 388 <a class="anchor" id="a4f6954267696ee5bfa7dd1c4a6cfa92a"></a>
Chris@1 389 <div class="memitem">
Chris@1 390 <div class="memproto">
Chris@1 391 <table class="memname">
Chris@1 392 <tr>
Chris@3 393 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="el" href="classPercussionOnsetDetector.html#a4f6954267696ee5bfa7dd1c4a6cfa92a">PercussionOnsetDetector::getInputDomain</a> </td>
Chris@1 394 <td>(</td>
Chris@1 395 <td class="paramname"></td><td>)</td>
Chris@1 396 <td> const<code> [inline, virtual]</code></td>
Chris@1 397 </tr>
Chris@1 398 </table>
Chris@1 399 </div>
Chris@1 400 <div class="memdoc">
Chris@1 401
Chris@1 402 <p>Get the plugin's required input domain. </p>
Chris@1 403 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" 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.</p>
Chris@1 404 <p>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#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. 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. </p>
Chris@1 405
Chris@1 406 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
Chris@1 407
Chris@1 408 <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>
Chris@1 409
Chris@1 410 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::FrequencyDomain</a>.</p>
Chris@1 411
Chris@1 412 </div>
Chris@1 413 </div>
Chris@3 414 <a class="anchor" id="a267c83a7533146c127e2c3be310e0154"></a>
Chris@1 415 <div class="memitem">
Chris@1 416 <div class="memproto">
Chris@1 417 <table class="memname">
Chris@1 418 <tr>
Chris@3 419 <td class="memname">string <a class="el" href="classPercussionOnsetDetector.html#a267c83a7533146c127e2c3be310e0154">PercussionOnsetDetector::getIdentifier</a> </td>
Chris@1 420 <td>(</td>
Chris@1 421 <td class="paramname"></td><td>)</td>
Chris@1 422 <td> const<code> [virtual]</code></td>
Chris@1 423 </tr>
Chris@1 424 </table>
Chris@1 425 </div>
Chris@1 426 <div class="memdoc">
Chris@1 427
Chris@1 428 <p>Get the computer-usable name of the plugin. </p>
Chris@1 429 <p>This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.</p>
Chris@1 430 <p>This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).</p>
Chris@1 431 <p>Example: "zero_crossings" </p>
Chris@1 432
Chris@1 433 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
Chris@1 434
Chris@1 435 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00065">65</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 436
Chris@1 437 </div>
Chris@1 438 </div>
Chris@3 439 <a class="anchor" id="aa98f1ad061a11af98c054011a8844e6f"></a>
Chris@1 440 <div class="memitem">
Chris@1 441 <div class="memproto">
Chris@1 442 <table class="memname">
Chris@1 443 <tr>
Chris@3 444 <td class="memname">string <a class="el" href="classPercussionOnsetDetector.html#aa98f1ad061a11af98c054011a8844e6f">PercussionOnsetDetector::getName</a> </td>
Chris@1 445 <td>(</td>
Chris@1 446 <td class="paramname"></td><td>)</td>
Chris@1 447 <td> const<code> [virtual]</code></td>
Chris@1 448 </tr>
Chris@1 449 </table>
Chris@1 450 </div>
Chris@1 451 <div class="memdoc">
Chris@1 452
Chris@1 453 <p>Get a human-readable name or title of the plugin. </p>
Chris@1 454 <p>This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").</p>
Chris@1 455 <p>Example: "Zero Crossings" </p>
Chris@1 456
Chris@1 457 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
Chris@1 458
Chris@1 459 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00071">71</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 460
Chris@1 461 </div>
Chris@1 462 </div>
Chris@3 463 <a class="anchor" id="a9061d189705802a48973a7ccab6360db"></a>
Chris@1 464 <div class="memitem">
Chris@1 465 <div class="memproto">
Chris@1 466 <table class="memname">
Chris@1 467 <tr>
Chris@3 468 <td class="memname">string <a class="el" href="classPercussionOnsetDetector.html#a9061d189705802a48973a7ccab6360db">PercussionOnsetDetector::getDescription</a> </td>
Chris@1 469 <td>(</td>
Chris@1 470 <td class="paramname"></td><td>)</td>
Chris@1 471 <td> const<code> [virtual]</code></td>
Chris@1 472 </tr>
Chris@1 473 </table>
Chris@1 474 </div>
Chris@1 475 <div class="memdoc">
Chris@1 476
Chris@1 477 <p>Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p>
Chris@1 478 <p>May be empty if the name has said it all already.</p>
Chris@1 479 <p>Example: "Detect and count zero crossing points" </p>
Chris@1 480
Chris@1 481 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
Chris@1 482
Chris@1 483 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00077">77</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 484
Chris@1 485 </div>
Chris@1 486 </div>
Chris@3 487 <a class="anchor" id="a63d63f2cb7ea8d8b09d58cc13b541375"></a>
Chris@1 488 <div class="memitem">
Chris@1 489 <div class="memproto">
Chris@1 490 <table class="memname">
Chris@1 491 <tr>
Chris@3 492 <td class="memname">string <a class="el" href="classPercussionOnsetDetector.html#a63d63f2cb7ea8d8b09d58cc13b541375">PercussionOnsetDetector::getMaker</a> </td>
Chris@1 493 <td>(</td>
Chris@1 494 <td class="paramname"></td><td>)</td>
Chris@1 495 <td> const<code> [virtual]</code></td>
Chris@1 496 </tr>
Chris@1 497 </table>
Chris@1 498 </div>
Chris@1 499 <div class="memdoc">
Chris@1 500
Chris@1 501 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
Chris@1 502 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
Chris@1 503
Chris@1 504 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
Chris@1 505
Chris@1 506 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00083">83</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 507
Chris@1 508 </div>
Chris@1 509 </div>
Chris@3 510 <a class="anchor" id="ad6b818dbd81867ce7be71c99cae861be"></a>
Chris@1 511 <div class="memitem">
Chris@1 512 <div class="memproto">
Chris@1 513 <table class="memname">
Chris@1 514 <tr>
Chris@3 515 <td class="memname">int <a class="el" href="classPercussionOnsetDetector.html#ad6b818dbd81867ce7be71c99cae861be">PercussionOnsetDetector::getPluginVersion</a> </td>
Chris@1 516 <td>(</td>
Chris@1 517 <td class="paramname"></td><td>)</td>
Chris@1 518 <td> const<code> [virtual]</code></td>
Chris@1 519 </tr>
Chris@1 520 </table>
Chris@1 521 </div>
Chris@1 522 <div class="memdoc">
Chris@1 523
Chris@1 524 <p>Get the version number of the plugin. </p>
Chris@1 525
Chris@1 526 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
Chris@1 527
Chris@1 528 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00089">89</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 529
Chris@1 530 </div>
Chris@1 531 </div>
Chris@3 532 <a class="anchor" id="a1a22ece271330c94cc08798a77416351"></a>
Chris@1 533 <div class="memitem">
Chris@1 534 <div class="memproto">
Chris@1 535 <table class="memname">
Chris@1 536 <tr>
Chris@3 537 <td class="memname">string <a class="el" href="classPercussionOnsetDetector.html#a1a22ece271330c94cc08798a77416351">PercussionOnsetDetector::getCopyright</a> </td>
Chris@1 538 <td>(</td>
Chris@1 539 <td class="paramname"></td><td>)</td>
Chris@1 540 <td> const<code> [virtual]</code></td>
Chris@1 541 </tr>
Chris@1 542 </table>
Chris@1 543 </div>
Chris@1 544 <div class="memdoc">
Chris@1 545
Chris@1 546 <p>Get the copyright statement or licensing summary for the plugin. </p>
Chris@1 547 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
Chris@1 548
Chris@1 549 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
Chris@1 550
Chris@1 551 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00095">95</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 552
Chris@1 553 </div>
Chris@1 554 </div>
Chris@3 555 <a class="anchor" id="a733824891e11c306a7a678534b89b968"></a>
Chris@1 556 <div class="memitem">
Chris@1 557 <div class="memproto">
Chris@1 558 <table class="memname">
Chris@1 559 <tr>
Chris@3 560 <td class="memname">size_t <a class="el" href="classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968">PercussionOnsetDetector::getPreferredStepSize</a> </td>
Chris@1 561 <td>(</td>
Chris@1 562 <td class="paramname"></td><td>)</td>
Chris@1 563 <td> const<code> [virtual]</code></td>
Chris@1 564 </tr>
Chris@1 565 </table>
Chris@1 566 </div>
Chris@1 567 <div class="memdoc">
Chris@1 568
Chris@1 569 <p>Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function) for the plugin. </p>
Chris@1 570 <p>This should be called before <a class="el" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p>
Chris@1 571 <p>A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p>
Chris@1 572
Chris@1 573 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
Chris@1 574
Chris@1 575 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00101">101</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 576
Chris@1 577 </div>
Chris@1 578 </div>
Chris@3 579 <a class="anchor" id="a410c0b47c6c849d7ed9b726b84402ad0"></a>
Chris@1 580 <div class="memitem">
Chris@1 581 <div class="memproto">
Chris@1 582 <table class="memname">
Chris@1 583 <tr>
Chris@3 584 <td class="memname">size_t <a class="el" href="classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0">PercussionOnsetDetector::getPreferredBlockSize</a> </td>
Chris@1 585 <td>(</td>
Chris@1 586 <td class="paramname"></td><td>)</td>
Chris@1 587 <td> const<code> [virtual]</code></td>
Chris@1 588 </tr>
Chris@1 589 </table>
Chris@1 590 </div>
Chris@1 591 <div class="memdoc">
Chris@1 592
Chris@1 593 <p>Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function). </p>
Chris@1 594 <p>This should be called before <a class="el" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p>
Chris@1 595 <p>A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p>
Chris@1 596
Chris@1 597 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
Chris@1 598
Chris@1 599 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00107">107</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 600
Chris@1 601 </div>
Chris@1 602 </div>
Chris@3 603 <a class="anchor" id="abceae88cc9762b0ea310d7aad71de815"></a>
Chris@1 604 <div class="memitem">
Chris@1 605 <div class="memproto">
Chris@1 606 <table class="memname">
Chris@1 607 <tr>
Chris@3 608 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">PercussionOnsetDetector::ParameterList</a> <a class="el" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector::getParameterDescriptors</a> </td>
Chris@1 609 <td>(</td>
Chris@1 610 <td class="paramname"></td><td>)</td>
Chris@1 611 <td> const<code> [virtual]</code></td>
Chris@1 612 </tr>
Chris@1 613 </table>
Chris@1 614 </div>
Chris@1 615 <div class="memdoc">
Chris@1 616
Chris@1 617 <p>Get the controllable parameters of this plugin. </p>
Chris@1 618
Chris@1 619 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
Chris@1 620
Chris@1 621 <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>
Chris@1 622
Chris@3 623 <p>References <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00167">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00144">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00133">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00173">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00159">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00154">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00138">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00149">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p>
Chris@1 624
Chris@1 625 </div>
Chris@1 626 </div>
Chris@3 627 <a class="anchor" id="a9b28da8315fcde46ce7644d6592ba527"></a>
Chris@1 628 <div class="memitem">
Chris@1 629 <div class="memproto">
Chris@1 630 <table class="memname">
Chris@1 631 <tr>
Chris@3 632 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector::getParameter</a> </td>
Chris@1 633 <td>(</td>
Chris@1 634 <td class="paramtype">std::string&#160;</td>
Chris@1 635 <td class="paramname"></td><td>)</td>
Chris@1 636 <td> const<code> [virtual]</code></td>
Chris@1 637 </tr>
Chris@1 638 </table>
Chris@1 639 </div>
Chris@1 640 <div class="memdoc">
Chris@1 641
Chris@1 642 <p>Get the value of a named parameter. </p>
Chris@1 643 <p>The argument is the identifier field from that parameter's descriptor. </p>
Chris@1 644
Chris@1 645 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
Chris@1 646
Chris@1 647 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00174">174</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 648
Chris@1 649 <p>References <a class="el" href="PercussionOnsetDetector_8h_source.html#l00083">m_sensitivity</a>, and <a class="el" href="PercussionOnsetDetector_8h_source.html#l00082">m_threshold</a>.</p>
Chris@1 650
Chris@1 651 </div>
Chris@1 652 </div>
Chris@3 653 <a class="anchor" id="aa097d72488e1211f05fc661ff5c6dc01"></a>
Chris@1 654 <div class="memitem">
Chris@1 655 <div class="memproto">
Chris@1 656 <table class="memname">
Chris@1 657 <tr>
Chris@3 658 <td class="memname">void <a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector::setParameter</a> </td>
Chris@1 659 <td>(</td>
Chris@1 660 <td class="paramtype">std::string&#160;</td>
Chris@1 661 <td class="paramname">, </td>
Chris@1 662 </tr>
Chris@1 663 <tr>
Chris@1 664 <td class="paramkey"></td>
Chris@1 665 <td></td>
Chris@1 666 <td class="paramtype">float&#160;</td>
Chris@1 667 <td class="paramname">&#160;</td>
Chris@1 668 </tr>
Chris@1 669 <tr>
Chris@1 670 <td></td>
Chris@1 671 <td>)</td>
Chris@1 672 <td></td><td><code> [virtual]</code></td>
Chris@1 673 </tr>
Chris@1 674 </table>
Chris@1 675 </div>
Chris@1 676 <div class="memdoc">
Chris@1 677
Chris@1 678 <p>Set a named parameter. </p>
Chris@1 679 <p>The first argument is the identifier field from that parameter's descriptor. </p>
Chris@1 680
Chris@1 681 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
Chris@1 682
Chris@1 683 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00182">182</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 684
Chris@1 685 <p>References <a class="el" href="PercussionOnsetDetector_8h_source.html#l00083">m_sensitivity</a>, and <a class="el" href="PercussionOnsetDetector_8h_source.html#l00082">m_threshold</a>.</p>
Chris@1 686
Chris@1 687 </div>
Chris@1 688 </div>
Chris@3 689 <a class="anchor" id="aa4537aa0eb58a67d6e824d46924cf782"></a>
Chris@1 690 <div class="memitem">
Chris@1 691 <div class="memproto">
Chris@1 692 <table class="memname">
Chris@1 693 <tr>
Chris@3 694 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">PercussionOnsetDetector::OutputList</a> <a class="el" href="classPercussionOnsetDetector.html#aa4537aa0eb58a67d6e824d46924cf782">PercussionOnsetDetector::getOutputDescriptors</a> </td>
Chris@1 695 <td>(</td>
Chris@1 696 <td class="paramname"></td><td>)</td>
Chris@1 697 <td> const<code> [virtual]</code></td>
Chris@1 698 </tr>
Chris@1 699 </table>
Chris@1 700 </div>
Chris@1 701 <div class="memdoc">
Chris@1 702
Chris@1 703 <p>Get the outputs of this plugin. </p>
Chris@1 704 <p>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#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> call. </p>
Chris@1 705
Chris@1 706 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
Chris@1 707
Chris@1 708 <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>
Chris@1 709
Chris@1 710 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00247">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00227">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00239">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00260">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00214">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00278">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00220">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00290">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00285">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00314">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">Vamp::Plugin::OutputDescriptor::unit</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00296">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p>
Chris@1 711
Chris@1 712 </div>
Chris@1 713 </div>
Chris@3 714 <a class="anchor" id="adfd989812b3e0cb8f4b498f56a5a9614"></a>
Chris@1 715 <div class="memitem">
Chris@1 716 <div class="memproto">
Chris@1 717 <table class="memname">
Chris@1 718 <tr>
Chris@3 719 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a> <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614">PercussionOnsetDetector::process</a> </td>
Chris@1 720 <td>(</td>
Chris@1 721 <td class="paramtype">const float *const *&#160;</td>
Chris@1 722 <td class="paramname"><em>inputBuffers</em>, </td>
Chris@1 723 </tr>
Chris@1 724 <tr>
Chris@1 725 <td class="paramkey"></td>
Chris@1 726 <td></td>
Chris@1 727 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
Chris@1 728 <td class="paramname"><em>timestamp</em>&#160;</td>
Chris@1 729 </tr>
Chris@1 730 <tr>
Chris@1 731 <td></td>
Chris@1 732 <td>)</td>
Chris@1 733 <td></td><td><code> [virtual]</code></td>
Chris@1 734 </tr>
Chris@1 735 </table>
Chris@1 736 </div>
Chris@1 737 <div class="memdoc">
Chris@1 738
Chris@1 739 <p>Process a single block of input data. </p>
Chris@1 740 <p>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>
Chris@1 741 <p>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>
Chris@1 742 <p>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.) </p>
Chris@1 743
Chris@1 744 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
Chris@1 745
Chris@1 746 <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>
Chris@1 747
Chris@1 748 <p>References <a class="el" href="structVamp_1_1RealTime.html#a939b4b1d1ca190db69a418883f16ce8a">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">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#l00436">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#l00352">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00374">Vamp::Plugin::Feature::values</a>.</p>
Chris@1 749
Chris@1 750 </div>
Chris@1 751 </div>
Chris@3 752 <a class="anchor" id="ad3d6767ed137783e84f842b4d4732ffa"></a>
Chris@1 753 <div class="memitem">
Chris@1 754 <div class="memproto">
Chris@1 755 <table class="memname">
Chris@1 756 <tr>
Chris@3 757 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a> <a class="el" href="classPercussionOnsetDetector.html#ad3d6767ed137783e84f842b4d4732ffa">PercussionOnsetDetector::getRemainingFeatures</a> </td>
Chris@1 758 <td>(</td>
Chris@1 759 <td class="paramname"></td><td>)</td>
Chris@1 760 <td><code> [virtual]</code></td>
Chris@1 761 </tr>
Chris@1 762 </table>
Chris@1 763 </div>
Chris@1 764 <div class="memdoc">
Chris@1 765
Chris@1 766 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
Chris@1 767
Chris@1 768 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
Chris@1 769
Chris@1 770 <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>
Chris@1 771
Chris@1 772 </div>
Chris@1 773 </div>
Chris@3 774 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a>
Chris@1 775 <div class="memitem">
Chris@1 776 <div class="memproto">
Chris@1 777 <table class="memname">
Chris@1 778 <tr>
Chris@3 779 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin::getMinChannelCount</a> </td>
Chris@1 780 <td>(</td>
Chris@1 781 <td class="paramname"></td><td>)</td>
Chris@1 782 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 783 </tr>
Chris@1 784 </table>
Chris@1 785 </div>
Chris@1 786 <div class="memdoc">
Chris@1 787
Chris@1 788 <p>Get the minimum supported number of input channels. </p>
Chris@1 789
Chris@1 790 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 791
Chris@1 792 <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>
Chris@1 793
Chris@1 794 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::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>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
Chris@1 795
Chris@1 796 </div>
Chris@1 797 </div>
Chris@3 798 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a>
Chris@1 799 <div class="memitem">
Chris@1 800 <div class="memproto">
Chris@1 801 <table class="memname">
Chris@1 802 <tr>
Chris@3 803 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin::getMaxChannelCount</a> </td>
Chris@1 804 <td>(</td>
Chris@1 805 <td class="paramname"></td><td>)</td>
Chris@1 806 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 807 </tr>
Chris@1 808 </table>
Chris@1 809 </div>
Chris@1 810 <div class="memdoc">
Chris@1 811
Chris@1 812 <p>Get the maximum supported number of input channels. </p>
Chris@1 813
Chris@1 814 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 815
Chris@1 816 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 817
Chris@1 818 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::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>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
Chris@1 819
Chris@1 820 </div>
Chris@1 821 </div>
Chris@3 822 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a>
Chris@1 823 <div class="memitem">
Chris@1 824 <div class="memproto">
Chris@1 825 <table class="memname">
Chris@1 826 <tr>
Chris@3 827 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td>
Chris@1 828 <td>(</td>
Chris@1 829 <td class="paramname"></td><td>)</td>
Chris@1 830 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 831 </tr>
Chris@1 832 </table>
Chris@1 833 </div>
Chris@1 834 <div class="memdoc">
Chris@1 835
Chris@1 836 <p>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 from audio o...">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>. </p>
Chris@1 837 <p>Do not reimplement this function in your subclass. </p>
Chris@1 838
Chris@1 839 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
Chris@1 840
Chris@1 841 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00430">430</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 842
Chris@1 843 </div>
Chris@1 844 </div>
Chris@3 845 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a>
Chris@1 846 <div class="memitem">
Chris@1 847 <div class="memproto">
Chris@1 848 <table class="memname">
Chris@1 849 <tr>
Chris@3 850 <td class="memname">virtual unsigned int <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase::getVampApiVersion</a> </td>
Chris@1 851 <td>(</td>
Chris@1 852 <td class="paramname"></td><td>)</td>
Chris@1 853 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 854 </tr>
Chris@1 855 </table>
Chris@1 856 </div>
Chris@1 857 <div class="memdoc">
Chris@1 858
Chris@1 859 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
Chris@1 860
Chris@1 861 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 862
Chris@3 863 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 864
Chris@1 865 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
Chris@1 866
Chris@1 867 </div>
Chris@1 868 </div>
Chris@3 869 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a>
Chris@1 870 <div class="memitem">
Chris@1 871 <div class="memproto">
Chris@1 872 <table class="memname">
Chris@1 873 <tr>
Chris@3 874 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase::getPrograms</a> </td>
Chris@1 875 <td>(</td>
Chris@1 876 <td class="paramname"></td><td>)</td>
Chris@1 877 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 878 </tr>
Chris@1 879 </table>
Chris@1 880 </div>
Chris@1 881 <div class="memdoc">
Chris@1 882
Chris@1 883 <p>Get the program settings available in this plugin. </p>
Chris@1 884 <p>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>
Chris@1 885 <p>The programs must have unique names. </p>
Chris@1 886
Chris@1 887 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 888
Chris@3 889 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00233">233</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 890
Chris@1 891 </div>
Chris@1 892 </div>
Chris@3 893 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a>
Chris@1 894 <div class="memitem">
Chris@1 895 <div class="memproto">
Chris@1 896 <table class="memname">
Chris@1 897 <tr>
Chris@3 898 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase::getCurrentProgram</a> </td>
Chris@1 899 <td>(</td>
Chris@1 900 <td class="paramname"></td><td>)</td>
Chris@1 901 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 902 </tr>
Chris@1 903 </table>
Chris@1 904 </div>
Chris@1 905 <div class="memdoc">
Chris@1 906
Chris@1 907 <p>Get the current program. </p>
Chris@1 908
Chris@1 909 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 910
Chris@3 911 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00238">238</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 912
Chris@1 913 </div>
Chris@1 914 </div>
Chris@3 915 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a>
Chris@1 916 <div class="memitem">
Chris@1 917 <div class="memproto">
Chris@1 918 <table class="memname">
Chris@1 919 <tr>
Chris@3 920 <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase::selectProgram</a> </td>
Chris@1 921 <td>(</td>
Chris@1 922 <td class="paramtype">std::string&#160;</td>
Chris@1 923 <td class="paramname"></td><td>)</td>
Chris@1 924 <td><code> [inline, virtual, inherited]</code></td>
Chris@1 925 </tr>
Chris@1 926 </table>
Chris@1 927 </div>
Chris@1 928 <div class="memdoc">
Chris@1 929
Chris@1 930 <p>Select a program. </p>
Chris@1 931 <p>(If the given program name is not one of the available programs, do nothing.) </p>
Chris@1 932
Chris@1 933 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 934
Chris@3 935 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00244">244</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 936
Chris@1 937 </div>
Chris@1 938 </div>
Chris@1 939 <hr/><h2>Member Data Documentation</h2>
Chris@3 940 <a class="anchor" id="aabac0cf7e961482b075777e5f0686e6c"></a>
Chris@1 941 <div class="memitem">
Chris@1 942 <div class="memproto">
Chris@1 943 <table class="memname">
Chris@1 944 <tr>
Chris@1 945 <td class="memname">size_t <a class="el" href="classPercussionOnsetDetector.html#aabac0cf7e961482b075777e5f0686e6c">PercussionOnsetDetector::m_stepSize</a><code> [protected]</code></td>
Chris@1 946 </tr>
Chris@1 947 </table>
Chris@1 948 </div>
Chris@1 949 <div class="memdoc">
Chris@1 950
Chris@1 951 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00079">79</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 952
Chris@1 953 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>.</p>
Chris@1 954
Chris@1 955 </div>
Chris@1 956 </div>
Chris@3 957 <a class="anchor" id="a920de543dbcf70a2edd80b5b31313285"></a>
Chris@1 958 <div class="memitem">
Chris@1 959 <div class="memproto">
Chris@1 960 <table class="memname">
Chris@1 961 <tr>
Chris@1 962 <td class="memname">size_t <a class="el" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">PercussionOnsetDetector::m_blockSize</a><code> [protected]</code></td>
Chris@1 963 </tr>
Chris@1 964 </table>
Chris@1 965 </div>
Chris@1 966 <div class="memdoc">
Chris@1 967
Chris@1 968 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00080">80</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 969
Chris@1 970 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">reset()</a>.</p>
Chris@1 971
Chris@1 972 </div>
Chris@1 973 </div>
Chris@3 974 <a class="anchor" id="ab04119adad56d87f2e633de289aab507"></a>
Chris@1 975 <div class="memitem">
Chris@1 976 <div class="memproto">
Chris@1 977 <table class="memname">
Chris@1 978 <tr>
Chris@1 979 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#ab04119adad56d87f2e633de289aab507">PercussionOnsetDetector::m_threshold</a><code> [protected]</code></td>
Chris@1 980 </tr>
Chris@1 981 </table>
Chris@1 982 </div>
Chris@1 983 <div class="memdoc">
Chris@1 984
Chris@1 985 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00082">82</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 986
Chris@1 987 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00174">getParameter()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00182">setParameter()</a>.</p>
Chris@1 988
Chris@1 989 </div>
Chris@1 990 </div>
Chris@3 991 <a class="anchor" id="a4e9770f246ba3bc75e7fc2cb8f9010af"></a>
Chris@1 992 <div class="memitem">
Chris@1 993 <div class="memproto">
Chris@1 994 <table class="memname">
Chris@1 995 <tr>
Chris@1 996 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#a4e9770f246ba3bc75e7fc2cb8f9010af">PercussionOnsetDetector::m_sensitivity</a><code> [protected]</code></td>
Chris@1 997 </tr>
Chris@1 998 </table>
Chris@1 999 </div>
Chris@1 1000 <div class="memdoc">
Chris@1 1001
Chris@1 1002 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00083">83</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1003
Chris@1 1004 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00174">getParameter()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00182">setParameter()</a>.</p>
Chris@1 1005
Chris@1 1006 </div>
Chris@1 1007 </div>
Chris@3 1008 <a class="anchor" id="a30daa717267251a9d49afe57c328e989"></a>
Chris@1 1009 <div class="memitem">
Chris@1 1010 <div class="memproto">
Chris@1 1011 <table class="memname">
Chris@1 1012 <tr>
Chris@1 1013 <td class="memname">float* <a class="el" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">PercussionOnsetDetector::m_priorMagnitudes</a><code> [protected]</code></td>
Chris@1 1014 </tr>
Chris@1 1015 </table>
Chris@1 1016 </div>
Chris@1 1017 <div class="memdoc">
Chris@1 1018
Chris@1 1019 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00084">84</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1020
Chris@1 1021 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">reset()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00059">~PercussionOnsetDetector()</a>.</p>
Chris@1 1022
Chris@1 1023 </div>
Chris@1 1024 </div>
Chris@3 1025 <a class="anchor" id="acd80162c65212be7fa91251263fb9c3d"></a>
Chris@1 1026 <div class="memitem">
Chris@1 1027 <div class="memproto">
Chris@1 1028 <table class="memname">
Chris@1 1029 <tr>
Chris@1 1030 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">PercussionOnsetDetector::m_dfMinus1</a><code> [protected]</code></td>
Chris@1 1031 </tr>
Chris@1 1032 </table>
Chris@1 1033 </div>
Chris@1 1034 <div class="memdoc">
Chris@1 1035
Chris@1 1036 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00085">85</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1037
Chris@1 1038 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">reset()</a>.</p>
Chris@1 1039
Chris@1 1040 </div>
Chris@1 1041 </div>
Chris@3 1042 <a class="anchor" id="a6ad7d8353cc681ff42a63b127cca5779"></a>
Chris@1 1043 <div class="memitem">
Chris@1 1044 <div class="memproto">
Chris@1 1045 <table class="memname">
Chris@1 1046 <tr>
Chris@1 1047 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#a6ad7d8353cc681ff42a63b127cca5779">PercussionOnsetDetector::m_dfMinus2</a><code> [protected]</code></td>
Chris@1 1048 </tr>
Chris@1 1049 </table>
Chris@1 1050 </div>
Chris@1 1051 <div class="memdoc">
Chris@1 1052
Chris@1 1053 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00086">86</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1054
Chris@1 1055 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">reset()</a>.</p>
Chris@1 1056
Chris@1 1057 </div>
Chris@1 1058 </div>
Chris@3 1059 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
Chris@1 1060 <div class="memitem">
Chris@1 1061 <div class="memproto">
Chris@1 1062 <table class="memname">
Chris@1 1063 <tr>
Chris@1 1064 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
Chris@1 1065 </tr>
Chris@1 1066 </table>
Chris@1 1067 </div>
Chris@1 1068 <div class="memdoc">
Chris@1 1069
Chris@1 1070 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">436</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1071
Chris@1 1072 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00375">FixedTempoEstimator::D::calculate()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <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="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p>
Chris@1 1073
Chris@1 1074 </div>
Chris@1 1075 </div>
Chris@1 1076 <hr/>The documentation for this class was generated from the following files:<ul>
Chris@1 1077 <li><a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a></li>
Chris@1 1078 <li><a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a></li>
Chris@1 1079 </ul>
Chris@3 1080 </div><!-- contents -->
Chris@1 1081 </div>
Chris@1 1082 <div id="nav-path" class="navpath">
Chris@1 1083 <ul>
Chris@1 1084 <li class="navelem"><a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a> </li>
Chris@1 1085
Chris@3 1086 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
Chris@1 1087 <a href="http://www.doxygen.org/index.html">
Chris@3 1088 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
Chris@1 1089 </ul>
Chris@1 1090 </div>
Chris@1 1091
Chris@1 1092
Chris@1 1093 </body>
Chris@1 1094 </html>