Mercurial > hg > vamp-docs

comparison code-docs/classPercussionOnsetDetector.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

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