Mercurial > hg > vamp-docs

annotate code-docs/classSpectralCentroid.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

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