annotate code-doc/classSpectralCentroid.html @ 128:817c3988afc7 website tip

Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
rev   line source
cannam@50 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@50 2 <html xmlns="http://www.w3.org/1999/xhtml">
cannam@50 3 <head>
cannam@50 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
cannam@0 5 <title>VampPluginSDK: SpectralCentroid Class Reference</title>
cannam@50 6
cannam@50 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
cannam@50 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
cannam@50 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
cannam@50 10 <script type="text/javascript" src="jquery.js"></script>
cannam@50 11 <script type="text/javascript" src="resize.js"></script>
cannam@50 12 <script type="text/javascript" src="navtree.js"></script>
cannam@50 13 <script type="text/javascript">
cannam@50 14 $(document).ready(initResizable);
cannam@50 15 </script>
cannam@50 16
cannam@50 17
cannam@50 18 </head>
cannam@50 19 <body>
cannam@50 20 <div id="top"><!-- do not remove this div! -->
cannam@50 21
cannam@50 22
cannam@50 23 <div id="titlearea">
cannam@50 24 <table cellspacing="0" cellpadding="0">
cannam@50 25 <tbody>
cannam@50 26 <tr style="height: 56px;">
cannam@50 27
cannam@50 28
cannam@50 29 <td style="padding-left: 0.5em;">
cannam@50 30 <div id="projectname">VampPluginSDK
cannam@50 31 &#160;<span id="projectnumber">2.1</span>
cannam@50 32 </div>
cannam@50 33
cannam@50 34 </td>
cannam@50 35
cannam@50 36
cannam@50 37
cannam@50 38 </tr>
cannam@50 39 </tbody>
cannam@50 40 </table>
cannam@50 41 </div>
cannam@50 42
cannam@50 43 <!-- Generated by Doxygen 1.7.5.1 -->
cannam@50 44 <div id="navrow1" class="tabs">
cannam@50 45 <ul class="tablist">
cannam@50 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
cannam@0 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 49 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 50 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 51 </ul>
cannam@0 52 </div>
cannam@50 53 <div id="navrow2" class="tabs2">
cannam@50 54 <ul class="tablist">
cannam@50 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
cannam@50 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
cannam@50 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
cannam@0 58 </ul>
cannam@0 59 </div>
cannam@0 60 </div>
cannam@50 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
cannam@50 62 <div id="nav-tree">
cannam@50 63 <div id="nav-tree-contents">
cannam@50 64 </div>
cannam@50 65 </div>
cannam@50 66 <div id="splitbar" style="-moz-user-select:none;"
cannam@50 67 class="ui-resizable-handle">
cannam@50 68 </div>
cannam@50 69 </div>
cannam@50 70 <script type="text/javascript">
cannam@50 71 initNavTree('classSpectralCentroid.html','');
cannam@50 72 </script>
cannam@50 73 <div id="doc-content">
cannam@50 74 <div class="header">
cannam@50 75 <div class="summary">
cannam@50 76 <a href="#pub-types">Public Types</a> &#124;
cannam@50 77 <a href="#pub-methods">Public Member Functions</a> &#124;
cannam@50 78 <a href="#pro-attribs">Protected Attributes</a> </div>
cannam@50 79 <div class="headertitle">
cannam@50 80 <div class="title">SpectralCentroid Class Reference</div> </div>
cannam@50 81 </div>
cannam@0 82 <div class="contents">
cannam@50 83 <!-- doxytag: class="SpectralCentroid" --><!-- doxytag: inherits="Vamp::Plugin" -->
cannam@50 84 <p>Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio.
cannam@50 85 <a href="classSpectralCentroid.html#details">More...</a></p>
cannam@50 86
cannam@50 87 <p><code>#include &lt;<a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>&gt;</code></p>
cannam@0 88 <div class="dynheader">
cannam@0 89 Inheritance diagram for SpectralCentroid:</div>
cannam@50 90 <div class="dyncontent">
cannam@50 91 <div class="center"><img src="classSpectralCentroid__inherit__graph.png" border="0" usemap="#SpectralCentroid_inherit__map" alt="Inheritance graph"/></div>
cannam@50 92 <map name="SpectralCentroid_inherit__map" id="SpectralCentroid_inherit__map">
cannam@50 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>
cannam@50 94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
cannam@0 95
cannam@50 96 <p><a href="classSpectralCentroid-members.html">List of all members.</a></p>
cannam@50 97 <table class="memberdecls">
cannam@50 98 <tr><td colspan="2"><h2><a name="pub-types"></a>
cannam@50 99 Public Types</h2></td></tr>
cannam@50 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>,
cannam@50 101 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
cannam@0 102 }</td></tr>
cannam@50 103 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
cannam@50 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>
cannam@50 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>
cannam@50 106 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
cannam@50 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>
cannam@50 108 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
cannam@50 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>
cannam@50 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>
cannam@50 111 <tr><td colspan="2"><h2><a name="pub-methods"></a>
cannam@50 112 Public Member Functions</h2></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 120 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a0ec2cb74c1c5f6e57d0bd9dcf7c8f469"></a><br/></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 130 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#af64622e66bf678ac2b0b58aa832ca2b3"></a><br/></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 134 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a894ca9740927102bb80b56b5e9e95877"></a><br/></td></tr>
cannam@50 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>
cannam@50 136 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#aca96c70e7e75c9e4a7db38485018914c"></a><br/></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 152 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#aac3e49b3b66cacfbb768dfdf07444f21"></a><br/></td></tr>
cannam@50 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>
cannam@50 154 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a97ababcd45348ceec998d0f8e0f38bf7"></a><br/></td></tr>
cannam@50 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>
cannam@50 156 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366"></a><br/></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 160 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr>
cannam@50 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>
cannam@50 162 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr>
cannam@50 163 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
cannam@50 164 Protected Attributes</h2></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 168 </table>
cannam@50 169 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
cannam@50 170 <div class="textblock"><p>Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio. </p>
cannam@0 171
cannam@50 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>
cannam@50 173 </div><hr/><h2>Member Typedef Documentation</h2>
cannam@50 174 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="SpectralCentroid::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
cannam@0 175 <div class="memitem">
cannam@0 176 <div class="memproto">
cannam@0 177 <table class="memname">
cannam@0 178 <tr>
cannam@50 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>
cannam@0 180 </tr>
cannam@0 181 </table>
cannam@0 182 </div>
cannam@0 183 <div class="memdoc">
cannam@0 184
cannam@50 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>
cannam@0 186
cannam@0 187 </div>
cannam@50 188 </div>
cannam@50 189 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="SpectralCentroid::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
cannam@0 190 <div class="memitem">
cannam@0 191 <div class="memproto">
cannam@0 192 <table class="memname">
cannam@0 193 <tr>
cannam@50 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>
cannam@0 195 </tr>
cannam@0 196 </table>
cannam@0 197 </div>
cannam@0 198 <div class="memdoc">
cannam@0 199
cannam@50 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>
cannam@0 201
cannam@0 202 </div>
cannam@50 203 </div>
cannam@50 204 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="SpectralCentroid::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
cannam@0 205 <div class="memitem">
cannam@0 206 <div class="memproto">
cannam@0 207 <table class="memname">
cannam@0 208 <tr>
cannam@50 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>
cannam@0 210 </tr>
cannam@0 211 </table>
cannam@0 212 </div>
cannam@0 213 <div class="memdoc">
cannam@0 214
cannam@50 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>
cannam@0 216
cannam@0 217 </div>
cannam@50 218 </div>
cannam@50 219 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="SpectralCentroid::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
cannam@0 220 <div class="memitem">
cannam@0 221 <div class="memproto">
cannam@0 222 <table class="memname">
cannam@0 223 <tr>
cannam@50 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>
cannam@0 225 </tr>
cannam@0 226 </table>
cannam@0 227 </div>
cannam@0 228 <div class="memdoc">
cannam@0 229
cannam@50 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>
cannam@0 231
cannam@0 232 </div>
cannam@50 233 </div>
cannam@50 234 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="SpectralCentroid::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
cannam@0 235 <div class="memitem">
cannam@0 236 <div class="memproto">
cannam@0 237 <table class="memname">
cannam@0 238 <tr>
cannam@50 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>
cannam@0 240 </tr>
cannam@0 241 </table>
cannam@0 242 </div>
cannam@0 243 <div class="memdoc">
cannam@0 244
cannam@50 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>
cannam@0 246
cannam@0 247 </div>
cannam@50 248 </div>
cannam@50 249 <hr/><h2>Member Enumeration Documentation</h2>
cannam@50 250 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="SpectralCentroid::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
cannam@0 251 <div class="memitem">
cannam@0 252 <div class="memproto">
cannam@0 253 <table class="memname">
cannam@0 254 <tr>
cannam@50 255 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
cannam@0 256 </tr>
cannam@0 257 </table>
cannam@0 258 </div>
cannam@0 259 <div class="memdoc">
cannam@50 260 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
cannam@50 261 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
cannam@0 262 </td></tr>
cannam@50 263 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
cannam@0 264 </td></tr>
cannam@0 265 </table>
cannam@50 266 </dd>
cannam@0 267 </dl>
cannam@0 268
cannam@50 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>
cannam@0 270
cannam@0 271 </div>
cannam@50 272 </div>
cannam@50 273 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
cannam@50 274 <a class="anchor" id="a2cd801ad72f262eceb95ab0d22e7dbcd"></a><!-- doxytag: member="SpectralCentroid::SpectralCentroid" ref="a2cd801ad72f262eceb95ab0d22e7dbcd" args="(float inputSampleRate)" -->
cannam@0 275 <div class="memitem">
cannam@0 276 <div class="memproto">
cannam@0 277 <table class="memname">
cannam@0 278 <tr>
cannam@50 279 <td class="memname">SpectralCentroid::SpectralCentroid </td>
cannam@0 280 <td>(</td>
cannam@50 281 <td class="paramtype">float&#160;</td>
cannam@50 282 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
cannam@21 283 <td></td>
cannam@0 284 </tr>
cannam@0 285 </table>
cannam@0 286 </div>
cannam@0 287 <div class="memdoc">
cannam@0 288
cannam@50 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>
cannam@0 290
cannam@0 291 </div>
cannam@50 292 </div>
cannam@50 293 <a class="anchor" id="a483e0d6757bc3dcf61e8066f764f45c6"></a><!-- doxytag: member="SpectralCentroid::~SpectralCentroid" ref="a483e0d6757bc3dcf61e8066f764f45c6" args="()" -->
cannam@0 294 <div class="memitem">
cannam@0 295 <div class="memproto">
cannam@0 296 <table class="memname">
cannam@0 297 <tr>
cannam@50 298 <td class="memname">SpectralCentroid::~SpectralCentroid </td>
cannam@0 299 <td>(</td>
cannam@50 300 <td class="paramname"></td><td>)</td>
cannam@21 301 <td><code> [virtual]</code></td>
cannam@0 302 </tr>
cannam@0 303 </table>
cannam@0 304 </div>
cannam@0 305 <div class="memdoc">
cannam@0 306
cannam@50 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>
cannam@0 308
cannam@0 309 </div>
cannam@50 310 </div>
cannam@50 311 <hr/><h2>Member Function Documentation</h2>
cannam@50 312 <a class="anchor" id="aab1ae16f5c68e2b319668f447908cedb"></a><!-- doxytag: member="SpectralCentroid::initialise" ref="aab1ae16f5c68e2b319668f447908cedb" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
cannam@0 313 <div class="memitem">
cannam@0 314 <div class="memproto">
cannam@0 315 <table class="memname">
cannam@0 316 <tr>
cannam@50 317 <td class="memname">bool SpectralCentroid::initialise </td>
cannam@0 318 <td>(</td>
cannam@50 319 <td class="paramtype">size_t&#160;</td>
cannam@50 320 <td class="paramname"><em>inputChannels</em>, </td>
cannam@0 321 </tr>
cannam@0 322 <tr>
cannam@0 323 <td class="paramkey"></td>
cannam@0 324 <td></td>
cannam@50 325 <td class="paramtype">size_t&#160;</td>
cannam@50 326 <td class="paramname"><em>stepSize</em>, </td>
cannam@0 327 </tr>
cannam@0 328 <tr>
cannam@0 329 <td class="paramkey"></td>
cannam@0 330 <td></td>
cannam@50 331 <td class="paramtype">size_t&#160;</td>
cannam@50 332 <td class="paramname"><em>blockSize</em>&#160;</td>
cannam@0 333 </tr>
cannam@0 334 <tr>
cannam@0 335 <td></td>
cannam@0 336 <td>)</td>
cannam@50 337 <td></td><td><code> [virtual]</code></td>
cannam@0 338 </tr>
cannam@0 339 </table>
cannam@0 340 </div>
cannam@0 341 <div class="memdoc">
cannam@0 342
cannam@50 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>
cannam@50 344 <p>The input sample rate should have been already specified at construction time.</p>
cannam@50 345 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
cannam@0 346
cannam@50 347 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
cannam@0 348
cannam@50 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>
cannam@50 350
cannam@50 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>
cannam@0 352
cannam@0 353 </div>
cannam@50 354 </div>
cannam@50 355 <a class="anchor" id="a9b5f5581691ff8f46bb7674d8d74395c"></a><!-- doxytag: member="SpectralCentroid::reset" ref="a9b5f5581691ff8f46bb7674d8d74395c" args="()" -->
cannam@0 356 <div class="memitem">
cannam@0 357 <div class="memproto">
cannam@0 358 <table class="memname">
cannam@0 359 <tr>
cannam@50 360 <td class="memname">void SpectralCentroid::reset </td>
cannam@0 361 <td>(</td>
cannam@50 362 <td class="paramname"></td><td>)</td>
cannam@21 363 <td><code> [virtual]</code></td>
cannam@0 364 </tr>
cannam@0 365 </table>
cannam@0 366 </div>
cannam@0 367 <div class="memdoc">
cannam@0 368
cannam@50 369 <p>Reset the plugin after use, to prepare it for another clean run. </p>
cannam@50 370 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
cannam@0 371
cannam@50 372 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
cannam@50 373
cannam@50 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>
cannam@0 375
cannam@0 376 </div>
cannam@50 377 </div>
cannam@50 378 <a class="anchor" id="a0ec2cb74c1c5f6e57d0bd9dcf7c8f469"></a><!-- doxytag: member="SpectralCentroid::getInputDomain" ref="a0ec2cb74c1c5f6e57d0bd9dcf7c8f469" args="() const " -->
cannam@0 379 <div class="memitem">
cannam@0 380 <div class="memproto">
cannam@0 381 <table class="memname">
cannam@0 382 <tr>
cannam@50 383 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> SpectralCentroid::getInputDomain </td>
cannam@0 384 <td>(</td>
cannam@50 385 <td class="paramname"></td><td>)</td>
cannam@21 386 <td> const<code> [inline, virtual]</code></td>
cannam@0 387 </tr>
cannam@0 388 </table>
cannam@0 389 </div>
cannam@0 390 <div class="memdoc">
cannam@0 391
cannam@50 392 <p>Get the plugin's required input domain. </p>
cannam@50 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>
cannam@50 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>
cannam@0 395
cannam@50 396 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
cannam@0 397
cannam@50 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>
cannam@50 399
cannam@50 400 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::FrequencyDomain</a>.</p>
cannam@0 401
cannam@0 402 </div>
cannam@50 403 </div>
cannam@50 404 <a class="anchor" id="a1b2c4c8440c024c4c635fcef5697949f"></a><!-- doxytag: member="SpectralCentroid::getIdentifier" ref="a1b2c4c8440c024c4c635fcef5697949f" args="() const " -->
cannam@0 405 <div class="memitem">
cannam@0 406 <div class="memproto">
cannam@0 407 <table class="memname">
cannam@0 408 <tr>
cannam@50 409 <td class="memname">string SpectralCentroid::getIdentifier </td>
cannam@0 410 <td>(</td>
cannam@50 411 <td class="paramname"></td><td>)</td>
cannam@21 412 <td> const<code> [virtual]</code></td>
cannam@0 413 </tr>
cannam@0 414 </table>
cannam@0 415 </div>
cannam@0 416 <div class="memdoc">
cannam@0 417
cannam@50 418 <p>Get the computer-usable name of the plugin. </p>
cannam@50 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>
cannam@50 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>
cannam@50 421 <p>Example: "zero_crossings" </p>
cannam@0 422
cannam@50 423 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
cannam@50 424
cannam@50 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>
cannam@0 426
cannam@0 427 </div>
cannam@50 428 </div>
cannam@50 429 <a class="anchor" id="ab7e6a620fea568af431be3cfd9dd5a41"></a><!-- doxytag: member="SpectralCentroid::getName" ref="ab7e6a620fea568af431be3cfd9dd5a41" args="() const " -->
cannam@0 430 <div class="memitem">
cannam@0 431 <div class="memproto">
cannam@0 432 <table class="memname">
cannam@0 433 <tr>
cannam@50 434 <td class="memname">string SpectralCentroid::getName </td>
cannam@0 435 <td>(</td>
cannam@50 436 <td class="paramname"></td><td>)</td>
cannam@21 437 <td> const<code> [virtual]</code></td>
cannam@0 438 </tr>
cannam@0 439 </table>
cannam@0 440 </div>
cannam@0 441 <div class="memdoc">
cannam@0 442
cannam@50 443 <p>Get a human-readable name or title of the plugin. </p>
cannam@50 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>
cannam@50 445 <p>Example: "Zero Crossings" </p>
cannam@0 446
cannam@50 447 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
cannam@50 448
cannam@50 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>
cannam@0 450
cannam@0 451 </div>
cannam@50 452 </div>
cannam@50 453 <a class="anchor" id="a8fbb74a46283057d9a0b0e4718ee943c"></a><!-- doxytag: member="SpectralCentroid::getDescription" ref="a8fbb74a46283057d9a0b0e4718ee943c" args="() const " -->
cannam@0 454 <div class="memitem">
cannam@0 455 <div class="memproto">
cannam@0 456 <table class="memname">
cannam@0 457 <tr>
cannam@50 458 <td class="memname">string SpectralCentroid::getDescription </td>
cannam@0 459 <td>(</td>
cannam@50 460 <td class="paramname"></td><td>)</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@50 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>
cannam@50 468 <p>May be empty if the name has said it all already.</p>
cannam@50 469 <p>Example: "Detect and count zero crossing points" </p>
cannam@0 470
cannam@50 471 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
cannam@50 472
cannam@50 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>
cannam@0 474
cannam@0 475 </div>
cannam@50 476 </div>
cannam@50 477 <a class="anchor" id="ac01ff858bf67e2e93ad5d24a6ba8c8c8"></a><!-- doxytag: member="SpectralCentroid::getMaker" ref="ac01ff858bf67e2e93ad5d24a6ba8c8c8" args="() const " -->
cannam@0 478 <div class="memitem">
cannam@0 479 <div class="memproto">
cannam@0 480 <table class="memname">
cannam@0 481 <tr>
cannam@50 482 <td class="memname">string SpectralCentroid::getMaker </td>
cannam@0 483 <td>(</td>
cannam@50 484 <td class="paramname"></td><td>)</td>
cannam@21 485 <td> const<code> [virtual]</code></td>
cannam@0 486 </tr>
cannam@0 487 </table>
cannam@0 488 </div>
cannam@0 489 <div class="memdoc">
cannam@0 490
cannam@50 491 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
cannam@50 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>
cannam@0 493
cannam@50 494 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
cannam@50 495
cannam@50 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>
cannam@0 497
cannam@0 498 </div>
cannam@50 499 </div>
cannam@50 500 <a class="anchor" id="af64622e66bf678ac2b0b58aa832ca2b3"></a><!-- doxytag: member="SpectralCentroid::getPluginVersion" ref="af64622e66bf678ac2b0b58aa832ca2b3" args="() const " -->
cannam@0 501 <div class="memitem">
cannam@0 502 <div class="memproto">
cannam@0 503 <table class="memname">
cannam@0 504 <tr>
cannam@50 505 <td class="memname">int SpectralCentroid::getPluginVersion </td>
cannam@0 506 <td>(</td>
cannam@50 507 <td class="paramname"></td><td>)</td>
cannam@21 508 <td> const<code> [virtual]</code></td>
cannam@0 509 </tr>
cannam@0 510 </table>
cannam@0 511 </div>
cannam@0 512 <div class="memdoc">
cannam@0 513
cannam@50 514 <p>Get the version number of the plugin. </p>
cannam@0 515
cannam@50 516 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
cannam@0 517
cannam@50 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>
cannam@0 519
cannam@0 520 </div>
cannam@50 521 </div>
cannam@50 522 <a class="anchor" id="a925747d513d598e0fa21ed0ed6520980"></a><!-- doxytag: member="SpectralCentroid::getCopyright" ref="a925747d513d598e0fa21ed0ed6520980" args="() const " -->
cannam@0 523 <div class="memitem">
cannam@0 524 <div class="memproto">
cannam@0 525 <table class="memname">
cannam@0 526 <tr>
cannam@50 527 <td class="memname">string SpectralCentroid::getCopyright </td>
cannam@0 528 <td>(</td>
cannam@50 529 <td class="paramname"></td><td>)</td>
cannam@21 530 <td> const<code> [virtual]</code></td>
cannam@0 531 </tr>
cannam@0 532 </table>
cannam@0 533 </div>
cannam@0 534 <div class="memdoc">
cannam@0 535
cannam@50 536 <p>Get the copyright statement or licensing summary for the plugin. </p>
cannam@50 537 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
cannam@0 538
cannam@50 539 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
cannam@50 540
cannam@50 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>
cannam@0 542
cannam@0 543 </div>
cannam@50 544 </div>
cannam@50 545 <a class="anchor" id="a894ca9740927102bb80b56b5e9e95877"></a><!-- doxytag: member="SpectralCentroid::getOutputDescriptors" ref="a894ca9740927102bb80b56b5e9e95877" args="() const " -->
cannam@0 546 <div class="memitem">
cannam@0 547 <div class="memproto">
cannam@0 548 <table class="memname">
cannam@0 549 <tr>
cannam@50 550 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">SpectralCentroid::OutputList</a> SpectralCentroid::getOutputDescriptors </td>
cannam@0 551 <td>(</td>
cannam@50 552 <td class="paramname"></td><td>)</td>
cannam@21 553 <td> const<code> [virtual]</code></td>
cannam@0 554 </tr>
cannam@0 555 </table>
cannam@0 556 </div>
cannam@0 557 <div class="memdoc">
cannam@0 558
cannam@50 559 <p>Get the outputs of this plugin. </p>
cannam@50 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>
cannam@0 561
cannam@50 562 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
cannam@0 563
cannam@50 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>
cannam@50 565
cannam@50 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>
cannam@0 567
cannam@0 568 </div>
cannam@50 569 </div>
cannam@50 570 <a class="anchor" id="aca96c70e7e75c9e4a7db38485018914c"></a><!-- doxytag: member="SpectralCentroid::process" ref="aca96c70e7e75c9e4a7db38485018914c" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
cannam@0 571 <div class="memitem">
cannam@0 572 <div class="memproto">
cannam@0 573 <table class="memname">
cannam@0 574 <tr>
cannam@50 575 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">SpectralCentroid::FeatureSet</a> SpectralCentroid::process </td>
cannam@0 576 <td>(</td>
cannam@50 577 <td class="paramtype">const float *const *&#160;</td>
cannam@50 578 <td class="paramname"><em>inputBuffers</em>, </td>
cannam@0 579 </tr>
cannam@0 580 <tr>
cannam@0 581 <td class="paramkey"></td>
cannam@0 582 <td></td>
cannam@50 583 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
cannam@50 584 <td class="paramname"><em>timestamp</em>&#160;</td>
cannam@0 585 </tr>
cannam@0 586 <tr>
cannam@0 587 <td></td>
cannam@0 588 <td>)</td>
cannam@50 589 <td></td><td><code> [virtual]</code></td>
cannam@0 590 </tr>
cannam@0 591 </table>
cannam@0 592 </div>
cannam@0 593 <div class="memdoc">
cannam@0 594
cannam@50 595 <p>Process a single block of input data. </p>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@0 599
cannam@50 600 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
cannam@0 601
cannam@50 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>
cannam@50 603
cannam@50 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>
cannam@0 605
cannam@0 606 </div>
cannam@50 607 </div>
cannam@50 608 <a class="anchor" id="a83ba39f0870a2f86837605a958dfab1a"></a><!-- doxytag: member="SpectralCentroid::getRemainingFeatures" ref="a83ba39f0870a2f86837605a958dfab1a" args="()" -->
cannam@0 609 <div class="memitem">
cannam@0 610 <div class="memproto">
cannam@0 611 <table class="memname">
cannam@0 612 <tr>
cannam@50 613 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">SpectralCentroid::FeatureSet</a> SpectralCentroid::getRemainingFeatures </td>
cannam@0 614 <td>(</td>
cannam@50 615 <td class="paramname"></td><td>)</td>
cannam@21 616 <td><code> [virtual]</code></td>
cannam@0 617 </tr>
cannam@0 618 </table>
cannam@0 619 </div>
cannam@0 620 <div class="memdoc">
cannam@0 621
cannam@50 622 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
cannam@0 623
cannam@50 624 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
cannam@0 625
cannam@50 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>
cannam@0 627
cannam@0 628 </div>
cannam@50 629 </div>
cannam@50 630 <a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="SpectralCentroid::getPreferredBlockSize" ref="aa529adf83f87a603954eb31407602aac" args="() const " -->
cannam@0 631 <div class="memitem">
cannam@0 632 <div class="memproto">
cannam@0 633 <table class="memname">
cannam@0 634 <tr>
cannam@50 635 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
cannam@0 636 <td>(</td>
cannam@50 637 <td class="paramname"></td><td>)</td>
cannam@21 638 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 639 </tr>
cannam@0 640 </table>
cannam@0 641 </div>
cannam@0 642 <div class="memdoc">
cannam@0 643
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@0 647
cannam@50 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>
cannam@0 649
cannam@50 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>
cannam@50 651
cannam@50 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>
cannam@0 653
cannam@0 654 </div>
cannam@50 655 </div>
cannam@50 656 <a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="SpectralCentroid::getPreferredStepSize" ref="a514c716c22f81c055f19b56c3f882567" args="() const " -->
cannam@0 657 <div class="memitem">
cannam@0 658 <div class="memproto">
cannam@0 659 <table class="memname">
cannam@0 660 <tr>
cannam@50 661 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
cannam@0 662 <td>(</td>
cannam@50 663 <td class="paramname"></td><td>)</td>
cannam@21 664 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 665 </tr>
cannam@0 666 </table>
cannam@0 667 </div>
cannam@0 668 <div class="memdoc">
cannam@0 669
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@0 673
cannam@50 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>
cannam@0 675
cannam@50 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>
cannam@50 677
cannam@50 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>
cannam@0 679
cannam@0 680 </div>
cannam@50 681 </div>
cannam@50 682 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="SpectralCentroid::getMinChannelCount" ref="a267b42e866df3cf0d190893e8096f525" args="() const " -->
cannam@0 683 <div class="memitem">
cannam@0 684 <div class="memproto">
cannam@0 685 <table class="memname">
cannam@0 686 <tr>
cannam@50 687 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
cannam@0 688 <td>(</td>
cannam@50 689 <td class="paramname"></td><td>)</td>
cannam@21 690 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 691 </tr>
cannam@0 692 </table>
cannam@0 693 </div>
cannam@0 694 <div class="memdoc">
cannam@0 695
cannam@50 696 <p>Get the minimum supported number of input channels. </p>
cannam@0 697
cannam@50 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>
cannam@0 699
cannam@50 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>
cannam@0 701
cannam@50 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>
cannam@0 703
cannam@0 704 </div>
cannam@50 705 </div>
cannam@50 706 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="SpectralCentroid::getMaxChannelCount" ref="a2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
cannam@0 707 <div class="memitem">
cannam@0 708 <div class="memproto">
cannam@0 709 <table class="memname">
cannam@0 710 <tr>
cannam@50 711 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
cannam@0 712 <td>(</td>
cannam@50 713 <td class="paramname"></td><td>)</td>
cannam@21 714 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 715 </tr>
cannam@0 716 </table>
cannam@0 717 </div>
cannam@0 718 <div class="memdoc">
cannam@0 719
cannam@50 720 <p>Get the maximum supported number of input channels. </p>
cannam@0 721
cannam@50 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>
cannam@0 723
cannam@50 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>
cannam@0 725
cannam@50 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>
cannam@0 727
cannam@0 728 </div>
cannam@50 729 </div>
cannam@50 730 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="SpectralCentroid::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
cannam@0 731 <div class="memitem">
cannam@0 732 <div class="memproto">
cannam@0 733 <table class="memname">
cannam@0 734 <tr>
cannam@50 735 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
cannam@0 736 <td>(</td>
cannam@50 737 <td class="paramname"></td><td>)</td>
cannam@21 738 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 739 </tr>
cannam@0 740 </table>
cannam@0 741 </div>
cannam@0 742 <div class="memdoc">
cannam@0 743
cannam@50 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>
cannam@50 745 <p>Do not reimplement this function in your subclass. </p>
cannam@0 746
cannam@50 747 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
cannam@50 748
cannam@50 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>
cannam@0 750
cannam@0 751 </div>
cannam@50 752 </div>
cannam@50 753 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="SpectralCentroid::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
cannam@0 754 <div class="memitem">
cannam@0 755 <div class="memproto">
cannam@0 756 <table class="memname">
cannam@0 757 <tr>
cannam@50 758 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
cannam@0 759 <td>(</td>
cannam@50 760 <td class="paramname"></td><td>)</td>
cannam@21 761 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 762 </tr>
cannam@0 763 </table>
cannam@0 764 </div>
cannam@0 765 <div class="memdoc">
cannam@0 766
cannam@50 767 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
cannam@0 768
cannam@50 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>
cannam@0 770
cannam@50 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>
cannam@0 772
cannam@50 773 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
cannam@0 774
cannam@0 775 </div>
cannam@50 776 </div>
cannam@50 777 <a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="SpectralCentroid::getParameterDescriptors" ref="aac3e49b3b66cacfbb768dfdf07444f21" args="() const " -->
cannam@0 778 <div class="memitem">
cannam@0 779 <div class="memproto">
cannam@0 780 <table class="memname">
cannam@0 781 <tr>
cannam@50 782 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
cannam@0 783 <td>(</td>
cannam@50 784 <td class="paramname"></td><td>)</td>
cannam@21 785 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 786 </tr>
cannam@0 787 </table>
cannam@0 788 </div>
cannam@0 789 <div class="memdoc">
cannam@0 790
cannam@50 791 <p>Get the controllable parameters of this plugin. </p>
cannam@0 792
cannam@50 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>
cannam@0 794
cannam@50 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>
cannam@0 796
cannam@50 797 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
cannam@0 798
cannam@0 799 </div>
cannam@50 800 </div>
cannam@50 801 <a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="SpectralCentroid::getParameter" ref="a97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " -->
cannam@0 802 <div class="memitem">
cannam@0 803 <div class="memproto">
cannam@0 804 <table class="memname">
cannam@0 805 <tr>
cannam@50 806 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
cannam@0 807 <td>(</td>
cannam@50 808 <td class="paramtype">std::string&#160;</td>
cannam@50 809 <td class="paramname"></td><td>)</td>
cannam@21 810 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 811 </tr>
cannam@0 812 </table>
cannam@0 813 </div>
cannam@0 814 <div class="memdoc">
cannam@0 815
cannam@50 816 <p>Get the value of a named parameter. </p>
cannam@50 817 <p>The argument is the identifier field from that parameter's descriptor. </p>
cannam@0 818
cannam@50 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>
cannam@50 820
cannam@50 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>
cannam@0 822
cannam@0 823 </div>
cannam@50 824 </div>
cannam@50 825 <a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="SpectralCentroid::setParameter" ref="a6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" -->
cannam@0 826 <div class="memitem">
cannam@0 827 <div class="memproto">
cannam@0 828 <table class="memname">
cannam@0 829 <tr>
cannam@50 830 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
cannam@0 831 <td>(</td>
cannam@50 832 <td class="paramtype">std::string&#160;</td>
cannam@0 833 <td class="paramname">, </td>
cannam@0 834 </tr>
cannam@0 835 <tr>
cannam@0 836 <td class="paramkey"></td>
cannam@0 837 <td></td>
cannam@50 838 <td class="paramtype">float&#160;</td>
cannam@50 839 <td class="paramname">&#160;</td>
cannam@0 840 </tr>
cannam@0 841 <tr>
cannam@0 842 <td></td>
cannam@0 843 <td>)</td>
cannam@50 844 <td></td><td><code> [inline, virtual, inherited]</code></td>
cannam@0 845 </tr>
cannam@0 846 </table>
cannam@0 847 </div>
cannam@0 848 <div class="memdoc">
cannam@0 849
cannam@50 850 <p>Set a named parameter. </p>
cannam@50 851 <p>The first argument is the identifier field from that parameter's descriptor. </p>
cannam@0 852
cannam@50 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>
cannam@50 854
cannam@50 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>
cannam@0 856
cannam@0 857 </div>
cannam@50 858 </div>
cannam@50 859 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="SpectralCentroid::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
cannam@0 860 <div class="memitem">
cannam@0 861 <div class="memproto">
cannam@0 862 <table class="memname">
cannam@0 863 <tr>
cannam@50 864 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
cannam@0 865 <td>(</td>
cannam@50 866 <td class="paramname"></td><td>)</td>
cannam@21 867 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 868 </tr>
cannam@0 869 </table>
cannam@0 870 </div>
cannam@0 871 <div class="memdoc">
cannam@0 872
cannam@50 873 <p>Get the program settings available in this plugin. </p>
cannam@50 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>
cannam@50 875 <p>The programs must have unique names. </p>
cannam@0 876
cannam@50 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>
cannam@50 878
cannam@50 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>
cannam@0 880
cannam@0 881 </div>
cannam@50 882 </div>
cannam@50 883 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="SpectralCentroid::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
cannam@0 884 <div class="memitem">
cannam@0 885 <div class="memproto">
cannam@0 886 <table class="memname">
cannam@0 887 <tr>
cannam@50 888 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
cannam@0 889 <td>(</td>
cannam@50 890 <td class="paramname"></td><td>)</td>
cannam@21 891 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 892 </tr>
cannam@0 893 </table>
cannam@0 894 </div>
cannam@0 895 <div class="memdoc">
cannam@0 896
cannam@50 897 <p>Get the current program. </p>
cannam@0 898
cannam@50 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>
cannam@0 900
cannam@50 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>
cannam@0 902
cannam@0 903 </div>
cannam@50 904 </div>
cannam@50 905 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="SpectralCentroid::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" -->
cannam@0 906 <div class="memitem">
cannam@0 907 <div class="memproto">
cannam@0 908 <table class="memname">
cannam@0 909 <tr>
cannam@50 910 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
cannam@0 911 <td>(</td>
cannam@50 912 <td class="paramtype">std::string&#160;</td>
cannam@50 913 <td class="paramname"></td><td>)</td>
cannam@21 914 <td><code> [inline, virtual, inherited]</code></td>
cannam@0 915 </tr>
cannam@0 916 </table>
cannam@0 917 </div>
cannam@0 918 <div class="memdoc">
cannam@0 919
cannam@50 920 <p>Select a program. </p>
cannam@50 921 <p>(If the given program name is not one of the available programs, do nothing.) </p>
cannam@0 922
cannam@50 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>
cannam@50 924
cannam@50 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>
cannam@0 926
cannam@0 927 </div>
cannam@50 928 </div>
cannam@50 929 <hr/><h2>Member Data Documentation</h2>
cannam@50 930 <a class="anchor" id="a49805a090ba58477da4adbefea4392a7"></a><!-- doxytag: member="SpectralCentroid::m_stepSize" ref="a49805a090ba58477da4adbefea4392a7" args="" -->
cannam@0 931 <div class="memitem">
cannam@0 932 <div class="memproto">
cannam@0 933 <table class="memname">
cannam@0 934 <tr>
cannam@50 935 <td class="memname">size_t <a class="el" href="classSpectralCentroid.html#a49805a090ba58477da4adbefea4392a7">SpectralCentroid::m_stepSize</a><code> [protected]</code></td>
cannam@0 936 </tr>
cannam@0 937 </table>
cannam@0 938 </div>
cannam@0 939 <div class="memdoc">
cannam@0 940
cannam@50 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>
cannam@0 942
cannam@50 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>
cannam@0 944
cannam@0 945 </div>
cannam@50 946 </div>
cannam@50 947 <a class="anchor" id="a262f583d71b442bb2d80023e7c85aa4e"></a><!-- doxytag: member="SpectralCentroid::m_blockSize" ref="a262f583d71b442bb2d80023e7c85aa4e" args="" -->
cannam@0 948 <div class="memitem">
cannam@0 949 <div class="memproto">
cannam@0 950 <table class="memname">
cannam@0 951 <tr>
cannam@50 952 <td class="memname">size_t <a class="el" href="classSpectralCentroid.html#a262f583d71b442bb2d80023e7c85aa4e">SpectralCentroid::m_blockSize</a><code> [protected]</code></td>
cannam@0 953 </tr>
cannam@0 954 </table>
cannam@0 955 </div>
cannam@0 956 <div class="memdoc">
cannam@0 957
cannam@50 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>
cannam@0 959
cannam@50 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>
cannam@0 961
cannam@0 962 </div>
cannam@50 963 </div>
cannam@50 964 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="SpectralCentroid::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
cannam@0 965 <div class="memitem">
cannam@0 966 <div class="memproto">
cannam@0 967 <table class="memname">
cannam@0 968 <tr>
cannam@50 969 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
cannam@0 970 </tr>
cannam@0 971 </table>
cannam@0 972 </div>
cannam@0 973 <div class="memdoc">
cannam@0 974
cannam@50 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>
cannam@0 976
cannam@50 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>
cannam@0 978
cannam@0 979 </div>
cannam@0 980 </div>
cannam@50 981 <hr/>The documentation for this class was generated from the following files:<ul>
cannam@50 982 <li><a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a></li>
cannam@50 983 <li><a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a></li>
cannam@50 984 </ul>
cannam@50 985 </div>
cannam@50 986 </div>
cannam@50 987 <div id="nav-path" class="navpath">
cannam@50 988 <ul>
cannam@50 989 <li class="navelem"><a class="el" href="classSpectralCentroid.html">SpectralCentroid</a> </li>
cannam@50 990
cannam@50 991 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
cannam@50 992 <a href="http://www.doxygen.org/index.html">
cannam@50 993 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
cannam@50 994 </ul>
cannam@50 995 </div>
cannam@50 996
cannam@50 997
cannam@0 998 </body>
cannam@0 999 </html>