Mercurial > hg > vamp-website

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
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: PowerSpectrum 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.6 -->
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>PowerSpectrum Class Reference</h1><!-- doxytag: class="PowerSpectrum" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include &lt;<a class="el" href="PowerSpectrum_8h-source.html">PowerSpectrum.h</a>&gt;</code>
28 <p>
29 <div class="dynheader">
30 Inheritance diagram for PowerSpectrum:</div>
31 <div class="dynsection">
32 <p><center><img src="classPowerSpectrum__inherit__graph.png" border="0" usemap="#PowerSpectrum__inherit__map" alt="Inheritance graph"></center>
33 <map name="PowerSpectrum__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="20,80,119,107"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="5,6,133,32"></map>
35 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
36
37 <p>
38 <a href="classPowerSpectrum-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
39 Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio.
40 <p>
41 This is one of the simplest possible <a class="el" href="namespaceVamp.html">Vamp</a> plugins, included as an example of how to return the appropriate value structure for this sort of visualisation.
42 <p>Definition at line <a class="el" href="PowerSpectrum_8h-source.html#l00050">50</a> of file <a class="el" href="PowerSpectrum_8h-source.html">PowerSpectrum.h</a>.</p>
43 <table border="0" cellpadding="0" cellspacing="0">
44 <tr><td></td></tr>
45 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
46 <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>,
47 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
48 }</td></tr>
49
50 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
51 &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>
52
53 <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>
54
55 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br>
56 <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>
57
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
59 &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>
60
61 <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>
62
63 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#a2550486513a4abcf7b52869002947e7">PowerSpectrum</a> (float inputSampleRate)</td></tr>
65
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#e7081e159ad1da5da1721b3048075306">~PowerSpectrum</a> ()</td></tr>
67
68 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#e2d046334c4bede5be72a0d97e4dfb29">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
69
70 <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="#e2d046334c4bede5be72a0d97e4dfb29"></a><br></td></tr>
71 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#091ba21e1697ea4208f42e8295c389d9">reset</a> ()</td></tr>
72
73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#091ba21e1697ea4208f42e8295c389d9"></a><br></td></tr>
74 <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="classPowerSpectrum.html#e04e0e34847a93f3444d04c802ee56ef">getInputDomain</a> () const </td></tr>
75
76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#e04e0e34847a93f3444d04c802ee56ef"></a><br></td></tr>
77 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#9e9d8349461cbb88d7565a5e8c51b64e">getIdentifier</a> () const </td></tr>
78
79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#9e9d8349461cbb88d7565a5e8c51b64e"></a><br></td></tr>
80 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#c9214f9cafeeed3fca549c90aef57623">getName</a> () const </td></tr>
81
82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#c9214f9cafeeed3fca549c90aef57623"></a><br></td></tr>
83 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#7b48d56dc954f3af344f7e4dcd8993e5">getDescription</a> () const </td></tr>
84
85 <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="#7b48d56dc954f3af344f7e4dcd8993e5"></a><br></td></tr>
86 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#9f3e3f759e2b67c771a41f1c276984b2">getMaker</a> () const </td></tr>
87
88 <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="#9f3e3f759e2b67c771a41f1c276984b2"></a><br></td></tr>
89 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#d23d27e4e82f10404a37b933f6a72c33">getPluginVersion</a> () const </td></tr>
90
91 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#d23d27e4e82f10404a37b933f6a72c33"></a><br></td></tr>
92 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#708b4d335c57643d5ef2b2e1caf43bd9">getCopyright</a> () const </td></tr>
93
94 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#708b4d335c57643d5ef2b2e1caf43bd9"></a><br></td></tr>
95 <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="classPowerSpectrum.html#6aac5f93e3a8c033026d739fed427242">getOutputDescriptors</a> () const </td></tr>
96
97 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#6aac5f93e3a8c033026d739fed427242"></a><br></td></tr>
98 <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="classPowerSpectrum.html#a5664ffc2b37a16db471fae791c1f55f">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
99
100 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#a5664ffc2b37a16db471fae791c1f55f"></a><br></td></tr>
101 <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="classPowerSpectrum.html#c8a9661a785d38f4c5ce8ca2d53e69f9">getRemainingFeatures</a> ()</td></tr>
102
103 <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="#c8a9661a785d38f4c5ce8ca2d53e69f9"></a><br></td></tr>
104 <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#a529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr>
105
106 <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="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). <a href="#a529adf83f87a603954eb31407602aac"></a><br></td></tr>
107 <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#514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr>
108
109 <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="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#514c716c22f81c055f19b56c3f882567"></a><br></td></tr>
110 <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>
111
112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#267b42e866df3cf0d190893e8096f525"></a><br></td></tr>
113 <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>
114
115 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br></td></tr>
116 <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>
117
118 <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>
119 <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>
120
121 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#8fd2c48291c64b790f0efb8948508dcf"></a><br></td></tr>
122 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr>
123
124 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#ac3e49b3b66cacfbb768dfdf07444f21"></a><br></td></tr>
125 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr>
126
127 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#97ababcd45348ceec998d0f8e0f38bf7"></a><br></td></tr>
128 <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#6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr>
129
130 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#6c718ce822f7b73b98940d59dcaa9366"></a><br></td></tr>
131 <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>
132
133 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#bb307c60bdb981d5f5af50c3c4ae84af"></a><br></td></tr>
134 <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>
135
136 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#24e77eccf1bdfbbca3c79bb25e8799b3"></a><br></td></tr>
137 <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>
138
139 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#add3a547ef140bae200473a9518e3353"></a><br></td></tr>
140 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
141 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPowerSpectrum.html#399e997c033f26b07edb7cc83cd5a6d8">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="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
144
145 </table>
146 <hr><h2>Member Typedef Documentation</h2>
147 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="PowerSpectrum::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
148 <div class="memitem">
149 <div class="memproto">
150 <table class="memname">
151 <tr>
152 <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>
153 </tr>
154 </table>
155 </div>
156 <div class="memdoc">
157
158 <p>
159
160 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00322">322</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
161
162 </div>
163 </div><p>
164 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="PowerSpectrum::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
165 <div class="memitem">
166 <div class="memproto">
167 <table class="memname">
168 <tr>
169 <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>
170 </tr>
171 </table>
172 </div>
173 <div class="memdoc">
174
175 <p>
176
177 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00380">380</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
178
179 </div>
180 </div><p>
181 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="PowerSpectrum::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
182 <div class="memitem">
183 <div class="memproto">
184 <table class="memname">
185 <tr>
186 <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>
187 </tr>
188 </table>
189 </div>
190 <div class="memdoc">
191
192 <p>
193
194 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00382">382</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
195
196 </div>
197 </div><p>
198 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="PowerSpectrum::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
199 <div class="memitem">
200 <div class="memproto">
201 <table class="memname">
202 <tr>
203 <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>
204 </tr>
205 </table>
206 </div>
207 <div class="memdoc">
208
209 <p>
210
211 <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>
212
213 </div>
214 </div><p>
215 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="PowerSpectrum::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
216 <div class="memitem">
217 <div class="memproto">
218 <table class="memname">
219 <tr>
220 <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>
221 </tr>
222 </table>
223 </div>
224 <div class="memdoc">
225
226 <p>
227
228 <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>
229
230 </div>
231 </div><p>
232 <hr><h2>Member Enumeration Documentation</h2>
233 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="PowerSpectrum::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
234 <div class="memitem">
235 <div class="memproto">
236 <table class="memname">
237 <tr>
238 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
239 </tr>
240 </table>
241 </div>
242 <div class="memdoc">
243
244 <p>
245 <dl compact><dt><b>Enumerator: </b></dt><dd>
246 <table border="0" cellspacing="2" cellpadding="0">
247 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
248 </td></tr>
249 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
250 </td></tr>
251 </table>
252 </dl>
253
254 <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>
255
256 </div>
257 </div><p>
258 <hr><h2>Constructor &amp; Destructor Documentation</h2>
259 <a class="anchor" name="a2550486513a4abcf7b52869002947e7"></a><!-- doxytag: member="PowerSpectrum::PowerSpectrum" ref="a2550486513a4abcf7b52869002947e7" args="(float inputSampleRate)" -->
260 <div class="memitem">
261 <div class="memproto">
262 <table class="memname">
263 <tr>
264 <td class="memname">PowerSpectrum::PowerSpectrum </td>
265 <td>(</td>
266 <td class="paramtype">float&nbsp;</td>
267 <td class="paramname"> <em>inputSampleRate</em> </td>
268 <td>&nbsp;)&nbsp;</td>
269 <td></td>
270 </tr>
271 </table>
272 </div>
273 <div class="memdoc">
274
275 <p>
276
277 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00045">45</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
278
279 </div>
280 </div><p>
281 <a class="anchor" name="e7081e159ad1da5da1721b3048075306"></a><!-- doxytag: member="PowerSpectrum::~PowerSpectrum" ref="e7081e159ad1da5da1721b3048075306" args="()" -->
282 <div class="memitem">
283 <div class="memproto">
284 <table class="memname">
285 <tr>
286 <td class="memname">PowerSpectrum::~PowerSpectrum </td>
287 <td>(</td>
288 <td class="paramname"> </td>
289 <td>&nbsp;)&nbsp;</td>
290 <td><code> [virtual]</code></td>
291 </tr>
292 </table>
293 </div>
294 <div class="memdoc">
295
296 <p>
297
298 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00051">51</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
299
300 </div>
301 </div><p>
302 <hr><h2>Member Function Documentation</h2>
303 <a class="anchor" name="e2d046334c4bede5be72a0d97e4dfb29"></a><!-- doxytag: member="PowerSpectrum::initialise" ref="e2d046334c4bede5be72a0d97e4dfb29" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
304 <div class="memitem">
305 <div class="memproto">
306 <table class="memname">
307 <tr>
308 <td class="memname">bool PowerSpectrum::initialise </td>
309 <td>(</td>
310 <td class="paramtype">size_t&nbsp;</td>
311 <td class="paramname"> <em>inputChannels</em>, </td>
312 </tr>
313 <tr>
314 <td class="paramkey"></td>
315 <td></td>
316 <td class="paramtype">size_t&nbsp;</td>
317 <td class="paramname"> <em>stepSize</em>, </td>
318 </tr>
319 <tr>
320 <td class="paramkey"></td>
321 <td></td>
322 <td class="paramtype">size_t&nbsp;</td>
323 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
324 </tr>
325 <tr>
326 <td></td>
327 <td>)</td>
328 <td></td><td></td><td><code> [virtual]</code></td>
329 </tr>
330 </table>
331 </div>
332 <div class="memdoc">
333
334 <p>
335 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).
336 <p>
337 The input sample rate should have been already specified at construction time.<p>
338 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
339 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
340
341 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">92</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
342
343 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00199">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00194">Vamp::Plugin::getMinChannelCount()</a>, and <a class="el" href="PowerSpectrum_8h-source.html#l00076">m_blockSize</a>.</p>
344
345 </div>
346 </div><p>
347 <a class="anchor" name="091ba21e1697ea4208f42e8295c389d9"></a><!-- doxytag: member="PowerSpectrum::reset" ref="091ba21e1697ea4208f42e8295c389d9" args="()" -->
348 <div class="memitem">
349 <div class="memproto">
350 <table class="memname">
351 <tr>
352 <td class="memname">void PowerSpectrum::reset </td>
353 <td>(</td>
354 <td class="paramname"> </td>
355 <td>&nbsp;)&nbsp;</td>
356 <td><code> [virtual]</code></td>
357 </tr>
358 </table>
359 </div>
360 <div class="memdoc">
361
362 <p>
363 Reset the plugin after use, to prepare it for another clean run.
364 <p>
365 Not called for the first initialisation (i.e. initialise must also do a reset).
366 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
367
368 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00103">103</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
369
370 </div>
371 </div><p>
372 <a class="anchor" name="e04e0e34847a93f3444d04c802ee56ef"></a><!-- doxytag: member="PowerSpectrum::getInputDomain" ref="e04e0e34847a93f3444d04c802ee56ef" args="() const " -->
373 <div class="memitem">
374 <div class="memproto">
375 <table class="memname">
376 <tr>
377 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> PowerSpectrum::getInputDomain </td>
378 <td>(</td>
379 <td class="paramname"> </td>
380 <td>&nbsp;)&nbsp;</td>
381 <td> const<code> [inline, virtual]</code></td>
382 </tr>
383 </table>
384 </div>
385 <div class="memdoc">
386
387 <p>
388 Get the plugin's required input domain.
389 <p>
390 If this is TimeDomain, the samples provided to the <a class="el" href="classPowerSpectrum.html#a5664ffc2b37a16db471fae791c1f55f" 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="classPowerSpectrum.html#a5664ffc2b37a16db471fae791c1f55f" 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.
391 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
392
393 <p>Definition at line <a class="el" href="PowerSpectrum_8h-source.html#l00059">59</a> of file <a class="el" href="PowerSpectrum_8h-source.html">PowerSpectrum.h</a>.</p>
394
395 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">Vamp::Plugin::FrequencyDomain</a>.</p>
396
397 </div>
398 </div><p>
399 <a class="anchor" name="9e9d8349461cbb88d7565a5e8c51b64e"></a><!-- doxytag: member="PowerSpectrum::getIdentifier" ref="9e9d8349461cbb88d7565a5e8c51b64e" args="() const " -->
400 <div class="memitem">
401 <div class="memproto">
402 <table class="memname">
403 <tr>
404 <td class="memname">string PowerSpectrum::getIdentifier </td>
405 <td>(</td>
406 <td class="paramname"> </td>
407 <td>&nbsp;)&nbsp;</td>
408 <td> const<code> [virtual]</code></td>
409 </tr>
410 </table>
411 </div>
412 <div class="memdoc">
413
414 <p>
415 Get the computer-usable name of the plugin.
416 <p>
417 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>
418 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>
419 Example: "zero_crossings"
420 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
421
422 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00056">56</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
423
424 </div>
425 </div><p>
426 <a class="anchor" name="c9214f9cafeeed3fca549c90aef57623"></a><!-- doxytag: member="PowerSpectrum::getName" ref="c9214f9cafeeed3fca549c90aef57623" args="() const " -->
427 <div class="memitem">
428 <div class="memproto">
429 <table class="memname">
430 <tr>
431 <td class="memname">string PowerSpectrum::getName </td>
432 <td>(</td>
433 <td class="paramname"> </td>
434 <td>&nbsp;)&nbsp;</td>
435 <td> const<code> [virtual]</code></td>
436 </tr>
437 </table>
438 </div>
439 <div class="memdoc">
440
441 <p>
442 Get a human-readable name or title of the plugin.
443 <p>
444 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>
445 Example: "Zero Crossings"
446 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
447
448 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00062">62</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
449
450 </div>
451 </div><p>
452 <a class="anchor" name="7b48d56dc954f3af344f7e4dcd8993e5"></a><!-- doxytag: member="PowerSpectrum::getDescription" ref="7b48d56dc954f3af344f7e4dcd8993e5" args="() const " -->
453 <div class="memitem">
454 <div class="memproto">
455 <table class="memname">
456 <tr>
457 <td class="memname">string PowerSpectrum::getDescription </td>
458 <td>(</td>
459 <td class="paramname"> </td>
460 <td>&nbsp;)&nbsp;</td>
461 <td> const<code> [virtual]</code></td>
462 </tr>
463 </table>
464 </div>
465 <div class="memdoc">
466
467 <p>
468 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".
469 <p>
470 May be empty if the name has said it all already.<p>
471 Example: "Detect and count zero crossing points"
472 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
473
474 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00068">68</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
475
476 </div>
477 </div><p>
478 <a class="anchor" name="9f3e3f759e2b67c771a41f1c276984b2"></a><!-- doxytag: member="PowerSpectrum::getMaker" ref="9f3e3f759e2b67c771a41f1c276984b2" args="() const " -->
479 <div class="memitem">
480 <div class="memproto">
481 <table class="memname">
482 <tr>
483 <td class="memname">string PowerSpectrum::getMaker </td>
484 <td>(</td>
485 <td class="paramname"> </td>
486 <td>&nbsp;)&nbsp;</td>
487 <td> const<code> [virtual]</code></td>
488 </tr>
489 </table>
490 </div>
491 <div class="memdoc">
492
493 <p>
494 Get the name of the author or vendor of the plugin in human-readable form.
495 <p>
496 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
497 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
498
499 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00074">74</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
500
501 </div>
502 </div><p>
503 <a class="anchor" name="d23d27e4e82f10404a37b933f6a72c33"></a><!-- doxytag: member="PowerSpectrum::getPluginVersion" ref="d23d27e4e82f10404a37b933f6a72c33" args="() const " -->
504 <div class="memitem">
505 <div class="memproto">
506 <table class="memname">
507 <tr>
508 <td class="memname">int PowerSpectrum::getPluginVersion </td>
509 <td>(</td>
510 <td class="paramname"> </td>
511 <td>&nbsp;)&nbsp;</td>
512 <td> const<code> [virtual]</code></td>
513 </tr>
514 </table>
515 </div>
516 <div class="memdoc">
517
518 <p>
519 Get the version number of the plugin.
520 <p>
521
522 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
523
524 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00080">80</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
525
526 </div>
527 </div><p>
528 <a class="anchor" name="708b4d335c57643d5ef2b2e1caf43bd9"></a><!-- doxytag: member="PowerSpectrum::getCopyright" ref="708b4d335c57643d5ef2b2e1caf43bd9" args="() const " -->
529 <div class="memitem">
530 <div class="memproto">
531 <table class="memname">
532 <tr>
533 <td class="memname">string PowerSpectrum::getCopyright </td>
534 <td>(</td>
535 <td class="paramname"> </td>
536 <td>&nbsp;)&nbsp;</td>
537 <td> const<code> [virtual]</code></td>
538 </tr>
539 </table>
540 </div>
541 <div class="memdoc">
542
543 <p>
544 Get the copyright statement or licensing summary for the plugin.
545 <p>
546 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
547 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
548
549 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00086">86</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
550
551 </div>
552 </div><p>
553 <a class="anchor" name="6aac5f93e3a8c033026d739fed427242"></a><!-- doxytag: member="PowerSpectrum::getOutputDescriptors" ref="6aac5f93e3a8c033026d739fed427242" args="() const " -->
554 <div class="memitem">
555 <div class="memproto">
556 <table class="memname">
557 <tr>
558 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">PowerSpectrum::OutputList</a> PowerSpectrum::getOutputDescriptors </td>
559 <td>(</td>
560 <td class="paramname"> </td>
561 <td>&nbsp;)&nbsp;</td>
562 <td> const<code> [virtual]</code></td>
563 </tr>
564 </table>
565 </div>
566 <div class="memdoc">
567
568 <p>
569 Get the outputs of this plugin.
570 <p>
571 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="classPowerSpectrum.html#a5664ffc2b37a16db471fae791c1f55f" title="Process a single block of input data.">process()</a> call.
572 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
573
574 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">108</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
575
576 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00242">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00222">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00234">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00255">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00209">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00273">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="PowerSpectrum_8h-source.html#l00076">m_blockSize</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00215">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00285">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00297">Vamp::Plugin::OutputDescriptor::sampleType</a>, and <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00227">Vamp::Plugin::OutputDescriptor::unit</a>.</p>
577
578 </div>
579 </div><p>
580 <a class="anchor" name="a5664ffc2b37a16db471fae791c1f55f"></a><!-- doxytag: member="PowerSpectrum::process" ref="a5664ffc2b37a16db471fae791c1f55f" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
581 <div class="memitem">
582 <div class="memproto">
583 <table class="memname">
584 <tr>
585 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PowerSpectrum::FeatureSet</a> PowerSpectrum::process </td>
586 <td>(</td>
587 <td class="paramtype">const float *const *&nbsp;</td>
588 <td class="paramname"> <em>inputBuffers</em>, </td>
589 </tr>
590 <tr>
591 <td class="paramkey"></td>
592 <td></td>
593 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&nbsp;</td>
594 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
595 </tr>
596 <tr>
597 <td></td>
598 <td>)</td>
599 <td></td><td></td><td><code> [virtual]</code></td>
600 </tr>
601 </table>
602 </div>
603 <div class="memdoc">
604
605 <p>
606 Process a single block of input data.
607 <p>
608 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>
609 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>
610 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.)
611 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
612
613 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00136">136</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
614
615 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00339">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="PowerSpectrum_8h-source.html#l00076">m_blockSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00369">Vamp::Plugin::Feature::values</a>.</p>
616
617 </div>
618 </div><p>
619 <a class="anchor" name="c8a9661a785d38f4c5ce8ca2d53e69f9"></a><!-- doxytag: member="PowerSpectrum::getRemainingFeatures" ref="c8a9661a785d38f4c5ce8ca2d53e69f9" args="()" -->
620 <div class="memitem">
621 <div class="memproto">
622 <table class="memname">
623 <tr>
624 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PowerSpectrum::FeatureSet</a> PowerSpectrum::getRemainingFeatures </td>
625 <td>(</td>
626 <td class="paramname"> </td>
627 <td>&nbsp;)&nbsp;</td>
628 <td><code> [virtual]</code></td>
629 </tr>
630 </table>
631 </div>
632 <div class="memdoc">
633
634 <p>
635 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
636 <p>
637
638 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
639
640 <p>Definition at line <a class="el" href="PowerSpectrum_8cpp-source.html#l00166">166</a> of file <a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a>.</p>
641
642 </div>
643 </div><p>
644 <a class="anchor" name="a529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="PowerSpectrum::getPreferredBlockSize" ref="a529adf83f87a603954eb31407602aac" args="() const " -->
645 <div class="memitem">
646 <div class="memproto">
647 <table class="memname">
648 <tr>
649 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
650 <td>(</td>
651 <td class="paramname"> </td>
652 <td>&nbsp;)&nbsp;</td>
653 <td> const<code> [inline, virtual, inherited]</code></td>
654 </tr>
655 </table>
656 </div>
657 <div class="memdoc">
658
659 <p>
660 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function).
661 <p>
662 This should be called before <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
663 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
664 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#d5e0ea8042bdec4dd18428991117e07a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#68b8569b71504a0478caf990dbe30683">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#410c0b47c6c849d7ed9b726b84402ad0">PercussionOnsetDetector</a>.</p>
665
666 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00174">174</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
667
668 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
669
670 </div>
671 </div><p>
672 <a class="anchor" name="514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="PowerSpectrum::getPreferredStepSize" ref="514c716c22f81c055f19b56c3f882567" args="() const " -->
673 <div class="memitem">
674 <div class="memproto">
675 <table class="memname">
676 <tr>
677 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
678 <td>(</td>
679 <td class="paramname"> </td>
680 <td>&nbsp;)&nbsp;</td>
681 <td> const<code> [inline, virtual, inherited]</code></td>
682 </tr>
683 </table>
684 </div>
685 <div class="memdoc">
686
687 <p>
688 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="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin.
689 <p>
690 This should be called before <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
691 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="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
692 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#859ad5d59402691daed3cf1af1899ebe">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#d450bb7e7df559ae3d68dfbfb085676f">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#733824891e11c306a7a678534b89b968">PercussionOnsetDetector</a>.</p>
693
694 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00189">189</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
695
696 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
697
698 </div>
699 </div><p>
700 <a class="anchor" name="267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="PowerSpectrum::getMinChannelCount" ref="267b42e866df3cf0d190893e8096f525" args="() const " -->
701 <div class="memitem">
702 <div class="memproto">
703 <table class="memname">
704 <tr>
705 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
706 <td>(</td>
707 <td class="paramname"> </td>
708 <td>&nbsp;)&nbsp;</td>
709 <td> const<code> [inline, virtual, inherited]</code></td>
710 </tr>
711 </table>
712 </div>
713 <div class="memdoc">
714
715 <p>
716 Get the minimum supported number of input channels.
717 <p>
718
719 <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>
720
721 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00194">194</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
722
723 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00099">SpectralCentroid::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00676">FixedTempoEstimator::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
724
725 </div>
726 </div><p>
727 <a class="anchor" name="2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="PowerSpectrum::getMaxChannelCount" ref="2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
728 <div class="memitem">
729 <div class="memproto">
730 <table class="memname">
731 <tr>
732 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
733 <td>(</td>
734 <td class="paramname"> </td>
735 <td>&nbsp;)&nbsp;</td>
736 <td> const<code> [inline, virtual, inherited]</code></td>
737 </tr>
738 </table>
739 </div>
740 <div class="memdoc">
741
742 <p>
743 Get the maximum supported number of input channels.
744 <p>
745
746 <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>
747
748 <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>
749
750 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00099">SpectralCentroid::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00676">FixedTempoEstimator::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
751
752 </div>
753 </div><p>
754 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="PowerSpectrum::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
755 <div class="memitem">
756 <div class="memproto">
757 <table class="memname">
758 <tr>
759 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
760 <td>(</td>
761 <td class="paramname"> </td>
762 <td>&nbsp;)&nbsp;</td>
763 <td> const<code> [inline, virtual, inherited]</code></td>
764 </tr>
765 </table>
766 </div>
767 <div class="memdoc">
768
769 <p>
770 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>.
771 <p>
772 Do not reimplement this function in your subclass.
773 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
774
775 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00425">425</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
776
777 </div>
778 </div><p>
779 <a class="anchor" name="8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="PowerSpectrum::getVampApiVersion" ref="8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
780 <div class="memitem">
781 <div class="memproto">
782 <table class="memname">
783 <tr>
784 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
785 <td>(</td>
786 <td class="paramname"> </td>
787 <td>&nbsp;)&nbsp;</td>
788 <td> const<code> [inline, virtual, inherited]</code></td>
789 </tr>
790 </table>
791 </div>
792 <div class="memdoc">
793
794 <p>
795 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
796 <p>
797
798 <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>
799
800 <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>
801
802 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
803
804 </div>
805 </div><p>
806 <a class="anchor" name="ac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="PowerSpectrum::getParameterDescriptors" ref="ac3e49b3b66cacfbb768dfdf07444f21" args="() const " -->
807 <div class="memitem">
808 <div class="memproto">
809 <table class="memname">
810 <tr>
811 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
812 <td>(</td>
813 <td class="paramname"> </td>
814 <td>&nbsp;)&nbsp;</td>
815 <td> const<code> [inline, virtual, inherited]</code></td>
816 </tr>
817 </table>
818 </div>
819 <div class="memdoc">
820
821 <p>
822 Get the controllable parameters of this plugin.
823 <p>
824
825 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#602faa0bfaae83e2ca53b36292271a76">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#9df01323a09e117bc12354ebe9244edf">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#e157465a4e07d180bab05b5c3a4d8987">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#bceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector</a>.</p>
826
827 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00208">208</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
828
829 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
830
831 </div>
832 </div><p>
833 <a class="anchor" name="97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="PowerSpectrum::getParameter" ref="97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " -->
834 <div class="memitem">
835 <div class="memproto">
836 <table class="memname">
837 <tr>
838 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
839 <td>(</td>
840 <td class="paramtype">std::string&nbsp;</td>
841 <td class="paramname"> </td>
842 <td>&nbsp;)&nbsp;</td>
843 <td> const<code> [inline, virtual, inherited]</code></td>
844 </tr>
845 </table>
846 </div>
847 <div class="memdoc">
848
849 <p>
850 Get the value of a named parameter.
851 <p>
852 The argument is the identifier field from that parameter's descriptor.
853 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#f0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#b278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#2030b05fb1228b30ace16200780c9152">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector</a>.</p>
854
855 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00216">216</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
856
857 </div>
858 </div><p>
859 <a class="anchor" name="6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="PowerSpectrum::setParameter" ref="6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" -->
860 <div class="memitem">
861 <div class="memproto">
862 <table class="memname">
863 <tr>
864 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
865 <td>(</td>
866 <td class="paramtype">std::string&nbsp;</td>
867 <td class="paramname">, </td>
868 </tr>
869 <tr>
870 <td class="paramkey"></td>
871 <td></td>
872 <td class="paramtype">float&nbsp;</td>
873 <td class="paramname"></td><td>&nbsp;</td>
874 </tr>
875 <tr>
876 <td></td>
877 <td>)</td>
878 <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
879 </tr>
880 </table>
881 </div>
882 <div class="memdoc">
883
884 <p>
885 Set a named parameter.
886 <p>
887 The first argument is the identifier field from that parameter's descriptor.
888 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#e1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p>
889
890 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00222">222</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
891
892 </div>
893 </div><p>
894 <a class="anchor" name="bb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="PowerSpectrum::getPrograms" ref="bb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
895 <div class="memitem">
896 <div class="memproto">
897 <table class="memname">
898 <tr>
899 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
900 <td>(</td>
901 <td class="paramname"> </td>
902 <td>&nbsp;)&nbsp;</td>
903 <td> const<code> [inline, virtual, inherited]</code></td>
904 </tr>
905 </table>
906 </div>
907 <div class="memdoc">
908
909 <p>
910 Get the program settings available in this plugin.
911 <p>
912 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>
913 The programs must have unique names.
914 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#e0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p>
915
916 <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>
917
918 </div>
919 </div><p>
920 <a class="anchor" name="24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="PowerSpectrum::getCurrentProgram" ref="24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
921 <div class="memitem">
922 <div class="memproto">
923 <table class="memname">
924 <tr>
925 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
926 <td>(</td>
927 <td class="paramname"> </td>
928 <td>&nbsp;)&nbsp;</td>
929 <td> const<code> [inline, virtual, inherited]</code></td>
930 </tr>
931 </table>
932 </div>
933 <div class="memdoc">
934
935 <p>
936 Get the current program.
937 <p>
938
939 <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>
940
941 <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>
942
943 </div>
944 </div><p>
945 <a class="anchor" name="add3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="PowerSpectrum::selectProgram" ref="add3a547ef140bae200473a9518e3353" args="(std::string)" -->
946 <div class="memitem">
947 <div class="memproto">
948 <table class="memname">
949 <tr>
950 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
951 <td>(</td>
952 <td class="paramtype">std::string&nbsp;</td>
953 <td class="paramname"> </td>
954 <td>&nbsp;)&nbsp;</td>
955 <td><code> [inline, virtual, inherited]</code></td>
956 </tr>
957 </table>
958 </div>
959 <div class="memdoc">
960
961 <p>
962 Select a program.
963 <p>
964 (If the given program name is not one of the available programs, do nothing.)
965 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
966
967 <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>
968
969 </div>
970 </div><p>
971 <hr><h2>Member Data Documentation</h2>
972 <a class="anchor" name="399e997c033f26b07edb7cc83cd5a6d8"></a><!-- doxytag: member="PowerSpectrum::m_blockSize" ref="399e997c033f26b07edb7cc83cd5a6d8" args="" -->
973 <div class="memitem">
974 <div class="memproto">
975 <table class="memname">
976 <tr>
977 <td class="memname">size_t <a class="el" href="classPowerSpectrum.html#399e997c033f26b07edb7cc83cd5a6d8">PowerSpectrum::m_blockSize</a><code> [protected]</code> </td>
978 </tr>
979 </table>
980 </div>
981 <div class="memdoc">
982
983 <p>
984
985 <p>Definition at line <a class="el" href="PowerSpectrum_8h-source.html#l00076">76</a> of file <a class="el" href="PowerSpectrum_8h-source.html">PowerSpectrum.h</a>.</p>
986
987 <p>Referenced by <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">initialise()</a>, and <a class="el" href="PowerSpectrum_8cpp-source.html#l00136">process()</a>.</p>
988
989 </div>
990 </div><p>
991 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="PowerSpectrum::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
992 <div class="memitem">
993 <div class="memproto">
994 <table class="memname">
995 <tr>
996 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
997 </tr>
998 </table>
999 </div>
1000 <div class="memdoc">
1001
1002 <p>
1003
1004 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">431</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
1005
1006 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
1007
1008 </div>
1009 </div><p>
1010 <hr>The documentation for this class was generated from the following files:<ul>
1011 <li><a class="el" href="PowerSpectrum_8h-source.html">PowerSpectrum.h</a><li><a class="el" href="PowerSpectrum_8cpp-source.html">PowerSpectrum.cpp</a></ul>
1012 </div>
1013 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:19 2008 for VampPluginSDK by&nbsp;
1014 <a href="http://www.doxygen.org/index.html">
1015 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
1016 </body>
1017 </html>