Mercurial > hg > vamp-website

annotate code-doc/classSpectralCentroid.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 351c4ebce5f9
children 0976232e353b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: SpectralCentroid Class Reference</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@21 7 <!-- Generated by Doxygen 1.5.6 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 </div>
cannam@0 26 <div class="contents">
cannam@0 27 <h1>SpectralCentroid Class Reference</h1><!-- doxytag: class="SpectralCentroid" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include &lt;<a class="el" href="SpectralCentroid_8h-source.html">SpectralCentroid.h</a>&gt;</code>
cannam@0 28 <p>
cannam@0 29 <div class="dynheader">
cannam@0 30 Inheritance diagram for SpectralCentroid:</div>
cannam@0 31 <div class="dynsection">
cannam@0 32 <p><center><img src="classSpectralCentroid__inherit__graph.png" border="0" usemap="#SpectralCentroid__inherit__map" alt="Inheritance graph"></center>
cannam@0 33 <map name="SpectralCentroid__inherit__map">
cannam@21 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>
cannam@0 35 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
cannam@0 36
cannam@0 37 <p>
cannam@0 38 <a href="classSpectralCentroid-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@0 39 Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio.
cannam@0 40 <p>Definition at line <a class="el" href="SpectralCentroid_8h-source.html#l00047">47</a> of file <a class="el" href="SpectralCentroid_8h-source.html">SpectralCentroid.h</a>.</p>
cannam@0 41 <table border="0" cellpadding="0" cellspacing="0">
cannam@0 42 <tr><td></td></tr>
cannam@0 43 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
cannam@0 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>,
cannam@0 45 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
cannam@0 46 }</td></tr>
cannam@0 47
cannam@0 48 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
cannam@0 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>
cannam@0 50
cannam@0 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>
cannam@0 52
cannam@0 53 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br>
cannam@0 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>
cannam@0 55
cannam@0 56 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
cannam@0 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>
cannam@0 58
cannam@0 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>
cannam@0 60
cannam@0 61 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@0 62 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#2cd801ad72f262eceb95ab0d22e7dbcd">SpectralCentroid</a> (float inputSampleRate)</td></tr>
cannam@0 63
cannam@0 64 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#483e0d6757bc3dcf61e8066f764f45c6">~SpectralCentroid</a> ()</td></tr>
cannam@0 65
cannam@0 66 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#ab1ae16f5c68e2b319668f447908cedb">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
cannam@0 67
cannam@0 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="#ab1ae16f5c68e2b319668f447908cedb"></a><br></td></tr>
cannam@0 69 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#9b5f5581691ff8f46bb7674d8d74395c">reset</a> ()</td></tr>
cannam@0 70
cannam@0 71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#9b5f5581691ff8f46bb7674d8d74395c"></a><br></td></tr>
cannam@0 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="classSpectralCentroid.html#0ec2cb74c1c5f6e57d0bd9dcf7c8f469">getInputDomain</a> () const </td></tr>
cannam@0 73
cannam@0 74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#0ec2cb74c1c5f6e57d0bd9dcf7c8f469"></a><br></td></tr>
cannam@0 75 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#1b2c4c8440c024c4c635fcef5697949f">getIdentifier</a> () const </td></tr>
cannam@0 76
cannam@0 77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#1b2c4c8440c024c4c635fcef5697949f"></a><br></td></tr>
cannam@0 78 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#b7e6a620fea568af431be3cfd9dd5a41">getName</a> () const </td></tr>
cannam@0 79
cannam@0 80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#b7e6a620fea568af431be3cfd9dd5a41"></a><br></td></tr>
cannam@0 81 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#8fbb74a46283057d9a0b0e4718ee943c">getDescription</a> () const </td></tr>
cannam@0 82
cannam@0 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="#8fbb74a46283057d9a0b0e4718ee943c"></a><br></td></tr>
cannam@0 84 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#c01ff858bf67e2e93ad5d24a6ba8c8c8">getMaker</a> () const </td></tr>
cannam@0 85
cannam@0 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="#c01ff858bf67e2e93ad5d24a6ba8c8c8"></a><br></td></tr>
cannam@0 87 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#f64622e66bf678ac2b0b58aa832ca2b3">getPluginVersion</a> () const </td></tr>
cannam@0 88
cannam@0 89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#f64622e66bf678ac2b0b58aa832ca2b3"></a><br></td></tr>
cannam@0 90 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#925747d513d598e0fa21ed0ed6520980">getCopyright</a> () const </td></tr>
cannam@0 91
cannam@0 92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#925747d513d598e0fa21ed0ed6520980"></a><br></td></tr>
cannam@0 93 <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="classSpectralCentroid.html#894ca9740927102bb80b56b5e9e95877">getOutputDescriptors</a> () const </td></tr>
cannam@0 94
cannam@0 95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#894ca9740927102bb80b56b5e9e95877"></a><br></td></tr>
cannam@0 96 <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="classSpectralCentroid.html#ca96c70e7e75c9e4a7db38485018914c">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
cannam@0 97
cannam@0 98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#ca96c70e7e75c9e4a7db38485018914c"></a><br></td></tr>
cannam@0 99 <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="classSpectralCentroid.html#83ba39f0870a2f86837605a958dfab1a">getRemainingFeatures</a> ()</td></tr>
cannam@0 100
cannam@0 101 <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="#83ba39f0870a2f86837605a958dfab1a"></a><br></td></tr>
cannam@0 102 <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>
cannam@0 103
cannam@0 104 <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>
cannam@0 105 <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>
cannam@0 106
cannam@0 107 <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>
cannam@0 108 <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>
cannam@0 109
cannam@0 110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#267b42e866df3cf0d190893e8096f525"></a><br></td></tr>
cannam@0 111 <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>
cannam@0 112
cannam@0 113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br></td></tr>
cannam@0 114 <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>
cannam@0 115
cannam@0 116 <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>
cannam@0 117 <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>
cannam@0 118
cannam@21 119 <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>
cannam@0 120 <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>
cannam@0 121
cannam@0 122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#ac3e49b3b66cacfbb768dfdf07444f21"></a><br></td></tr>
cannam@0 123 <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>
cannam@0 124
cannam@0 125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#97ababcd45348ceec998d0f8e0f38bf7"></a><br></td></tr>
cannam@0 126 <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>
cannam@0 127
cannam@0 128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#6c718ce822f7b73b98940d59dcaa9366"></a><br></td></tr>
cannam@0 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>
cannam@0 130
cannam@0 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>
cannam@0 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>
cannam@0 133
cannam@0 134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#24e77eccf1bdfbbca3c79bb25e8799b3"></a><br></td></tr>
cannam@0 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>
cannam@0 136
cannam@0 137 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#add3a547ef140bae200473a9518e3353"></a><br></td></tr>
cannam@0 138 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
cannam@0 139 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#49805a090ba58477da4adbefea4392a7">m_stepSize</a></td></tr>
cannam@0 140
cannam@0 141 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#262f583d71b442bb2d80023e7c85aa4e">m_blockSize</a></td></tr>
cannam@0 142
cannam@0 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>
cannam@0 144
cannam@0 145 </table>
cannam@0 146 <hr><h2>Member Typedef Documentation</h2>
cannam@0 147 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="SpectralCentroid::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
cannam@0 148 <div class="memitem">
cannam@0 149 <div class="memproto">
cannam@0 150 <table class="memname">
cannam@0 151 <tr>
cannam@0 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>
cannam@0 153 </tr>
cannam@0 154 </table>
cannam@0 155 </div>
cannam@0 156 <div class="memdoc">
cannam@0 157
cannam@0 158 <p>
cannam@0 159
cannam@21 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>
cannam@0 161
cannam@0 162 </div>
cannam@0 163 </div><p>
cannam@0 164 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="SpectralCentroid::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
cannam@0 165 <div class="memitem">
cannam@0 166 <div class="memproto">
cannam@0 167 <table class="memname">
cannam@0 168 <tr>
cannam@0 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>
cannam@0 170 </tr>
cannam@0 171 </table>
cannam@0 172 </div>
cannam@0 173 <div class="memdoc">
cannam@0 174
cannam@0 175 <p>
cannam@0 176
cannam@21 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>
cannam@0 178
cannam@0 179 </div>
cannam@0 180 </div><p>
cannam@0 181 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="SpectralCentroid::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
cannam@0 182 <div class="memitem">
cannam@0 183 <div class="memproto">
cannam@0 184 <table class="memname">
cannam@0 185 <tr>
cannam@0 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>
cannam@0 187 </tr>
cannam@0 188 </table>
cannam@0 189 </div>
cannam@0 190 <div class="memdoc">
cannam@0 191
cannam@0 192 <p>
cannam@0 193
cannam@21 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>
cannam@0 195
cannam@0 196 </div>
cannam@0 197 </div><p>
cannam@0 198 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="SpectralCentroid::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
cannam@0 199 <div class="memitem">
cannam@0 200 <div class="memproto">
cannam@0 201 <table class="memname">
cannam@0 202 <tr>
cannam@0 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>
cannam@0 204 </tr>
cannam@0 205 </table>
cannam@0 206 </div>
cannam@0 207 <div class="memdoc">
cannam@0 208
cannam@0 209 <p>
cannam@0 210
cannam@21 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>
cannam@0 212
cannam@0 213 </div>
cannam@0 214 </div><p>
cannam@0 215 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="SpectralCentroid::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
cannam@0 216 <div class="memitem">
cannam@0 217 <div class="memproto">
cannam@0 218 <table class="memname">
cannam@0 219 <tr>
cannam@0 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>
cannam@0 221 </tr>
cannam@0 222 </table>
cannam@0 223 </div>
cannam@0 224 <div class="memdoc">
cannam@0 225
cannam@0 226 <p>
cannam@0 227
cannam@21 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>
cannam@0 229
cannam@0 230 </div>
cannam@0 231 </div><p>
cannam@0 232 <hr><h2>Member Enumeration Documentation</h2>
cannam@0 233 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="SpectralCentroid::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
cannam@0 234 <div class="memitem">
cannam@0 235 <div class="memproto">
cannam@0 236 <table class="memname">
cannam@0 237 <tr>
cannam@0 238 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
cannam@0 239 </tr>
cannam@0 240 </table>
cannam@0 241 </div>
cannam@0 242 <div class="memdoc">
cannam@0 243
cannam@0 244 <p>
cannam@0 245 <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 246 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 247 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
cannam@0 248 </td></tr>
cannam@0 249 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
cannam@0 250 </td></tr>
cannam@0 251 </table>
cannam@0 252 </dl>
cannam@0 253
cannam@21 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>
cannam@0 255
cannam@0 256 </div>
cannam@0 257 </div><p>
cannam@0 258 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@0 259 <a class="anchor" name="2cd801ad72f262eceb95ab0d22e7dbcd"></a><!-- doxytag: member="SpectralCentroid::SpectralCentroid" ref="2cd801ad72f262eceb95ab0d22e7dbcd" args="(float inputSampleRate)" -->
cannam@0 260 <div class="memitem">
cannam@0 261 <div class="memproto">
cannam@0 262 <table class="memname">
cannam@0 263 <tr>
cannam@0 264 <td class="memname">SpectralCentroid::SpectralCentroid </td>
cannam@0 265 <td>(</td>
cannam@0 266 <td class="paramtype">float&nbsp;</td>
cannam@0 267 <td class="paramname"> <em>inputSampleRate</em> </td>
cannam@0 268 <td>&nbsp;)&nbsp;</td>
cannam@21 269 <td></td>
cannam@0 270 </tr>
cannam@0 271 </table>
cannam@0 272 </div>
cannam@0 273 <div class="memdoc">
cannam@0 274
cannam@0 275 <p>
cannam@0 276
cannam@21 277 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00051">51</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 278
cannam@0 279 </div>
cannam@0 280 </div><p>
cannam@0 281 <a class="anchor" name="483e0d6757bc3dcf61e8066f764f45c6"></a><!-- doxytag: member="SpectralCentroid::~SpectralCentroid" ref="483e0d6757bc3dcf61e8066f764f45c6" args="()" -->
cannam@0 282 <div class="memitem">
cannam@0 283 <div class="memproto">
cannam@0 284 <table class="memname">
cannam@0 285 <tr>
cannam@0 286 <td class="memname">SpectralCentroid::~SpectralCentroid </td>
cannam@0 287 <td>(</td>
cannam@0 288 <td class="paramname"> </td>
cannam@0 289 <td>&nbsp;)&nbsp;</td>
cannam@21 290 <td><code> [virtual]</code></td>
cannam@0 291 </tr>
cannam@0 292 </table>
cannam@0 293 </div>
cannam@0 294 <div class="memdoc">
cannam@0 295
cannam@0 296 <p>
cannam@0 297
cannam@21 298 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00058">58</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 299
cannam@0 300 </div>
cannam@0 301 </div><p>
cannam@0 302 <hr><h2>Member Function Documentation</h2>
cannam@0 303 <a class="anchor" name="ab1ae16f5c68e2b319668f447908cedb"></a><!-- doxytag: member="SpectralCentroid::initialise" ref="ab1ae16f5c68e2b319668f447908cedb" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
cannam@0 304 <div class="memitem">
cannam@0 305 <div class="memproto">
cannam@0 306 <table class="memname">
cannam@0 307 <tr>
cannam@0 308 <td class="memname">bool SpectralCentroid::initialise </td>
cannam@0 309 <td>(</td>
cannam@0 310 <td class="paramtype">size_t&nbsp;</td>
cannam@0 311 <td class="paramname"> <em>inputChannels</em>, </td>
cannam@0 312 </tr>
cannam@0 313 <tr>
cannam@0 314 <td class="paramkey"></td>
cannam@0 315 <td></td>
cannam@0 316 <td class="paramtype">size_t&nbsp;</td>
cannam@0 317 <td class="paramname"> <em>stepSize</em>, </td>
cannam@0 318 </tr>
cannam@0 319 <tr>
cannam@0 320 <td class="paramkey"></td>
cannam@0 321 <td></td>
cannam@0 322 <td class="paramtype">size_t&nbsp;</td>
cannam@0 323 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
cannam@0 324 </tr>
cannam@0 325 <tr>
cannam@0 326 <td></td>
cannam@0 327 <td>)</td>
cannam@21 328 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 329 </tr>
cannam@0 330 </table>
cannam@0 331 </div>
cannam@0 332 <div class="memdoc">
cannam@0 333
cannam@0 334 <p>
cannam@0 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).
cannam@0 336 <p>
cannam@0 337 The input sample rate should have been already specified at construction time.<p>
cannam@0 338 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
cannam@0 339 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
cannam@0 340
cannam@21 341 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00099">99</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 342
cannam@21 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>, <a class="el" href="SpectralCentroid_8h-source.html#l00074">m_blockSize</a>, and <a class="el" href="SpectralCentroid_8h-source.html#l00073">m_stepSize</a>.</p>
cannam@0 344
cannam@0 345 </div>
cannam@0 346 </div><p>
cannam@0 347 <a class="anchor" name="9b5f5581691ff8f46bb7674d8d74395c"></a><!-- doxytag: member="SpectralCentroid::reset" ref="9b5f5581691ff8f46bb7674d8d74395c" args="()" -->
cannam@0 348 <div class="memitem">
cannam@0 349 <div class="memproto">
cannam@0 350 <table class="memname">
cannam@0 351 <tr>
cannam@0 352 <td class="memname">void SpectralCentroid::reset </td>
cannam@0 353 <td>(</td>
cannam@0 354 <td class="paramname"> </td>
cannam@0 355 <td>&nbsp;)&nbsp;</td>
cannam@21 356 <td><code> [virtual]</code></td>
cannam@0 357 </tr>
cannam@0 358 </table>
cannam@0 359 </div>
cannam@0 360 <div class="memdoc">
cannam@0 361
cannam@0 362 <p>
cannam@0 363 Reset the plugin after use, to prepare it for another clean run.
cannam@0 364 <p>
cannam@0 365 Not called for the first initialisation (i.e. initialise must also do a reset).
cannam@0 366 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
cannam@0 367
cannam@21 368 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00111">111</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 369
cannam@0 370 </div>
cannam@0 371 </div><p>
cannam@0 372 <a class="anchor" name="0ec2cb74c1c5f6e57d0bd9dcf7c8f469"></a><!-- doxytag: member="SpectralCentroid::getInputDomain" ref="0ec2cb74c1c5f6e57d0bd9dcf7c8f469" args="() const " -->
cannam@0 373 <div class="memitem">
cannam@0 374 <div class="memproto">
cannam@0 375 <table class="memname">
cannam@0 376 <tr>
cannam@0 377 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> SpectralCentroid::getInputDomain </td>
cannam@0 378 <td>(</td>
cannam@0 379 <td class="paramname"> </td>
cannam@0 380 <td>&nbsp;)&nbsp;</td>
cannam@21 381 <td> const<code> [inline, virtual]</code></td>
cannam@0 382 </tr>
cannam@0 383 </table>
cannam@0 384 </div>
cannam@0 385 <div class="memdoc">
cannam@0 386
cannam@0 387 <p>
cannam@0 388 Get the plugin's required input domain.
cannam@0 389 <p>
cannam@0 390 If this is TimeDomain, the samples provided to the <a class="el" href="classSpectralCentroid.html#ca96c70e7e75c9e4a7db38485018914c" 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="classSpectralCentroid.html#ca96c70e7e75c9e4a7db38485018914c" 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.
cannam@0 391 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
cannam@0 392
cannam@0 393 <p>Definition at line <a class="el" href="SpectralCentroid_8h-source.html#l00056">56</a> of file <a class="el" href="SpectralCentroid_8h-source.html">SpectralCentroid.h</a>.</p>
cannam@0 394
cannam@21 395 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">Vamp::Plugin::FrequencyDomain</a>.</p>
cannam@0 396
cannam@0 397 </div>
cannam@0 398 </div><p>
cannam@0 399 <a class="anchor" name="1b2c4c8440c024c4c635fcef5697949f"></a><!-- doxytag: member="SpectralCentroid::getIdentifier" ref="1b2c4c8440c024c4c635fcef5697949f" args="() const " -->
cannam@0 400 <div class="memitem">
cannam@0 401 <div class="memproto">
cannam@0 402 <table class="memname">
cannam@0 403 <tr>
cannam@0 404 <td class="memname">string SpectralCentroid::getIdentifier </td>
cannam@0 405 <td>(</td>
cannam@0 406 <td class="paramname"> </td>
cannam@0 407 <td>&nbsp;)&nbsp;</td>
cannam@21 408 <td> const<code> [virtual]</code></td>
cannam@0 409 </tr>
cannam@0 410 </table>
cannam@0 411 </div>
cannam@0 412 <div class="memdoc">
cannam@0 413
cannam@0 414 <p>
cannam@0 415 Get the computer-usable name of the plugin.
cannam@0 416 <p>
cannam@0 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>
cannam@0 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>
cannam@0 419 Example: "zero_crossings"
cannam@0 420 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
cannam@0 421
cannam@21 422 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00063">63</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 423
cannam@0 424 </div>
cannam@0 425 </div><p>
cannam@0 426 <a class="anchor" name="b7e6a620fea568af431be3cfd9dd5a41"></a><!-- doxytag: member="SpectralCentroid::getName" ref="b7e6a620fea568af431be3cfd9dd5a41" args="() const " -->
cannam@0 427 <div class="memitem">
cannam@0 428 <div class="memproto">
cannam@0 429 <table class="memname">
cannam@0 430 <tr>
cannam@0 431 <td class="memname">string SpectralCentroid::getName </td>
cannam@0 432 <td>(</td>
cannam@0 433 <td class="paramname"> </td>
cannam@0 434 <td>&nbsp;)&nbsp;</td>
cannam@21 435 <td> const<code> [virtual]</code></td>
cannam@0 436 </tr>
cannam@0 437 </table>
cannam@0 438 </div>
cannam@0 439 <div class="memdoc">
cannam@0 440
cannam@0 441 <p>
cannam@0 442 Get a human-readable name or title of the plugin.
cannam@0 443 <p>
cannam@0 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>
cannam@0 445 Example: "Zero Crossings"
cannam@0 446 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
cannam@0 447
cannam@21 448 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00069">69</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 449
cannam@0 450 </div>
cannam@0 451 </div><p>
cannam@0 452 <a class="anchor" name="8fbb74a46283057d9a0b0e4718ee943c"></a><!-- doxytag: member="SpectralCentroid::getDescription" ref="8fbb74a46283057d9a0b0e4718ee943c" args="() const " -->
cannam@0 453 <div class="memitem">
cannam@0 454 <div class="memproto">
cannam@0 455 <table class="memname">
cannam@0 456 <tr>
cannam@0 457 <td class="memname">string SpectralCentroid::getDescription </td>
cannam@0 458 <td>(</td>
cannam@0 459 <td class="paramname"> </td>
cannam@0 460 <td>&nbsp;)&nbsp;</td>
cannam@21 461 <td> const<code> [virtual]</code></td>
cannam@0 462 </tr>
cannam@0 463 </table>
cannam@0 464 </div>
cannam@0 465 <div class="memdoc">
cannam@0 466
cannam@0 467 <p>
cannam@0 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".
cannam@0 469 <p>
cannam@0 470 May be empty if the name has said it all already.<p>
cannam@0 471 Example: "Detect and count zero crossing points"
cannam@0 472 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
cannam@0 473
cannam@21 474 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00075">75</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 475
cannam@0 476 </div>
cannam@0 477 </div><p>
cannam@0 478 <a class="anchor" name="c01ff858bf67e2e93ad5d24a6ba8c8c8"></a><!-- doxytag: member="SpectralCentroid::getMaker" ref="c01ff858bf67e2e93ad5d24a6ba8c8c8" args="() const " -->
cannam@0 479 <div class="memitem">
cannam@0 480 <div class="memproto">
cannam@0 481 <table class="memname">
cannam@0 482 <tr>
cannam@0 483 <td class="memname">string SpectralCentroid::getMaker </td>
cannam@0 484 <td>(</td>
cannam@0 485 <td class="paramname"> </td>
cannam@0 486 <td>&nbsp;)&nbsp;</td>
cannam@21 487 <td> const<code> [virtual]</code></td>
cannam@0 488 </tr>
cannam@0 489 </table>
cannam@0 490 </div>
cannam@0 491 <div class="memdoc">
cannam@0 492
cannam@0 493 <p>
cannam@0 494 Get the name of the author or vendor of the plugin in human-readable form.
cannam@0 495 <p>
cannam@0 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.
cannam@0 497 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
cannam@0 498
cannam@21 499 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00081">81</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 500
cannam@0 501 </div>
cannam@0 502 </div><p>
cannam@0 503 <a class="anchor" name="f64622e66bf678ac2b0b58aa832ca2b3"></a><!-- doxytag: member="SpectralCentroid::getPluginVersion" ref="f64622e66bf678ac2b0b58aa832ca2b3" args="() const " -->
cannam@0 504 <div class="memitem">
cannam@0 505 <div class="memproto">
cannam@0 506 <table class="memname">
cannam@0 507 <tr>
cannam@0 508 <td class="memname">int SpectralCentroid::getPluginVersion </td>
cannam@0 509 <td>(</td>
cannam@0 510 <td class="paramname"> </td>
cannam@0 511 <td>&nbsp;)&nbsp;</td>
cannam@21 512 <td> const<code> [virtual]</code></td>
cannam@0 513 </tr>
cannam@0 514 </table>
cannam@0 515 </div>
cannam@0 516 <div class="memdoc">
cannam@0 517
cannam@0 518 <p>
cannam@0 519 Get the version number of the plugin.
cannam@0 520 <p>
cannam@0 521
cannam@0 522 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
cannam@0 523
cannam@21 524 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00087">87</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 525
cannam@0 526 </div>
cannam@0 527 </div><p>
cannam@0 528 <a class="anchor" name="925747d513d598e0fa21ed0ed6520980"></a><!-- doxytag: member="SpectralCentroid::getCopyright" ref="925747d513d598e0fa21ed0ed6520980" args="() const " -->
cannam@0 529 <div class="memitem">
cannam@0 530 <div class="memproto">
cannam@0 531 <table class="memname">
cannam@0 532 <tr>
cannam@0 533 <td class="memname">string SpectralCentroid::getCopyright </td>
cannam@0 534 <td>(</td>
cannam@0 535 <td class="paramname"> </td>
cannam@0 536 <td>&nbsp;)&nbsp;</td>
cannam@21 537 <td> const<code> [virtual]</code></td>
cannam@0 538 </tr>
cannam@0 539 </table>
cannam@0 540 </div>
cannam@0 541 <div class="memdoc">
cannam@0 542
cannam@0 543 <p>
cannam@0 544 Get the copyright statement or licensing summary for the plugin.
cannam@0 545 <p>
cannam@0 546 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
cannam@0 547 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
cannam@0 548
cannam@21 549 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00093">93</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 550
cannam@0 551 </div>
cannam@0 552 </div><p>
cannam@0 553 <a class="anchor" name="894ca9740927102bb80b56b5e9e95877"></a><!-- doxytag: member="SpectralCentroid::getOutputDescriptors" ref="894ca9740927102bb80b56b5e9e95877" args="() const " -->
cannam@0 554 <div class="memitem">
cannam@0 555 <div class="memproto">
cannam@0 556 <table class="memname">
cannam@0 557 <tr>
cannam@0 558 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">SpectralCentroid::OutputList</a> SpectralCentroid::getOutputDescriptors </td>
cannam@0 559 <td>(</td>
cannam@0 560 <td class="paramname"> </td>
cannam@0 561 <td>&nbsp;)&nbsp;</td>
cannam@21 562 <td> const<code> [virtual]</code></td>
cannam@0 563 </tr>
cannam@0 564 </table>
cannam@0 565 </div>
cannam@0 566 <div class="memdoc">
cannam@0 567
cannam@0 568 <p>
cannam@0 569 Get the outputs of this plugin.
cannam@0 570 <p>
cannam@0 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="classSpectralCentroid.html#ca96c70e7e75c9e4a7db38485018914c" title="Process a single block of input data.">process()</a> call.
cannam@0 572 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
cannam@0 573
cannam@21 574 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00116">116</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 575
cannam@21 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="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>
cannam@0 577
cannam@0 578 </div>
cannam@0 579 </div><p>
cannam@0 580 <a class="anchor" name="ca96c70e7e75c9e4a7db38485018914c"></a><!-- doxytag: member="SpectralCentroid::process" ref="ca96c70e7e75c9e4a7db38485018914c" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
cannam@0 581 <div class="memitem">
cannam@0 582 <div class="memproto">
cannam@0 583 <table class="memname">
cannam@0 584 <tr>
cannam@0 585 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">SpectralCentroid::FeatureSet</a> SpectralCentroid::process </td>
cannam@0 586 <td>(</td>
cannam@0 587 <td class="paramtype">const float *const *&nbsp;</td>
cannam@0 588 <td class="paramname"> <em>inputBuffers</em>, </td>
cannam@0 589 </tr>
cannam@0 590 <tr>
cannam@0 591 <td class="paramkey"></td>
cannam@0 592 <td></td>
cannam@0 593 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&nbsp;</td>
cannam@0 594 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
cannam@0 595 </tr>
cannam@0 596 <tr>
cannam@0 597 <td></td>
cannam@0 598 <td>)</td>
cannam@21 599 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 600 </tr>
cannam@0 601 </table>
cannam@0 602 </div>
cannam@0 603 <div class="memdoc">
cannam@0 604
cannam@0 605 <p>
cannam@0 606 Process a single block of input data.
cannam@0 607 <p>
cannam@21 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>
cannam@0 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>
cannam@0 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.)
cannam@0 611 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
cannam@0 612
cannam@21 613 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">141</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 614
cannam@21 615 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00339">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="SpectralCentroid_8h-source.html#l00074">m_blockSize</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="SpectralCentroid_8h-source.html#l00073">m_stepSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00369">Vamp::Plugin::Feature::values</a>.</p>
cannam@0 616
cannam@0 617 </div>
cannam@0 618 </div><p>
cannam@0 619 <a class="anchor" name="83ba39f0870a2f86837605a958dfab1a"></a><!-- doxytag: member="SpectralCentroid::getRemainingFeatures" ref="83ba39f0870a2f86837605a958dfab1a" args="()" -->
cannam@0 620 <div class="memitem">
cannam@0 621 <div class="memproto">
cannam@0 622 <table class="memname">
cannam@0 623 <tr>
cannam@0 624 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">SpectralCentroid::FeatureSet</a> SpectralCentroid::getRemainingFeatures </td>
cannam@0 625 <td>(</td>
cannam@0 626 <td class="paramname"> </td>
cannam@0 627 <td>&nbsp;)&nbsp;</td>
cannam@21 628 <td><code> [virtual]</code></td>
cannam@0 629 </tr>
cannam@0 630 </table>
cannam@0 631 </div>
cannam@0 632 <div class="memdoc">
cannam@0 633
cannam@0 634 <p>
cannam@0 635 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
cannam@0 636 <p>
cannam@0 637
cannam@0 638 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
cannam@0 639
cannam@21 640 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp-source.html#l00187">187</a> of file <a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a>.</p>
cannam@0 641
cannam@0 642 </div>
cannam@0 643 </div><p>
cannam@0 644 <a class="anchor" name="a529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="SpectralCentroid::getPreferredBlockSize" ref="a529adf83f87a603954eb31407602aac" args="() const " -->
cannam@0 645 <div class="memitem">
cannam@0 646 <div class="memproto">
cannam@0 647 <table class="memname">
cannam@0 648 <tr>
cannam@0 649 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
cannam@0 650 <td>(</td>
cannam@0 651 <td class="paramname"> </td>
cannam@0 652 <td>&nbsp;)&nbsp;</td>
cannam@21 653 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 654 </tr>
cannam@0 655 </table>
cannam@0 656 </div>
cannam@0 657 <div class="memdoc">
cannam@0 658
cannam@0 659 <p>
cannam@0 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).
cannam@0 661 <p>
cannam@0 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>
cannam@0 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.
cannam@21 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>
cannam@0 665
cannam@21 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>
cannam@0 667
cannam@21 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>
cannam@0 669
cannam@0 670 </div>
cannam@0 671 </div><p>
cannam@0 672 <a class="anchor" name="514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="SpectralCentroid::getPreferredStepSize" ref="514c716c22f81c055f19b56c3f882567" args="() const " -->
cannam@0 673 <div class="memitem">
cannam@0 674 <div class="memproto">
cannam@0 675 <table class="memname">
cannam@0 676 <tr>
cannam@0 677 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
cannam@0 678 <td>(</td>
cannam@0 679 <td class="paramname"> </td>
cannam@0 680 <td>&nbsp;)&nbsp;</td>
cannam@21 681 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 682 </tr>
cannam@0 683 </table>
cannam@0 684 </div>
cannam@0 685 <div class="memdoc">
cannam@0 686
cannam@0 687 <p>
cannam@0 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.
cannam@0 689 <p>
cannam@0 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>
cannam@0 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.
cannam@21 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>
cannam@0 693
cannam@21 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>
cannam@0 695
cannam@21 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>
cannam@0 697
cannam@0 698 </div>
cannam@0 699 </div><p>
cannam@0 700 <a class="anchor" name="267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="SpectralCentroid::getMinChannelCount" ref="267b42e866df3cf0d190893e8096f525" args="() const " -->
cannam@0 701 <div class="memitem">
cannam@0 702 <div class="memproto">
cannam@0 703 <table class="memname">
cannam@0 704 <tr>
cannam@0 705 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
cannam@0 706 <td>(</td>
cannam@0 707 <td class="paramname"> </td>
cannam@0 708 <td>&nbsp;)&nbsp;</td>
cannam@21 709 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 710 </tr>
cannam@0 711 </table>
cannam@0 712 </div>
cannam@0 713 <div class="memdoc">
cannam@0 714
cannam@0 715 <p>
cannam@0 716 Get the minimum supported number of input channels.
cannam@0 717 <p>
cannam@0 718
cannam@0 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>
cannam@0 720
cannam@21 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>
cannam@0 722
cannam@21 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">initialise()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">PowerSpectrum::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>
cannam@0 724
cannam@0 725 </div>
cannam@0 726 </div><p>
cannam@0 727 <a class="anchor" name="2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="SpectralCentroid::getMaxChannelCount" ref="2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
cannam@0 728 <div class="memitem">
cannam@0 729 <div class="memproto">
cannam@0 730 <table class="memname">
cannam@0 731 <tr>
cannam@0 732 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
cannam@0 733 <td>(</td>
cannam@0 734 <td class="paramname"> </td>
cannam@0 735 <td>&nbsp;)&nbsp;</td>
cannam@21 736 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 737 </tr>
cannam@0 738 </table>
cannam@0 739 </div>
cannam@0 740 <div class="memdoc">
cannam@0 741
cannam@0 742 <p>
cannam@0 743 Get the maximum supported number of input channels.
cannam@0 744 <p>
cannam@0 745
cannam@0 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>
cannam@0 747
cannam@21 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>
cannam@0 749
cannam@21 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">initialise()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">PowerSpectrum::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>
cannam@0 751
cannam@0 752 </div>
cannam@0 753 </div><p>
cannam@0 754 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="SpectralCentroid::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
cannam@0 755 <div class="memitem">
cannam@0 756 <div class="memproto">
cannam@0 757 <table class="memname">
cannam@0 758 <tr>
cannam@0 759 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
cannam@0 760 <td>(</td>
cannam@0 761 <td class="paramname"> </td>
cannam@0 762 <td>&nbsp;)&nbsp;</td>
cannam@21 763 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 764 </tr>
cannam@0 765 </table>
cannam@0 766 </div>
cannam@0 767 <div class="memdoc">
cannam@0 768
cannam@0 769 <p>
cannam@0 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>.
cannam@0 771 <p>
cannam@0 772 Do not reimplement this function in your subclass.
cannam@0 773 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
cannam@0 774
cannam@21 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>
cannam@0 776
cannam@0 777 </div>
cannam@0 778 </div><p>
cannam@0 779 <a class="anchor" name="8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="SpectralCentroid::getVampApiVersion" ref="8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
cannam@0 780 <div class="memitem">
cannam@0 781 <div class="memproto">
cannam@0 782 <table class="memname">
cannam@0 783 <tr>
cannam@0 784 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
cannam@0 785 <td>(</td>
cannam@0 786 <td class="paramname"> </td>
cannam@0 787 <td>&nbsp;)&nbsp;</td>
cannam@21 788 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 789 </tr>
cannam@0 790 </table>
cannam@0 791 </div>
cannam@0 792 <div class="memdoc">
cannam@0 793
cannam@0 794 <p>
cannam@21 795 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
cannam@0 796 <p>
cannam@0 797
cannam@0 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>
cannam@0 799
cannam@21 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>
cannam@0 801
cannam@21 802 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
cannam@0 803
cannam@0 804 </div>
cannam@0 805 </div><p>
cannam@0 806 <a class="anchor" name="ac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="SpectralCentroid::getParameterDescriptors" ref="ac3e49b3b66cacfbb768dfdf07444f21" args="() const " -->
cannam@0 807 <div class="memitem">
cannam@0 808 <div class="memproto">
cannam@0 809 <table class="memname">
cannam@0 810 <tr>
cannam@0 811 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
cannam@0 812 <td>(</td>
cannam@0 813 <td class="paramname"> </td>
cannam@0 814 <td>&nbsp;)&nbsp;</td>
cannam@21 815 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 816 </tr>
cannam@0 817 </table>
cannam@0 818 </div>
cannam@0 819 <div class="memdoc">
cannam@0 820
cannam@0 821 <p>
cannam@0 822 Get the controllable parameters of this plugin.
cannam@0 823 <p>
cannam@0 824
cannam@21 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>
cannam@0 826
cannam@21 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>
cannam@0 828
cannam@21 829 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
cannam@0 830
cannam@0 831 </div>
cannam@0 832 </div><p>
cannam@0 833 <a class="anchor" name="97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="SpectralCentroid::getParameter" ref="97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " -->
cannam@0 834 <div class="memitem">
cannam@0 835 <div class="memproto">
cannam@0 836 <table class="memname">
cannam@0 837 <tr>
cannam@0 838 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
cannam@0 839 <td>(</td>
cannam@0 840 <td class="paramtype">std::string&nbsp;</td>
cannam@0 841 <td class="paramname"> </td>
cannam@0 842 <td>&nbsp;)&nbsp;</td>
cannam@21 843 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 844 </tr>
cannam@0 845 </table>
cannam@0 846 </div>
cannam@0 847 <div class="memdoc">
cannam@0 848
cannam@0 849 <p>
cannam@0 850 Get the value of a named parameter.
cannam@0 851 <p>
cannam@0 852 The argument is the identifier field from that parameter's descriptor.
cannam@21 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>
cannam@0 854
cannam@21 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>
cannam@0 856
cannam@0 857 </div>
cannam@0 858 </div><p>
cannam@0 859 <a class="anchor" name="6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="SpectralCentroid::setParameter" ref="6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" -->
cannam@0 860 <div class="memitem">
cannam@0 861 <div class="memproto">
cannam@0 862 <table class="memname">
cannam@0 863 <tr>
cannam@0 864 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
cannam@0 865 <td>(</td>
cannam@0 866 <td class="paramtype">std::string&nbsp;</td>
cannam@0 867 <td class="paramname">, </td>
cannam@0 868 </tr>
cannam@0 869 <tr>
cannam@0 870 <td class="paramkey"></td>
cannam@0 871 <td></td>
cannam@0 872 <td class="paramtype">float&nbsp;</td>
cannam@0 873 <td class="paramname"></td><td>&nbsp;</td>
cannam@0 874 </tr>
cannam@0 875 <tr>
cannam@0 876 <td></td>
cannam@0 877 <td>)</td>
cannam@21 878 <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
cannam@0 879 </tr>
cannam@0 880 </table>
cannam@0 881 </div>
cannam@0 882 <div class="memdoc">
cannam@0 883
cannam@0 884 <p>
cannam@0 885 Set a named parameter.
cannam@0 886 <p>
cannam@0 887 The first argument is the identifier field from that parameter's descriptor.
cannam@21 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>
cannam@0 889
cannam@21 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>
cannam@0 891
cannam@0 892 </div>
cannam@0 893 </div><p>
cannam@0 894 <a class="anchor" name="bb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="SpectralCentroid::getPrograms" ref="bb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
cannam@0 895 <div class="memitem">
cannam@0 896 <div class="memproto">
cannam@0 897 <table class="memname">
cannam@0 898 <tr>
cannam@0 899 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
cannam@0 900 <td>(</td>
cannam@0 901 <td class="paramname"> </td>
cannam@0 902 <td>&nbsp;)&nbsp;</td>
cannam@21 903 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 904 </tr>
cannam@0 905 </table>
cannam@0 906 </div>
cannam@0 907 <div class="memdoc">
cannam@0 908
cannam@0 909 <p>
cannam@0 910 Get the program settings available in this plugin.
cannam@0 911 <p>
cannam@0 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>
cannam@0 913 The programs must have unique names.
cannam@21 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>
cannam@0 915
cannam@21 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>
cannam@0 917
cannam@0 918 </div>
cannam@0 919 </div><p>
cannam@0 920 <a class="anchor" name="24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="SpectralCentroid::getCurrentProgram" ref="24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
cannam@0 921 <div class="memitem">
cannam@0 922 <div class="memproto">
cannam@0 923 <table class="memname">
cannam@0 924 <tr>
cannam@0 925 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
cannam@0 926 <td>(</td>
cannam@0 927 <td class="paramname"> </td>
cannam@0 928 <td>&nbsp;)&nbsp;</td>
cannam@21 929 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 930 </tr>
cannam@0 931 </table>
cannam@0 932 </div>
cannam@0 933 <div class="memdoc">
cannam@0 934
cannam@0 935 <p>
cannam@0 936 Get the current program.
cannam@0 937 <p>
cannam@0 938
cannam@0 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>
cannam@0 940
cannam@21 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>
cannam@0 942
cannam@0 943 </div>
cannam@0 944 </div><p>
cannam@0 945 <a class="anchor" name="add3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="SpectralCentroid::selectProgram" ref="add3a547ef140bae200473a9518e3353" args="(std::string)" -->
cannam@0 946 <div class="memitem">
cannam@0 947 <div class="memproto">
cannam@0 948 <table class="memname">
cannam@0 949 <tr>
cannam@0 950 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
cannam@0 951 <td>(</td>
cannam@0 952 <td class="paramtype">std::string&nbsp;</td>
cannam@0 953 <td class="paramname"> </td>
cannam@0 954 <td>&nbsp;)&nbsp;</td>
cannam@21 955 <td><code> [inline, virtual, inherited]</code></td>
cannam@0 956 </tr>
cannam@0 957 </table>
cannam@0 958 </div>
cannam@0 959 <div class="memdoc">
cannam@0 960
cannam@0 961 <p>
cannam@0 962 Select a program.
cannam@0 963 <p>
cannam@0 964 (If the given program name is not one of the available programs, do nothing.)
cannam@21 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>
cannam@0 966
cannam@21 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>
cannam@0 968
cannam@0 969 </div>
cannam@0 970 </div><p>
cannam@0 971 <hr><h2>Member Data Documentation</h2>
cannam@0 972 <a class="anchor" name="49805a090ba58477da4adbefea4392a7"></a><!-- doxytag: member="SpectralCentroid::m_stepSize" ref="49805a090ba58477da4adbefea4392a7" args="" -->
cannam@0 973 <div class="memitem">
cannam@0 974 <div class="memproto">
cannam@0 975 <table class="memname">
cannam@0 976 <tr>
cannam@0 977 <td class="memname">size_t <a class="el" href="classSpectralCentroid.html#49805a090ba58477da4adbefea4392a7">SpectralCentroid::m_stepSize</a><code> [protected]</code> </td>
cannam@0 978 </tr>
cannam@0 979 </table>
cannam@0 980 </div>
cannam@0 981 <div class="memdoc">
cannam@0 982
cannam@0 983 <p>
cannam@0 984
cannam@0 985 <p>Definition at line <a class="el" href="SpectralCentroid_8h-source.html#l00073">73</a> of file <a class="el" href="SpectralCentroid_8h-source.html">SpectralCentroid.h</a>.</p>
cannam@0 986
cannam@21 987 <p>Referenced by <a class="el" href="SpectralCentroid_8cpp-source.html#l00099">initialise()</a>, and <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">process()</a>.</p>
cannam@0 988
cannam@0 989 </div>
cannam@0 990 </div><p>
cannam@0 991 <a class="anchor" name="262f583d71b442bb2d80023e7c85aa4e"></a><!-- doxytag: member="SpectralCentroid::m_blockSize" ref="262f583d71b442bb2d80023e7c85aa4e" args="" -->
cannam@0 992 <div class="memitem">
cannam@0 993 <div class="memproto">
cannam@0 994 <table class="memname">
cannam@0 995 <tr>
cannam@0 996 <td class="memname">size_t <a class="el" href="classSpectralCentroid.html#262f583d71b442bb2d80023e7c85aa4e">SpectralCentroid::m_blockSize</a><code> [protected]</code> </td>
cannam@0 997 </tr>
cannam@0 998 </table>
cannam@0 999 </div>
cannam@0 1000 <div class="memdoc">
cannam@0 1001
cannam@0 1002 <p>
cannam@0 1003
cannam@0 1004 <p>Definition at line <a class="el" href="SpectralCentroid_8h-source.html#l00074">74</a> of file <a class="el" href="SpectralCentroid_8h-source.html">SpectralCentroid.h</a>.</p>
cannam@0 1005
cannam@21 1006 <p>Referenced by <a class="el" href="SpectralCentroid_8cpp-source.html#l00099">initialise()</a>, and <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">process()</a>.</p>
cannam@0 1007
cannam@0 1008 </div>
cannam@0 1009 </div><p>
cannam@0 1010 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="SpectralCentroid::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
cannam@0 1011 <div class="memitem">
cannam@0 1012 <div class="memproto">
cannam@0 1013 <table class="memname">
cannam@0 1014 <tr>
cannam@0 1015 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
cannam@0 1016 </tr>
cannam@0 1017 </table>
cannam@0 1018 </div>
cannam@0 1019 <div class="memdoc">
cannam@0 1020
cannam@0 1021 <p>
cannam@0 1022
cannam@21 1023 <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>
cannam@0 1024
cannam@21 1025 <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">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
cannam@0 1026
cannam@0 1027 </div>
cannam@0 1028 </div><p>
cannam@0 1029 <hr>The documentation for this class was generated from the following files:<ul>
cannam@0 1030 <li><a class="el" href="SpectralCentroid_8h-source.html">SpectralCentroid.h</a><li><a class="el" href="SpectralCentroid_8cpp-source.html">SpectralCentroid.cpp</a></ul>
cannam@0 1031 </div>
cannam@21 1032 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:19 2008 for VampPluginSDK by&nbsp;
cannam@0 1033 <a href="http://www.doxygen.org/index.html">
cannam@21 1034 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
cannam@0 1035 </body>
cannam@0 1036 </html>