Mercurial > hg > vamp-website

comparison code-doc/classPercussionOnsetDetector.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children cc0be37dc9d3
comparison
equal deleted inserted replaced
-1:000000000000 0:351c4ebce5f9
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: PercussionOnsetDetector Class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul>
17 </div>
18 <div class="tabs">
19 <ul>
20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23 </ul>
24 </div>
25 </div>
26 <div class="contents">
27 <h1>PercussionOnsetDetector Class Reference</h1><!-- doxytag: class="PercussionOnsetDetector" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include &lt;<a class="el" href="PercussionOnsetDetector_8h-source.html">PercussionOnsetDetector.h</a>&gt;</code>
28 <p>
29 <div class="dynheader">
30 Inheritance diagram for PercussionOnsetDetector:</div>
31 <div class="dynsection">
32 <p><center><img src="classPercussionOnsetDetector__inherit__graph.png" border="0" usemap="#PercussionOnsetDetector__inherit__map" alt="Inheritance graph"></center>
33 <map name="PercussionOnsetDetector__inherit__map">
34 <area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="41,82,140,106"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="27,7,155,31"></map>
35 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
36
37 <p>
38 <a href="classPercussionOnsetDetector-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
39 Example plugin that detects percussive events.
40 <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>
41 <table border="0" cellpadding="0" cellspacing="0">
42 <tr><td></td></tr>
43 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
45 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
46 }</td></tr>
47
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
49 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
50
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
52
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br>
54 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
55
56 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
57 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
58
59 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
60
61 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#9f700579805ee5105758d847baab3511">PercussionOnsetDetector</a> (float inputSampleRate)</td></tr>
63
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#99f833667cf8185e879d735216c7642b">~PercussionOnsetDetector</a> ()</td></tr>
65
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#349c528260622308f3850bcda8a448ab">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
67
68 <tr><td class="mdescLeft">&nbsp;</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="#349c528260622308f3850bcda8a448ab"></a><br></td></tr>
69 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#9b1075e992cd9599764ef3881fb91d1a">reset</a> ()</td></tr>
70
71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#9b1075e992cd9599764ef3881fb91d1a"></a><br></td></tr>
72 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#4f6954267696ee5bfa7dd1c4a6cfa92a">getInputDomain</a> () const </td></tr>
73
74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#4f6954267696ee5bfa7dd1c4a6cfa92a"></a><br></td></tr>
75 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#267c83a7533146c127e2c3be310e0154">getIdentifier</a> () const </td></tr>
76
77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#267c83a7533146c127e2c3be310e0154"></a><br></td></tr>
78 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a98f1ad061a11af98c054011a8844e6f">getName</a> () const </td></tr>
79
80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a98f1ad061a11af98c054011a8844e6f"></a><br></td></tr>
81 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#9061d189705802a48973a7ccab6360db">getDescription</a> () const </td></tr>
82
83 <tr><td class="mdescLeft">&nbsp;</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="#9061d189705802a48973a7ccab6360db"></a><br></td></tr>
84 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#63d63f2cb7ea8d8b09d58cc13b541375">getMaker</a> () const </td></tr>
85
86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#63d63f2cb7ea8d8b09d58cc13b541375"></a><br></td></tr>
87 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#d6b818dbd81867ce7be71c99cae861be">getPluginVersion</a> () const </td></tr>
88
89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#d6b818dbd81867ce7be71c99cae861be"></a><br></td></tr>
90 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#1a22ece271330c94cc08798a77416351">getCopyright</a> () const </td></tr>
91
92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#1a22ece271330c94cc08798a77416351"></a><br></td></tr>
93 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#733824891e11c306a7a678534b89b968">getPreferredStepSize</a> () const </td></tr>
94
95 <tr><td class="mdescLeft">&nbsp;</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#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#733824891e11c306a7a678534b89b968"></a><br></td></tr>
96 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#410c0b47c6c849d7ed9b726b84402ad0">getPreferredBlockSize</a> () const </td></tr>
97
98 <tr><td class="mdescLeft">&nbsp;</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#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function). <a href="#410c0b47c6c849d7ed9b726b84402ad0"></a><br></td></tr>
99 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#bceae88cc9762b0ea310d7aad71de815">getParameterDescriptors</a> () const </td></tr>
100
101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#bceae88cc9762b0ea310d7aad71de815"></a><br></td></tr>
102 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#9b28da8315fcde46ce7644d6592ba527">getParameter</a> (std::string id) const </td></tr>
103
104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#9b28da8315fcde46ce7644d6592ba527"></a><br></td></tr>
105 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a097d72488e1211f05fc661ff5c6dc01">setParameter</a> (std::string id, float value)</td></tr>
106
107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#a097d72488e1211f05fc661ff5c6dc01"></a><br></td></tr>
108 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a4537aa0eb58a67d6e824d46924cf782">getOutputDescriptors</a> () const </td></tr>
109
110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a4537aa0eb58a67d6e824d46924cf782"></a><br></td></tr>
111 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
112
113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#dfd989812b3e0cb8f4b498f56a5a9614"></a><br></td></tr>
114 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#d3d6767ed137783e84f842b4d4732ffa">getRemainingFeatures</a> ()</td></tr>
115
116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#d3d6767ed137783e84f842b4d4732ffa"></a><br></td></tr>
117 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr>
118
119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#267b42e866df3cf0d190893e8096f525"></a><br></td></tr>
120 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr>
121
122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br></td></tr>
123 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
124
125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
126 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr>
127
128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin. <a href="#8fd2c48291c64b790f0efb8948508dcf"></a><br></td></tr>
129 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr>
130
131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#bb307c60bdb981d5f5af50c3c4ae84af"></a><br></td></tr>
132 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr>
133
134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#24e77eccf1bdfbbca3c79bb25e8799b3"></a><br></td></tr>
135 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
136
137 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#add3a547ef140bae200473a9518e3353"></a><br></td></tr>
138 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
139 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#abac0cf7e961482b075777e5f0686e6c">m_stepSize</a></td></tr>
140
141 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#920de543dbcf70a2edd80b5b31313285">m_blockSize</a></td></tr>
142
143 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#b04119adad56d87f2e633de289aab507">m_threshold</a></td></tr>
144
145 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#4e9770f246ba3bc75e7fc2cb8f9010af">m_sensitivity</a></td></tr>
146
147 <tr><td class="memItemLeft" nowrap align="right" valign="top">float *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a></td></tr>
148
149 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#cd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a></td></tr>
150
151 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#6ad7d8353cc681ff42a63b127cca5779">m_dfMinus2</a></td></tr>
152
153 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
154
155 </table>
156 <hr><h2>Member Typedef Documentation</h2>
157 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="PercussionOnsetDetector::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
158 <div class="memitem">
159 <div class="memproto">
160 <table class="memname">
161 <tr>
162 <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#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td>
163 </tr>
164 </table>
165 </div>
166 <div class="memdoc">
167
168 <p>
169
170 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00309">309</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
171
172 </div>
173 </div><p>
174 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="PercussionOnsetDetector::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
175 <div class="memitem">
176 <div class="memproto">
177 <table class="memname">
178 <tr>
179 <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#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td>
180 </tr>
181 </table>
182 </div>
183 <div class="memdoc">
184
185 <p>
186
187 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
188
189 </div>
190 </div><p>
191 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="PercussionOnsetDetector::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
192 <div class="memitem">
193 <div class="memproto">
194 <table class="memname">
195 <tr>
196 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td>
197 </tr>
198 </table>
199 </div>
200 <div class="memdoc">
201
202 <p>
203
204 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00348">348</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
205
206 </div>
207 </div><p>
208 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="PercussionOnsetDetector::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
209 <div class="memitem">
210 <div class="memproto">
211 <table class="memname">
212 <tr>
213 <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#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td>
214 </tr>
215 </table>
216 </div>
217 <div class="memdoc">
218
219 <p>
220
221 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00195">195</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
222
223 </div>
224 </div><p>
225 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="PercussionOnsetDetector::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
226 <div class="memitem">
227 <div class="memproto">
228 <table class="memname">
229 <tr>
230 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td>
231 </tr>
232 </table>
233 </div>
234 <div class="memdoc">
235
236 <p>
237
238 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00217">217</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
239
240 </div>
241 </div><p>
242 <hr><h2>Member Enumeration Documentation</h2>
243 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="PercussionOnsetDetector::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
244 <div class="memitem">
245 <div class="memproto">
246 <table class="memname">
247 <tr>
248 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
249 </tr>
250 </table>
251 </div>
252 <div class="memdoc">
253
254 <p>
255 <dl compact><dt><b>Enumerator: </b></dt><dd>
256 <table border="0" cellspacing="2" cellpadding="0">
257 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
258 </td></tr>
259 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
260 </td></tr>
261 </table>
262 </dl>
263
264 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00149">149</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
265
266 </div>
267 </div><p>
268 <hr><h2>Constructor &amp; Destructor Documentation</h2>
269 <a class="anchor" name="9f700579805ee5105758d847baab3511"></a><!-- doxytag: member="PercussionOnsetDetector::PercussionOnsetDetector" ref="9f700579805ee5105758d847baab3511" args="(float inputSampleRate)" -->
270 <div class="memitem">
271 <div class="memproto">
272 <table class="memname">
273 <tr>
274 <td class="memname">PercussionOnsetDetector::PercussionOnsetDetector </td>
275 <td>(</td>
276 <td class="paramtype">float&nbsp;</td>
277 <td class="paramname"> <em>inputSampleRate</em> </td>
278 <td>&nbsp;)&nbsp;</td>
279 <td width="100%"></td>
280 </tr>
281 </table>
282 </div>
283 <div class="memdoc">
284
285 <p>
286
287 <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>
288
289 </div>
290 </div><p>
291 <a class="anchor" name="99f833667cf8185e879d735216c7642b"></a><!-- doxytag: member="PercussionOnsetDetector::~PercussionOnsetDetector" ref="99f833667cf8185e879d735216c7642b" args="()" -->
292 <div class="memitem">
293 <div class="memproto">
294 <table class="memname">
295 <tr>
296 <td class="memname">PercussionOnsetDetector::~PercussionOnsetDetector </td>
297 <td>(</td>
298 <td class="paramname"> </td>
299 <td>&nbsp;)&nbsp;</td>
300 <td width="100%"><code> [virtual]</code></td>
301 </tr>
302 </table>
303 </div>
304 <div class="memdoc">
305
306 <p>
307
308 <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>
309
310 <p>References <a class="el" href="PercussionOnsetDetector_8h-source.html#l00084">m_priorMagnitudes</a>.</p>
311
312 </div>
313 </div><p>
314 <hr><h2>Member Function Documentation</h2>
315 <a class="anchor" name="349c528260622308f3850bcda8a448ab"></a><!-- doxytag: member="PercussionOnsetDetector::initialise" ref="349c528260622308f3850bcda8a448ab" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
316 <div class="memitem">
317 <div class="memproto">
318 <table class="memname">
319 <tr>
320 <td class="memname">bool PercussionOnsetDetector::initialise </td>
321 <td>(</td>
322 <td class="paramtype">size_t&nbsp;</td>
323 <td class="paramname"> <em>inputChannels</em>, </td>
324 </tr>
325 <tr>
326 <td class="paramkey"></td>
327 <td></td>
328 <td class="paramtype">size_t&nbsp;</td>
329 <td class="paramname"> <em>stepSize</em>, </td>
330 </tr>
331 <tr>
332 <td class="paramkey"></td>
333 <td></td>
334 <td class="paramtype">size_t&nbsp;</td>
335 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
336 </tr>
337 <tr>
338 <td></td>
339 <td>)</td>
340 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
341 </tr>
342 </table>
343 </div>
344 <div class="memdoc">
345
346 <p>
347 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).
348 <p>
349 The input sample rate should have been already specified at construction time.<p>
350 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
351 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
352
353 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">113</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p>
354
355 <p>References <a class="el" href="Plugin_8h-source.html#l00196">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="Plugin_8h-source.html#l00191">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00086">m_dfMinus2</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00084">m_priorMagnitudes</a>, and <a class="el" href="PercussionOnsetDetector_8h-source.html#l00079">m_stepSize</a>.</p>
356
357 </div>
358 </div><p>
359 <a class="anchor" name="9b1075e992cd9599764ef3881fb91d1a"></a><!-- doxytag: member="PercussionOnsetDetector::reset" ref="9b1075e992cd9599764ef3881fb91d1a" args="()" -->
360 <div class="memitem">
361 <div class="memproto">
362 <table class="memname">
363 <tr>
364 <td class="memname">void PercussionOnsetDetector::reset </td>
365 <td>(</td>
366 <td class="paramname"> </td>
367 <td>&nbsp;)&nbsp;</td>
368 <td width="100%"><code> [virtual]</code></td>
369 </tr>
370 </table>
371 </div>
372 <div class="memdoc">
373
374 <p>
375 Reset the plugin after use, to prepare it for another clean run.
376 <p>
377 Not called for the first initialisation (i.e. initialise must also do a reset).
378 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
379
380 <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>
381
382 <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>
383
384 </div>
385 </div><p>
386 <a class="anchor" name="4f6954267696ee5bfa7dd1c4a6cfa92a"></a><!-- doxytag: member="PercussionOnsetDetector::getInputDomain" ref="4f6954267696ee5bfa7dd1c4a6cfa92a" args="() const " -->
387 <div class="memitem">
388 <div class="memproto">
389 <table class="memname">
390 <tr>
391 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> PercussionOnsetDetector::getInputDomain </td>
392 <td>(</td>
393 <td class="paramname"> </td>
394 <td>&nbsp;)&nbsp;</td>
395 <td width="100%"> const<code> [inline, virtual]</code></td>
396 </tr>
397 </table>
398 </div>
399 <div class="memdoc">
400
401 <p>
402 Get the plugin's required input domain.
403 <p>
404 If this is TimeDomain, the samples provided to the <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window.
405 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
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="Plugin_8h-source.html#l00149">Vamp::Plugin::FrequencyDomain</a>.</p>
410
411 </div>
412 </div><p>
413 <a class="anchor" name="267c83a7533146c127e2c3be310e0154"></a><!-- doxytag: member="PercussionOnsetDetector::getIdentifier" ref="267c83a7533146c127e2c3be310e0154" 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>
421 <td>&nbsp;)&nbsp;</td>
422 <td width="100%"> const<code> [virtual]</code></td>
423 </tr>
424 </table>
425 </div>
426 <div class="memdoc">
427
428 <p>
429 Get the computer-usable name of the plugin.
430 <p>
431 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>
432 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>
433 Example: "zero_crossings"
434 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
435
436 <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>
437
438 </div>
439 </div><p>
440 <a class="anchor" name="a98f1ad061a11af98c054011a8844e6f"></a><!-- doxytag: member="PercussionOnsetDetector::getName" ref="a98f1ad061a11af98c054011a8844e6f" args="() const " -->
441 <div class="memitem">
442 <div class="memproto">
443 <table class="memname">
444 <tr>
445 <td class="memname">string PercussionOnsetDetector::getName </td>
446 <td>(</td>
447 <td class="paramname"> </td>
448 <td>&nbsp;)&nbsp;</td>
449 <td width="100%"> const<code> [virtual]</code></td>
450 </tr>
451 </table>
452 </div>
453 <div class="memdoc">
454
455 <p>
456 Get a human-readable name or title of the plugin.
457 <p>
458 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>
459 Example: "Zero Crossings"
460 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
461
462 <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>
463
464 </div>
465 </div><p>
466 <a class="anchor" name="9061d189705802a48973a7ccab6360db"></a><!-- doxytag: member="PercussionOnsetDetector::getDescription" ref="9061d189705802a48973a7ccab6360db" args="() const " -->
467 <div class="memitem">
468 <div class="memproto">
469 <table class="memname">
470 <tr>
471 <td class="memname">string PercussionOnsetDetector::getDescription </td>
472 <td>(</td>
473 <td class="paramname"> </td>
474 <td>&nbsp;)&nbsp;</td>
475 <td width="100%"> const<code> [virtual]</code></td>
476 </tr>
477 </table>
478 </div>
479 <div class="memdoc">
480
481 <p>
482 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".
483 <p>
484 May be empty if the name has said it all already.<p>
485 Example: "Detect and count zero crossing points"
486 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
487
488 <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>
489
490 </div>
491 </div><p>
492 <a class="anchor" name="63d63f2cb7ea8d8b09d58cc13b541375"></a><!-- doxytag: member="PercussionOnsetDetector::getMaker" ref="63d63f2cb7ea8d8b09d58cc13b541375" args="() const " -->
493 <div class="memitem">
494 <div class="memproto">
495 <table class="memname">
496 <tr>
497 <td class="memname">string PercussionOnsetDetector::getMaker </td>
498 <td>(</td>
499 <td class="paramname"> </td>
500 <td>&nbsp;)&nbsp;</td>
501 <td width="100%"> const<code> [virtual]</code></td>
502 </tr>
503 </table>
504 </div>
505 <div class="memdoc">
506
507 <p>
508 Get the name of the author or vendor of the plugin in human-readable form.
509 <p>
510 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
511 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
512
513 <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>
514
515 </div>
516 </div><p>
517 <a class="anchor" name="d6b818dbd81867ce7be71c99cae861be"></a><!-- doxytag: member="PercussionOnsetDetector::getPluginVersion" ref="d6b818dbd81867ce7be71c99cae861be" args="() const " -->
518 <div class="memitem">
519 <div class="memproto">
520 <table class="memname">
521 <tr>
522 <td class="memname">int PercussionOnsetDetector::getPluginVersion </td>
523 <td>(</td>
524 <td class="paramname"> </td>
525 <td>&nbsp;)&nbsp;</td>
526 <td width="100%"> const<code> [virtual]</code></td>
527 </tr>
528 </table>
529 </div>
530 <div class="memdoc">
531
532 <p>
533 Get the version number of the plugin.
534 <p>
535
536 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
537
538 <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>
539
540 </div>
541 </div><p>
542 <a class="anchor" name="1a22ece271330c94cc08798a77416351"></a><!-- doxytag: member="PercussionOnsetDetector::getCopyright" ref="1a22ece271330c94cc08798a77416351" args="() const " -->
543 <div class="memitem">
544 <div class="memproto">
545 <table class="memname">
546 <tr>
547 <td class="memname">string PercussionOnsetDetector::getCopyright </td>
548 <td>(</td>
549 <td class="paramname"> </td>
550 <td>&nbsp;)&nbsp;</td>
551 <td width="100%"> const<code> [virtual]</code></td>
552 </tr>
553 </table>
554 </div>
555 <div class="memdoc">
556
557 <p>
558 Get the copyright statement or licensing summary for the plugin.
559 <p>
560 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
561 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
562
563 <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>
564
565 </div>
566 </div><p>
567 <a class="anchor" name="733824891e11c306a7a678534b89b968"></a><!-- doxytag: member="PercussionOnsetDetector::getPreferredStepSize" ref="733824891e11c306a7a678534b89b968" args="() const " -->
568 <div class="memitem">
569 <div class="memproto">
570 <table class="memname">
571 <tr>
572 <td class="memname">size_t PercussionOnsetDetector::getPreferredStepSize </td>
573 <td>(</td>
574 <td class="paramname"> </td>
575 <td>&nbsp;)&nbsp;</td>
576 <td width="100%"> const<code> [virtual]</code></td>
577 </tr>
578 </table>
579 </div>
580 <div class="memdoc">
581
582 <p>
583 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#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function) for the plugin.
584 <p>
585 This should be called before <a class="el" href="classPercussionOnsetDetector.html#349c528260622308f3850bcda8a448ab" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
586 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#349c528260622308f3850bcda8a448ab" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
587 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
588
589 <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>
590
591 </div>
592 </div><p>
593 <a class="anchor" name="410c0b47c6c849d7ed9b726b84402ad0"></a><!-- doxytag: member="PercussionOnsetDetector::getPreferredBlockSize" ref="410c0b47c6c849d7ed9b726b84402ad0" args="() const " -->
594 <div class="memitem">
595 <div class="memproto">
596 <table class="memname">
597 <tr>
598 <td class="memname">size_t PercussionOnsetDetector::getPreferredBlockSize </td>
599 <td>(</td>
600 <td class="paramname"> </td>
601 <td>&nbsp;)&nbsp;</td>
602 <td width="100%"> const<code> [virtual]</code></td>
603 </tr>
604 </table>
605 </div>
606 <div class="memdoc">
607
608 <p>
609 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> function).
610 <p>
611 This should be called before <a class="el" href="classPercussionOnsetDetector.html#349c528260622308f3850bcda8a448ab" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
612 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#349c528260622308f3850bcda8a448ab" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
613 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
614
615 <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>
616
617 </div>
618 </div><p>
619 <a class="anchor" name="bceae88cc9762b0ea310d7aad71de815"></a><!-- doxytag: member="PercussionOnsetDetector::getParameterDescriptors" ref="bceae88cc9762b0ea310d7aad71de815" args="() const " -->
620 <div class="memitem">
621 <div class="memproto">
622 <table class="memname">
623 <tr>
624 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PercussionOnsetDetector::ParameterList</a> PercussionOnsetDetector::getParameterDescriptors </td>
625 <td>(</td>
626 <td class="paramname"> </td>
627 <td>&nbsp;)&nbsp;</td>
628 <td width="100%"> const<code> [virtual]</code></td>
629 </tr>
630 </table>
631 </div>
632 <div class="memdoc">
633
634 <p>
635 Get the controllable parameters of this plugin.
636 <p>
637
638 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
639
640 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">145</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p>
641
642 <p>References <a class="el" href="PluginBase_8h-source.html#l00166">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="PluginBase_8h-source.html#l00143">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="PluginBase_8h-source.html#l00132">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="PluginBase_8h-source.html#l00172">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="PluginBase_8h-source.html#l00158">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="PluginBase_8h-source.html#l00153">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="PluginBase_8h-source.html#l00137">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="PluginBase_8h-source.html#l00148">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p>
643
644 </div>
645 </div><p>
646 <a class="anchor" name="9b28da8315fcde46ce7644d6592ba527"></a><!-- doxytag: member="PercussionOnsetDetector::getParameter" ref="9b28da8315fcde46ce7644d6592ba527" args="(std::string id) const " -->
647 <div class="memitem">
648 <div class="memproto">
649 <table class="memname">
650 <tr>
651 <td class="memname">float PercussionOnsetDetector::getParameter </td>
652 <td>(</td>
653 <td class="paramtype">std::string&nbsp;</td>
654 <td class="paramname"> </td>
655 <td>&nbsp;)&nbsp;</td>
656 <td width="100%"> const<code> [virtual]</code></td>
657 </tr>
658 </table>
659 </div>
660 <div class="memdoc">
661
662 <p>
663 Get the value of a named parameter.
664 <p>
665 The argument is the identifier field from that parameter's descriptor.
666 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
667
668 <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>
669
670 <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>
671
672 </div>
673 </div><p>
674 <a class="anchor" name="a097d72488e1211f05fc661ff5c6dc01"></a><!-- doxytag: member="PercussionOnsetDetector::setParameter" ref="a097d72488e1211f05fc661ff5c6dc01" args="(std::string id, float value)" -->
675 <div class="memitem">
676 <div class="memproto">
677 <table class="memname">
678 <tr>
679 <td class="memname">void PercussionOnsetDetector::setParameter </td>
680 <td>(</td>
681 <td class="paramtype">std::string&nbsp;</td>
682 <td class="paramname">, </td>
683 </tr>
684 <tr>
685 <td class="paramkey"></td>
686 <td></td>
687 <td class="paramtype">float&nbsp;</td>
688 <td class="paramname"></td><td>&nbsp;</td>
689 </tr>
690 <tr>
691 <td></td>
692 <td>)</td>
693 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
694 </tr>
695 </table>
696 </div>
697 <div class="memdoc">
698
699 <p>
700 Set a named parameter.
701 <p>
702 The first argument is the identifier field from that parameter's descriptor.
703 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
704
705 <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>
706
707 <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>
708
709 </div>
710 </div><p>
711 <a class="anchor" name="a4537aa0eb58a67d6e824d46924cf782"></a><!-- doxytag: member="PercussionOnsetDetector::getOutputDescriptors" ref="a4537aa0eb58a67d6e824d46924cf782" args="() const " -->
712 <div class="memitem">
713 <div class="memproto">
714 <table class="memname">
715 <tr>
716 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">PercussionOnsetDetector::OutputList</a> PercussionOnsetDetector::getOutputDescriptors </td>
717 <td>(</td>
718 <td class="paramname"> </td>
719 <td>&nbsp;)&nbsp;</td>
720 <td width="100%"> const<code> [virtual]</code></td>
721 </tr>
722 </table>
723 </div>
724 <div class="memdoc">
725
726 <p>
727 Get the outputs of this plugin.
728 <p>
729 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">process()</a> call.
730 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
731
732 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">196</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p>
733
734 <p>References <a class="el" href="Plugin_8h-source.html#l00239">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="Plugin_8h-source.html#l00219">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="Plugin_8h-source.html#l00231">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="Plugin_8h-source.html#l00252">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="Plugin_8h-source.html#l00206">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="Plugin_8h-source.html#l00270">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="Plugin_8h-source.html#l00397">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="Plugin_8h-source.html#l00212">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="Plugin_8h-source.html#l00282">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="Plugin_8h-source.html#l00277">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="Plugin_8h-source.html#l00306">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="Plugin_8h-source.html#l00294">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="Plugin_8h-source.html#l00224">Vamp::Plugin::OutputDescriptor::unit</a>, and <a class="el" href="Plugin_8h-source.html#l00288">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p>
735
736 </div>
737 </div><p>
738 <a class="anchor" name="dfd989812b3e0cb8f4b498f56a5a9614"></a><!-- doxytag: member="PercussionOnsetDetector::process" ref="dfd989812b3e0cb8f4b498f56a5a9614" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
739 <div class="memitem">
740 <div class="memproto">
741 <table class="memname">
742 <tr>
743 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a> PercussionOnsetDetector::process </td>
744 <td>(</td>
745 <td class="paramtype">const float *const *&nbsp;</td>
746 <td class="paramname"> <em>inputBuffers</em>, </td>
747 </tr>
748 <tr>
749 <td class="paramkey"></td>
750 <td></td>
751 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&nbsp;</td>
752 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
753 </tr>
754 <tr>
755 <td></td>
756 <td>)</td>
757 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
758 </tr>
759 </table>
760 </div>
761 <div class="memdoc">
762
763 <p>
764 Process a single block of input data.
765 <p>
766 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp will be the real time in seconds of the start of the supplied block of samples.<p>
767 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p>
768 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.)
769 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
770
771 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">226</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p>
772
773 <p>References <a class="el" href="RealTime_8cpp-source.html#l00232">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="Plugin_8h-source.html#l00325">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00086">m_dfMinus2</a>, <a class="el" href="Plugin_8h-source.html#l00397">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00084">m_priorMagnitudes</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00083">m_sensitivity</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00079">m_stepSize</a>, <a class="el" href="PercussionOnsetDetector_8h-source.html#l00082">m_threshold</a>, <a class="el" href="Plugin_8h-source.html#l00332">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="Plugin_8h-source.html#l00339">Vamp::Plugin::Feature::values</a>.</p>
774
775 </div>
776 </div><p>
777 <a class="anchor" name="d3d6767ed137783e84f842b4d4732ffa"></a><!-- doxytag: member="PercussionOnsetDetector::getRemainingFeatures" ref="d3d6767ed137783e84f842b4d4732ffa" args="()" -->
778 <div class="memitem">
779 <div class="memproto">
780 <table class="memname">
781 <tr>
782 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a> PercussionOnsetDetector::getRemainingFeatures </td>
783 <td>(</td>
784 <td class="paramname"> </td>
785 <td>&nbsp;)&nbsp;</td>
786 <td width="100%"><code> [virtual]</code></td>
787 </tr>
788 </table>
789 </div>
790 <div class="memdoc">
791
792 <p>
793 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
794 <p>
795
796 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
797
798 <p>Definition at line <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00281">281</a> of file <a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a>.</p>
799
800 </div>
801 </div><p>
802 <a class="anchor" name="267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="PercussionOnsetDetector::getMinChannelCount" ref="267b42e866df3cf0d190893e8096f525" args="() const " -->
803 <div class="memitem">
804 <div class="memproto">
805 <table class="memname">
806 <tr>
807 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
808 <td>(</td>
809 <td class="paramname"> </td>
810 <td>&nbsp;)&nbsp;</td>
811 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
812 </tr>
813 </table>
814 </div>
815 <div class="memdoc">
816
817 <p>
818 Get the minimum supported number of input channels.
819 <p>
820
821 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p>
822
823 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00191">191</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
824
825 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00170">Vamp::HostExt::PluginWrapper::getMinChannelCount()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00093">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00095">SpectralCentroid::initialise()</a>, <a class="el" href="PluginChannelAdapter_8cpp-source.html#l00119">Vamp::HostExt::PluginChannelAdapter::Impl::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
826
827 </div>
828 </div><p>
829 <a class="anchor" name="2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="PercussionOnsetDetector::getMaxChannelCount" ref="2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
830 <div class="memitem">
831 <div class="memproto">
832 <table class="memname">
833 <tr>
834 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
835 <td>(</td>
836 <td class="paramname"> </td>
837 <td>&nbsp;)&nbsp;</td>
838 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
839 </tr>
840 </table>
841 </div>
842 <div class="memdoc">
843
844 <p>
845 Get the maximum supported number of input channels.
846 <p>
847
848 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p>
849
850 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00196">196</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
851
852 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00175">Vamp::HostExt::PluginWrapper::getMaxChannelCount()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00093">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00095">SpectralCentroid::initialise()</a>, <a class="el" href="PluginChannelAdapter_8cpp-source.html#l00119">Vamp::HostExt::PluginChannelAdapter::Impl::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
853
854 </div>
855 </div><p>
856 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="PercussionOnsetDetector::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
857 <div class="memitem">
858 <div class="memproto">
859 <table class="memname">
860 <tr>
861 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
862 <td>(</td>
863 <td class="paramname"> </td>
864 <td>&nbsp;)&nbsp;</td>
865 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
866 </tr>
867 </table>
868 </div>
869 <div class="memdoc">
870
871 <p>
872 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>.
873 <p>
874 Do not reimplement this function in your subclass.
875 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
876
877 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00391">391</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
878
879 </div>
880 </div><p>
881 <a class="anchor" name="8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="PercussionOnsetDetector::getVampApiVersion" ref="8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
882 <div class="memitem">
883 <div class="memproto">
884 <table class="memname">
885 <tr>
886 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
887 <td>(</td>
888 <td class="paramname"> </td>
889 <td>&nbsp;)&nbsp;</td>
890 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
891 </tr>
892 </table>
893 </div>
894 <div class="memdoc">
895
896 <p>
897 Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin.
898 <p>
899
900 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p>
901
902 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00067">67</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
903
904 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00080">Vamp::HostExt::PluginWrapper::getVampApiVersion()</a>.</p>
905
906 </div>
907 </div><p>
908 <a class="anchor" name="bb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="PercussionOnsetDetector::getPrograms" ref="bb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
909 <div class="memitem">
910 <div class="memproto">
911 <table class="memname">
912 <tr>
913 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
914 <td>(</td>
915 <td class="paramname"> </td>
916 <td>&nbsp;)&nbsp;</td>
917 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
918 </tr>
919 </table>
920 </div>
921 <div class="memdoc">
922
923 <p>
924 Get the program settings available in this plugin.
925 <p>
926 A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.<p>
927 The programs must have unique names.
928 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#7ac5681dcfe08b7b8a796bffc0aff3e3">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#f3abaf717dc4b00cad5770ed6dfa01e1">Vamp::HostExt::PluginWrapper</a>.</p>
929
930 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00229">229</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
931
932 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00140">Vamp::HostExt::PluginWrapper::getPrograms()</a>.</p>
933
934 </div>
935 </div><p>
936 <a class="anchor" name="24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="PercussionOnsetDetector::getCurrentProgram" ref="24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
937 <div class="memitem">
938 <div class="memproto">
939 <table class="memname">
940 <tr>
941 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
942 <td>(</td>
943 <td class="paramname"> </td>
944 <td>&nbsp;)&nbsp;</td>
945 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
946 </tr>
947 </table>
948 </div>
949 <div class="memdoc">
950
951 <p>
952 Get the current program.
953 <p>
954
955 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p>
956
957 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00234">234</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
958
959 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00146">Vamp::HostExt::PluginWrapper::getCurrentProgram()</a>.</p>
960
961 </div>
962 </div><p>
963 <a class="anchor" name="add3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="PercussionOnsetDetector::selectProgram" ref="add3a547ef140bae200473a9518e3353" args="(std::string)" -->
964 <div class="memitem">
965 <div class="memproto">
966 <table class="memname">
967 <tr>
968 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
969 <td>(</td>
970 <td class="paramtype">std::string&nbsp;</td>
971 <td class="paramname"> </td>
972 <td>&nbsp;)&nbsp;</td>
973 <td width="100%"><code> [inline, virtual, inherited]</code></td>
974 </tr>
975 </table>
976 </div>
977 <div class="memdoc">
978
979 <p>
980 Select a program.
981 <p>
982 (If the given program name is not one of the available programs, do nothing.)
983 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
984
985 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00240">240</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
986
987 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00152">Vamp::HostExt::PluginWrapper::selectProgram()</a>.</p>
988
989 </div>
990 </div><p>
991 <hr><h2>Member Data Documentation</h2>
992 <a class="anchor" name="abac0cf7e961482b075777e5f0686e6c"></a><!-- doxytag: member="PercussionOnsetDetector::m_stepSize" ref="abac0cf7e961482b075777e5f0686e6c" args="" -->
993 <div class="memitem">
994 <div class="memproto">
995 <table class="memname">
996 <tr>
997 <td class="memname">size_t <a class="el" href="classPercussionOnsetDetector.html#abac0cf7e961482b075777e5f0686e6c">PercussionOnsetDetector::m_stepSize</a><code> [protected]</code> </td>
998 </tr>
999 </table>
1000 </div>
1001 <div class="memdoc">
1002
1003 <p>
1004
1005 <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>
1006
1007 <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>
1008
1009 </div>
1010 </div><p>
1011 <a class="anchor" name="920de543dbcf70a2edd80b5b31313285"></a><!-- doxytag: member="PercussionOnsetDetector::m_blockSize" ref="920de543dbcf70a2edd80b5b31313285" args="" -->
1012 <div class="memitem">
1013 <div class="memproto">
1014 <table class="memname">
1015 <tr>
1016 <td class="memname">size_t <a class="el" href="classPercussionOnsetDetector.html#920de543dbcf70a2edd80b5b31313285">PercussionOnsetDetector::m_blockSize</a><code> [protected]</code> </td>
1017 </tr>
1018 </table>
1019 </div>
1020 <div class="memdoc">
1021
1022 <p>
1023
1024 <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>
1025
1026 <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>
1027
1028 </div>
1029 </div><p>
1030 <a class="anchor" name="b04119adad56d87f2e633de289aab507"></a><!-- doxytag: member="PercussionOnsetDetector::m_threshold" ref="b04119adad56d87f2e633de289aab507" args="" -->
1031 <div class="memitem">
1032 <div class="memproto">
1033 <table class="memname">
1034 <tr>
1035 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#b04119adad56d87f2e633de289aab507">PercussionOnsetDetector::m_threshold</a><code> [protected]</code> </td>
1036 </tr>
1037 </table>
1038 </div>
1039 <div class="memdoc">
1040
1041 <p>
1042
1043 <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>
1044
1045 <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>
1046
1047 </div>
1048 </div><p>
1049 <a class="anchor" name="4e9770f246ba3bc75e7fc2cb8f9010af"></a><!-- doxytag: member="PercussionOnsetDetector::m_sensitivity" ref="4e9770f246ba3bc75e7fc2cb8f9010af" args="" -->
1050 <div class="memitem">
1051 <div class="memproto">
1052 <table class="memname">
1053 <tr>
1054 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#4e9770f246ba3bc75e7fc2cb8f9010af">PercussionOnsetDetector::m_sensitivity</a><code> [protected]</code> </td>
1055 </tr>
1056 </table>
1057 </div>
1058 <div class="memdoc">
1059
1060 <p>
1061
1062 <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>
1063
1064 <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>
1065
1066 </div>
1067 </div><p>
1068 <a class="anchor" name="30daa717267251a9d49afe57c328e989"></a><!-- doxytag: member="PercussionOnsetDetector::m_priorMagnitudes" ref="30daa717267251a9d49afe57c328e989" args="" -->
1069 <div class="memitem">
1070 <div class="memproto">
1071 <table class="memname">
1072 <tr>
1073 <td class="memname">float* <a class="el" href="classPercussionOnsetDetector.html#30daa717267251a9d49afe57c328e989">PercussionOnsetDetector::m_priorMagnitudes</a><code> [protected]</code> </td>
1074 </tr>
1075 </table>
1076 </div>
1077 <div class="memdoc">
1078
1079 <p>
1080
1081 <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>
1082
1083 <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>
1084
1085 </div>
1086 </div><p>
1087 <a class="anchor" name="cd80162c65212be7fa91251263fb9c3d"></a><!-- doxytag: member="PercussionOnsetDetector::m_dfMinus1" ref="cd80162c65212be7fa91251263fb9c3d" args="" -->
1088 <div class="memitem">
1089 <div class="memproto">
1090 <table class="memname">
1091 <tr>
1092 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#cd80162c65212be7fa91251263fb9c3d">PercussionOnsetDetector::m_dfMinus1</a><code> [protected]</code> </td>
1093 </tr>
1094 </table>
1095 </div>
1096 <div class="memdoc">
1097
1098 <p>
1099
1100 <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>
1101
1102 <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>
1103
1104 </div>
1105 </div><p>
1106 <a class="anchor" name="6ad7d8353cc681ff42a63b127cca5779"></a><!-- doxytag: member="PercussionOnsetDetector::m_dfMinus2" ref="6ad7d8353cc681ff42a63b127cca5779" args="" -->
1107 <div class="memitem">
1108 <div class="memproto">
1109 <table class="memname">
1110 <tr>
1111 <td class="memname">float <a class="el" href="classPercussionOnsetDetector.html#6ad7d8353cc681ff42a63b127cca5779">PercussionOnsetDetector::m_dfMinus2</a><code> [protected]</code> </td>
1112 </tr>
1113 </table>
1114 </div>
1115 <div class="memdoc">
1116
1117 <p>
1118
1119 <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>
1120
1121 <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>
1122
1123 </div>
1124 </div><p>
1125 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="PercussionOnsetDetector::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
1126 <div class="memitem">
1127 <div class="memproto">
1128 <table class="memname">
1129 <tr>
1130 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
1131 </tr>
1132 </table>
1133 </div>
1134 <div class="memdoc">
1135
1136 <p>
1137
1138 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00397">397</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
1139
1140 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00047">Vamp::HostExt::PluginRateExtractor::getRate()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00113">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">process()</a>.</p>
1141
1142 </div>
1143 </div><p>
1144 <hr>The documentation for this class was generated from the following files:<ul>
1145 <li><a class="el" href="PercussionOnsetDetector_8h-source.html">PercussionOnsetDetector.h</a><li><a class="el" href="PercussionOnsetDetector_8cpp-source.html">PercussionOnsetDetector.cpp</a></ul>
1146 </div>
1147 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by&nbsp;
1148 <a href="http://www.doxygen.org/index.html">
1149 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
1150 </body>
1151 </html>