Mercurial > hg > vamp-docs

annotate code-docs/classFixedTempoEstimator.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: FixedTempoEstimator 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('classFixedTempoEstimator.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="#nested-classes">Classes</a> &#124;
Chris@1 77 <a href="#pub-types">Public Types</a> &#124;
Chris@1 78 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@1 79 <a href="#pro-attribs">Protected Attributes</a> </div>
Chris@1 80 <div class="headertitle">
Chris@1 81 <div class="title">FixedTempoEstimator Class Reference</div> </div>
Chris@1 82 </div>
Chris@1 83 <div class="contents">
Chris@1 84 <!-- doxytag: class="FixedTempoEstimator" --><!-- doxytag: inherits="Vamp::Plugin" -->
Chris@1 85 <p>Example plugin that estimates the tempo of a short fixed-tempo sample.
Chris@1 86 <a href="classFixedTempoEstimator.html#details">More...</a></p>
Chris@1 87
Chris@1 88 <p><code>#include &lt;<a class="el" href="FixedTempoEstimator_8h_source.html">FixedTempoEstimator.h</a>&gt;</code></p>
Chris@1 89 <div class="dynheader">
Chris@1 90 Inheritance diagram for FixedTempoEstimator:</div>
Chris@1 91 <div class="dyncontent">
Chris@1 92 <div class="center"><img src="classFixedTempoEstimator__inherit__graph.png" border="0" usemap="#FixedTempoEstimator_inherit__map" alt="Inheritance graph"/></div>
Chris@1 93 <map name="FixedTempoEstimator_inherit__map" id="FixedTempoEstimator_inherit__map">
Chris@1 94 <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="27,81,119,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="14,6,132,31"/></map>
Chris@1 95 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
Chris@1 96
Chris@1 97 <p><a href="classFixedTempoEstimator-members.html">List of all members.</a></p>
Chris@1 98 <table class="memberdecls">
Chris@1 99 <tr><td colspan="2"><h2><a name="nested-classes"></a>
Chris@1 100 Classes</h2></td></tr>
Chris@1 101 <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator_1_1D.html">D</a></td></tr>
Chris@1 102 <tr><td colspan="2"><h2><a name="pub-types"></a>
Chris@1 103 Public Types</h2></td></tr>
Chris@1 104 <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 105 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
Chris@1 106 }</td></tr>
Chris@1 107 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
Chris@1 108 &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 109 <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 110 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
Chris@1 111 <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 112 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
Chris@1 113 &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 114 <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 115 <tr><td colspan="2"><h2><a name="pub-methods"></a>
Chris@1 116 Public Member Functions</h2></td></tr>
Chris@1 117 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#a3967c189f054f864639837c2519bd64d">FixedTempoEstimator</a> (float inputSampleRate)</td></tr>
Chris@1 118 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#a0302c4bfdc163a3d34478cde93c96a53">~FixedTempoEstimator</a> ()</td></tr>
Chris@1 119 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#aa7500a4ffbc4653baaf5101defdb37f5">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
Chris@1 120 <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="#aa7500a4ffbc4653baaf5101defdb37f5"></a><br/></td></tr>
Chris@1 121 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#ac41708397255400c6682fee6c1b3d45f">reset</a> ()</td></tr>
Chris@1 122 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#ac41708397255400c6682fee6c1b3d45f"></a><br/></td></tr>
Chris@1 123 <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="classFixedTempoEstimator.html#a055689c9b41b0945e8d3cdbc3b8c3a2e">getInputDomain</a> () const </td></tr>
Chris@1 124 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a055689c9b41b0945e8d3cdbc3b8c3a2e"></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="classFixedTempoEstimator.html#ab818edcf1555177d10260e197e3a5e7a">getIdentifier</a> () const </td></tr>
Chris@1 126 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ab818edcf1555177d10260e197e3a5e7a"></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="classFixedTempoEstimator.html#af9eb6fa8a98aa66b55e64e1795f9405f">getName</a> () const </td></tr>
Chris@1 128 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#af9eb6fa8a98aa66b55e64e1795f9405f"></a><br/></td></tr>
Chris@1 129 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#a06b00853f00c2e78d490697fcd7d1920">getDescription</a> () const </td></tr>
Chris@1 130 <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="#a06b00853f00c2e78d490697fcd7d1920"></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="classFixedTempoEstimator.html#ae910d1b9250b11097fd6b51cd8285b68">getMaker</a> () const </td></tr>
Chris@1 132 <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="#ae910d1b9250b11097fd6b51cd8285b68"></a><br/></td></tr>
Chris@1 133 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#ad002fddb3735c2dd7e31e6a9def9949f">getPluginVersion</a> () const </td></tr>
Chris@1 134 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#ad002fddb3735c2dd7e31e6a9def9949f"></a><br/></td></tr>
Chris@1 135 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#a50c6b64530c84c0707ba3936c5022a48">getCopyright</a> () const </td></tr>
Chris@1 136 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#a50c6b64530c84c0707ba3936c5022a48"></a><br/></td></tr>
Chris@1 137 <tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#ad450bb7e7df559ae3d68dfbfb085676f">getPreferredStepSize</a> () const </td></tr>
Chris@1 138 <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="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#ad450bb7e7df559ae3d68dfbfb085676f"></a><br/></td></tr>
Chris@1 139 <tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#a68b8569b71504a0478caf990dbe30683">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="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c" title="Process a single block of input data.">process()</a> function). <a href="#a68b8569b71504a0478caf990dbe30683"></a><br/></td></tr>
Chris@1 141 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#ae157465a4e07d180bab05b5c3a4d8987">getParameterDescriptors</a> () const </td></tr>
Chris@1 142 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#ae157465a4e07d180bab05b5c3a4d8987"></a><br/></td></tr>
Chris@1 143 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#a2030b05fb1228b30ace16200780c9152">getParameter</a> (std::string id) const </td></tr>
Chris@1 144 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a2030b05fb1228b30ace16200780c9152"></a><br/></td></tr>
Chris@1 145 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75">setParameter</a> (std::string id, float value)</td></tr>
Chris@1 146 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a8a5a413025384cf451c64d2c2ce13a75"></a><br/></td></tr>
Chris@1 147 <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="classFixedTempoEstimator.html#a83121c205a723fe6297e2bf8870622a4">getOutputDescriptors</a> () const </td></tr>
Chris@1 148 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a83121c205a723fe6297e2bf8870622a4"></a><br/></td></tr>
Chris@1 149 <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="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
Chris@1 150 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a1cf76b0e55cf4ed3da095cffcdeaec3c"></a><br/></td></tr>
Chris@1 151 <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="classFixedTempoEstimator.html#a4965cf99be77fc4d1de51e11d83936b0">getRemainingFeatures</a> ()</td></tr>
Chris@1 152 <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="#a4965cf99be77fc4d1de51e11d83936b0"></a><br/></td></tr>
Chris@1 153 <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 154 <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 155 <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 156 <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 157 <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 158 <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 159 <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 160 <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 161 <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 162 <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 163 <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 164 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr>
Chris@1 165 <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 166 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr>
Chris@1 167 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
Chris@1 168 Protected Attributes</h2></td></tr>
Chris@1 169 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFixedTempoEstimator_1_1D.html">D</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFixedTempoEstimator.html#a5e1c9abaf33e9f48eb7d3b48f8af3308">m_d</a></td></tr>
Chris@1 170 <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 171 </table>
Chris@1 172 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 173 <div class="textblock"><p>Example plugin that estimates the tempo of a short fixed-tempo sample. </p>
Chris@1 174
Chris@1 175 <p>Definition at line <a class="el" href="FixedTempoEstimator_8h_source.html#l00046">46</a> of file <a class="el" href="FixedTempoEstimator_8h_source.html">FixedTempoEstimator.h</a>.</p>
Chris@1 176 </div><hr/><h2>Member Typedef Documentation</h2>
Chris@1 177 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="FixedTempoEstimator::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
Chris@1 178 <div class="memitem">
Chris@1 179 <div class="memproto">
Chris@1 180 <table class="memname">
Chris@1 181 <tr>
Chris@1 182 <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 183 </tr>
Chris@1 184 </table>
Chris@1 185 </div>
Chris@1 186 <div class="memdoc">
Chris@1 187
Chris@1 188 <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 189
Chris@1 190 </div>
Chris@1 191 </div>
Chris@1 192 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="FixedTempoEstimator::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
Chris@1 193 <div class="memitem">
Chris@1 194 <div class="memproto">
Chris@1 195 <table class="memname">
Chris@1 196 <tr>
Chris@1 197 <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 198 </tr>
Chris@1 199 </table>
Chris@1 200 </div>
Chris@1 201 <div class="memdoc">
Chris@1 202
Chris@1 203 <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 204
Chris@1 205 </div>
Chris@1 206 </div>
Chris@1 207 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="FixedTempoEstimator::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
Chris@1 208 <div class="memitem">
Chris@1 209 <div class="memproto">
Chris@1 210 <table class="memname">
Chris@1 211 <tr>
Chris@1 212 <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 213 </tr>
Chris@1 214 </table>
Chris@1 215 </div>
Chris@1 216 <div class="memdoc">
Chris@1 217
Chris@1 218 <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 219
Chris@1 220 </div>
Chris@1 221 </div>
Chris@1 222 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="FixedTempoEstimator::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
Chris@1 223 <div class="memitem">
Chris@1 224 <div class="memproto">
Chris@1 225 <table class="memname">
Chris@1 226 <tr>
Chris@1 227 <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 228 </tr>
Chris@1 229 </table>
Chris@1 230 </div>
Chris@1 231 <div class="memdoc">
Chris@1 232
Chris@1 233 <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 234
Chris@1 235 </div>
Chris@1 236 </div>
Chris@1 237 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="FixedTempoEstimator::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
Chris@1 238 <div class="memitem">
Chris@1 239 <div class="memproto">
Chris@1 240 <table class="memname">
Chris@1 241 <tr>
Chris@1 242 <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 243 </tr>
Chris@1 244 </table>
Chris@1 245 </div>
Chris@1 246 <div class="memdoc">
Chris@1 247
Chris@1 248 <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 249
Chris@1 250 </div>
Chris@1 251 </div>
Chris@1 252 <hr/><h2>Member Enumeration Documentation</h2>
Chris@1 253 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="FixedTempoEstimator::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
Chris@1 254 <div class="memitem">
Chris@1 255 <div class="memproto">
Chris@1 256 <table class="memname">
Chris@1 257 <tr>
Chris@1 258 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
Chris@1 259 </tr>
Chris@1 260 </table>
Chris@1 261 </div>
Chris@1 262 <div class="memdoc">
Chris@1 263 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
Chris@1 264 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
Chris@1 265 </td></tr>
Chris@1 266 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
Chris@1 267 </td></tr>
Chris@1 268 </table>
Chris@1 269 </dd>
Chris@1 270 </dl>
Chris@1 271
Chris@1 272 <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 273
Chris@1 274 </div>
Chris@1 275 </div>
Chris@1 276 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
Chris@1 277 <a class="anchor" id="a3967c189f054f864639837c2519bd64d"></a><!-- doxytag: member="FixedTempoEstimator::FixedTempoEstimator" ref="a3967c189f054f864639837c2519bd64d" args="(float inputSampleRate)" -->
Chris@1 278 <div class="memitem">
Chris@1 279 <div class="memproto">
Chris@1 280 <table class="memname">
Chris@1 281 <tr>
Chris@1 282 <td class="memname">FixedTempoEstimator::FixedTempoEstimator </td>
Chris@1 283 <td>(</td>
Chris@1 284 <td class="paramtype">float&#160;</td>
Chris@1 285 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
Chris@1 286 <td></td>
Chris@1 287 </tr>
Chris@1 288 </table>
Chris@1 289 </div>
Chris@1 290 <div class="memdoc">
Chris@1 291
Chris@1 292 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00617">617</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 293
Chris@1 294 </div>
Chris@1 295 </div>
Chris@1 296 <a class="anchor" id="a0302c4bfdc163a3d34478cde93c96a53"></a><!-- doxytag: member="FixedTempoEstimator::~FixedTempoEstimator" ref="a0302c4bfdc163a3d34478cde93c96a53" args="()" -->
Chris@1 297 <div class="memitem">
Chris@1 298 <div class="memproto">
Chris@1 299 <table class="memname">
Chris@1 300 <tr>
Chris@1 301 <td class="memname">FixedTempoEstimator::~FixedTempoEstimator </td>
Chris@1 302 <td>(</td>
Chris@1 303 <td class="paramname"></td><td>)</td>
Chris@1 304 <td><code> [virtual]</code></td>
Chris@1 305 </tr>
Chris@1 306 </table>
Chris@1 307 </div>
Chris@1 308 <div class="memdoc">
Chris@1 309
Chris@1 310 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00623">623</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 311
Chris@1 312 <p>References <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>.</p>
Chris@1 313
Chris@1 314 </div>
Chris@1 315 </div>
Chris@1 316 <hr/><h2>Member Function Documentation</h2>
Chris@1 317 <a class="anchor" id="aa7500a4ffbc4653baaf5101defdb37f5"></a><!-- doxytag: member="FixedTempoEstimator::initialise" ref="aa7500a4ffbc4653baaf5101defdb37f5" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
Chris@1 318 <div class="memitem">
Chris@1 319 <div class="memproto">
Chris@1 320 <table class="memname">
Chris@1 321 <tr>
Chris@1 322 <td class="memname">bool FixedTempoEstimator::initialise </td>
Chris@1 323 <td>(</td>
Chris@1 324 <td class="paramtype">size_t&#160;</td>
Chris@1 325 <td class="paramname"><em>inputChannels</em>, </td>
Chris@1 326 </tr>
Chris@1 327 <tr>
Chris@1 328 <td class="paramkey"></td>
Chris@1 329 <td></td>
Chris@1 330 <td class="paramtype">size_t&#160;</td>
Chris@1 331 <td class="paramname"><em>stepSize</em>, </td>
Chris@1 332 </tr>
Chris@1 333 <tr>
Chris@1 334 <td class="paramkey"></td>
Chris@1 335 <td></td>
Chris@1 336 <td class="paramtype">size_t&#160;</td>
Chris@1 337 <td class="paramname"><em>blockSize</em>&#160;</td>
Chris@1 338 </tr>
Chris@1 339 <tr>
Chris@1 340 <td></td>
Chris@1 341 <td>)</td>
Chris@1 342 <td></td><td><code> [virtual]</code></td>
Chris@1 343 </tr>
Chris@1 344 </table>
Chris@1 345 </div>
Chris@1 346 <div class="memdoc">
Chris@1 347
Chris@1 348 <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 349 <p>The input sample rate should have been already specified at construction time.</p>
Chris@1 350 <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 351
Chris@1 352 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
Chris@1 353
Chris@1 354 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">677</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 355
Chris@1 356 <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="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, and <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>.</p>
Chris@1 357
Chris@1 358 </div>
Chris@1 359 </div>
Chris@1 360 <a class="anchor" id="ac41708397255400c6682fee6c1b3d45f"></a><!-- doxytag: member="FixedTempoEstimator::reset" ref="ac41708397255400c6682fee6c1b3d45f" args="()" -->
Chris@1 361 <div class="memitem">
Chris@1 362 <div class="memproto">
Chris@1 363 <table class="memname">
Chris@1 364 <tr>
Chris@1 365 <td class="memname">void FixedTempoEstimator::reset </td>
Chris@1 366 <td>(</td>
Chris@1 367 <td class="paramname"></td><td>)</td>
Chris@1 368 <td><code> [virtual]</code></td>
Chris@1 369 </tr>
Chris@1 370 </table>
Chris@1 371 </div>
Chris@1 372 <div class="memdoc">
Chris@1 373
Chris@1 374 <p>Reset the plugin after use, to prepare it for another clean run. </p>
Chris@1 375 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
Chris@1 376
Chris@1 377 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
Chris@1 378
Chris@1 379 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00686">686</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 380
Chris@1 381 <p>References <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00276">FixedTempoEstimator::D::reset()</a>.</p>
Chris@1 382
Chris@1 383 </div>
Chris@1 384 </div>
Chris@1 385 <a class="anchor" id="a055689c9b41b0945e8d3cdbc3b8c3a2e"></a><!-- doxytag: member="FixedTempoEstimator::getInputDomain" ref="a055689c9b41b0945e8d3cdbc3b8c3a2e" args="() const " -->
Chris@1 386 <div class="memitem">
Chris@1 387 <div class="memproto">
Chris@1 388 <table class="memname">
Chris@1 389 <tr>
Chris@1 390 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> FixedTempoEstimator::getInputDomain </td>
Chris@1 391 <td>(</td>
Chris@1 392 <td class="paramname"></td><td>)</td>
Chris@1 393 <td> const<code> [inline, virtual]</code></td>
Chris@1 394 </tr>
Chris@1 395 </table>
Chris@1 396 </div>
Chris@1 397 <div class="memdoc">
Chris@1 398
Chris@1 399 <p>Get the plugin's required input domain. </p>
Chris@1 400 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c" 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 401 <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="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c" 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 402
Chris@1 403 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
Chris@1 404
Chris@1 405 <p>Definition at line <a class="el" href="FixedTempoEstimator_8h_source.html#l00055">55</a> of file <a class="el" href="FixedTempoEstimator_8h_source.html">FixedTempoEstimator.h</a>.</p>
Chris@1 406
Chris@1 407 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::FrequencyDomain</a>.</p>
Chris@1 408
Chris@1 409 </div>
Chris@1 410 </div>
Chris@1 411 <a class="anchor" id="ab818edcf1555177d10260e197e3a5e7a"></a><!-- doxytag: member="FixedTempoEstimator::getIdentifier" ref="ab818edcf1555177d10260e197e3a5e7a" args="() const " -->
Chris@1 412 <div class="memitem">
Chris@1 413 <div class="memproto">
Chris@1 414 <table class="memname">
Chris@1 415 <tr>
Chris@1 416 <td class="memname">string FixedTempoEstimator::getIdentifier </td>
Chris@1 417 <td>(</td>
Chris@1 418 <td class="paramname"></td><td>)</td>
Chris@1 419 <td> const<code> [virtual]</code></td>
Chris@1 420 </tr>
Chris@1 421 </table>
Chris@1 422 </div>
Chris@1 423 <div class="memdoc">
Chris@1 424
Chris@1 425 <p>Get the computer-usable name of the plugin. </p>
Chris@1 426 <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 427 <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 428 <p>Example: "zero_crossings" </p>
Chris@1 429
Chris@1 430 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
Chris@1 431
Chris@1 432 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00629">629</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 433
Chris@1 434 </div>
Chris@1 435 </div>
Chris@1 436 <a class="anchor" id="af9eb6fa8a98aa66b55e64e1795f9405f"></a><!-- doxytag: member="FixedTempoEstimator::getName" ref="af9eb6fa8a98aa66b55e64e1795f9405f" args="() const " -->
Chris@1 437 <div class="memitem">
Chris@1 438 <div class="memproto">
Chris@1 439 <table class="memname">
Chris@1 440 <tr>
Chris@1 441 <td class="memname">string FixedTempoEstimator::getName </td>
Chris@1 442 <td>(</td>
Chris@1 443 <td class="paramname"></td><td>)</td>
Chris@1 444 <td> const<code> [virtual]</code></td>
Chris@1 445 </tr>
Chris@1 446 </table>
Chris@1 447 </div>
Chris@1 448 <div class="memdoc">
Chris@1 449
Chris@1 450 <p>Get a human-readable name or title of the plugin. </p>
Chris@1 451 <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 452 <p>Example: "Zero Crossings" </p>
Chris@1 453
Chris@1 454 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
Chris@1 455
Chris@1 456 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00635">635</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 457
Chris@1 458 </div>
Chris@1 459 </div>
Chris@1 460 <a class="anchor" id="a06b00853f00c2e78d490697fcd7d1920"></a><!-- doxytag: member="FixedTempoEstimator::getDescription" ref="a06b00853f00c2e78d490697fcd7d1920" args="() const " -->
Chris@1 461 <div class="memitem">
Chris@1 462 <div class="memproto">
Chris@1 463 <table class="memname">
Chris@1 464 <tr>
Chris@1 465 <td class="memname">string FixedTempoEstimator::getDescription </td>
Chris@1 466 <td>(</td>
Chris@1 467 <td class="paramname"></td><td>)</td>
Chris@1 468 <td> const<code> [virtual]</code></td>
Chris@1 469 </tr>
Chris@1 470 </table>
Chris@1 471 </div>
Chris@1 472 <div class="memdoc">
Chris@1 473
Chris@1 474 <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 475 <p>May be empty if the name has said it all already.</p>
Chris@1 476 <p>Example: "Detect and count zero crossing points" </p>
Chris@1 477
Chris@1 478 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
Chris@1 479
Chris@1 480 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00641">641</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 481
Chris@1 482 </div>
Chris@1 483 </div>
Chris@1 484 <a class="anchor" id="ae910d1b9250b11097fd6b51cd8285b68"></a><!-- doxytag: member="FixedTempoEstimator::getMaker" ref="ae910d1b9250b11097fd6b51cd8285b68" args="() const " -->
Chris@1 485 <div class="memitem">
Chris@1 486 <div class="memproto">
Chris@1 487 <table class="memname">
Chris@1 488 <tr>
Chris@1 489 <td class="memname">string FixedTempoEstimator::getMaker </td>
Chris@1 490 <td>(</td>
Chris@1 491 <td class="paramname"></td><td>)</td>
Chris@1 492 <td> const<code> [virtual]</code></td>
Chris@1 493 </tr>
Chris@1 494 </table>
Chris@1 495 </div>
Chris@1 496 <div class="memdoc">
Chris@1 497
Chris@1 498 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
Chris@1 499 <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 500
Chris@1 501 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
Chris@1 502
Chris@1 503 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00647">647</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 504
Chris@1 505 </div>
Chris@1 506 </div>
Chris@1 507 <a class="anchor" id="ad002fddb3735c2dd7e31e6a9def9949f"></a><!-- doxytag: member="FixedTempoEstimator::getPluginVersion" ref="ad002fddb3735c2dd7e31e6a9def9949f" args="() const " -->
Chris@1 508 <div class="memitem">
Chris@1 509 <div class="memproto">
Chris@1 510 <table class="memname">
Chris@1 511 <tr>
Chris@1 512 <td class="memname">int FixedTempoEstimator::getPluginVersion </td>
Chris@1 513 <td>(</td>
Chris@1 514 <td class="paramname"></td><td>)</td>
Chris@1 515 <td> const<code> [virtual]</code></td>
Chris@1 516 </tr>
Chris@1 517 </table>
Chris@1 518 </div>
Chris@1 519 <div class="memdoc">
Chris@1 520
Chris@1 521 <p>Get the version number of the plugin. </p>
Chris@1 522
Chris@1 523 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
Chris@1 524
Chris@1 525 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00653">653</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 526
Chris@1 527 </div>
Chris@1 528 </div>
Chris@1 529 <a class="anchor" id="a50c6b64530c84c0707ba3936c5022a48"></a><!-- doxytag: member="FixedTempoEstimator::getCopyright" ref="a50c6b64530c84c0707ba3936c5022a48" args="() const " -->
Chris@1 530 <div class="memitem">
Chris@1 531 <div class="memproto">
Chris@1 532 <table class="memname">
Chris@1 533 <tr>
Chris@1 534 <td class="memname">string FixedTempoEstimator::getCopyright </td>
Chris@1 535 <td>(</td>
Chris@1 536 <td class="paramname"></td><td>)</td>
Chris@1 537 <td> const<code> [virtual]</code></td>
Chris@1 538 </tr>
Chris@1 539 </table>
Chris@1 540 </div>
Chris@1 541 <div class="memdoc">
Chris@1 542
Chris@1 543 <p>Get the copyright statement or licensing summary for the plugin. </p>
Chris@1 544 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
Chris@1 545
Chris@1 546 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
Chris@1 547
Chris@1 548 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00659">659</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 549
Chris@1 550 </div>
Chris@1 551 </div>
Chris@1 552 <a class="anchor" id="ad450bb7e7df559ae3d68dfbfb085676f"></a><!-- doxytag: member="FixedTempoEstimator::getPreferredStepSize" ref="ad450bb7e7df559ae3d68dfbfb085676f" args="() const " -->
Chris@1 553 <div class="memitem">
Chris@1 554 <div class="memproto">
Chris@1 555 <table class="memname">
Chris@1 556 <tr>
Chris@1 557 <td class="memname">size_t FixedTempoEstimator::getPreferredStepSize </td>
Chris@1 558 <td>(</td>
Chris@1 559 <td class="paramname"></td><td>)</td>
Chris@1 560 <td> const<code> [virtual]</code></td>
Chris@1 561 </tr>
Chris@1 562 </table>
Chris@1 563 </div>
Chris@1 564 <div class="memdoc">
Chris@1 565
Chris@1 566 <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="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c" title="Process a single block of input data.">process()</a> function) for the plugin. </p>
Chris@1 567 <p>This should be called before <a class="el" href="classFixedTempoEstimator.html#aa7500a4ffbc4653baaf5101defdb37f5" 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 568 <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="classFixedTempoEstimator.html#aa7500a4ffbc4653baaf5101defdb37f5" 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 569
Chris@1 570 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
Chris@1 571
Chris@1 572 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00665">665</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 573
Chris@1 574 <p>References <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00057">FixedTempoEstimator::D::getPreferredStepSize()</a>, and <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>.</p>
Chris@1 575
Chris@1 576 </div>
Chris@1 577 </div>
Chris@1 578 <a class="anchor" id="a68b8569b71504a0478caf990dbe30683"></a><!-- doxytag: member="FixedTempoEstimator::getPreferredBlockSize" ref="a68b8569b71504a0478caf990dbe30683" args="() const " -->
Chris@1 579 <div class="memitem">
Chris@1 580 <div class="memproto">
Chris@1 581 <table class="memname">
Chris@1 582 <tr>
Chris@1 583 <td class="memname">size_t FixedTempoEstimator::getPreferredBlockSize </td>
Chris@1 584 <td>(</td>
Chris@1 585 <td class="paramname"></td><td>)</td>
Chris@1 586 <td> const<code> [virtual]</code></td>
Chris@1 587 </tr>
Chris@1 588 </table>
Chris@1 589 </div>
Chris@1 590 <div class="memdoc">
Chris@1 591
Chris@1 592 <p>Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c" title="Process a single block of input data.">process()</a> function). </p>
Chris@1 593 <p>This should be called before <a class="el" href="classFixedTempoEstimator.html#aa7500a4ffbc4653baaf5101defdb37f5" 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 594 <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="classFixedTempoEstimator.html#aa7500a4ffbc4653baaf5101defdb37f5" 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 595
Chris@1 596 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
Chris@1 597
Chris@1 598 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00671">671</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 599
Chris@1 600 <p>References <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00058">FixedTempoEstimator::D::getPreferredBlockSize()</a>, and <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>.</p>
Chris@1 601
Chris@1 602 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
Chris@1 603
Chris@1 604 </div>
Chris@1 605 </div>
Chris@1 606 <a class="anchor" id="ae157465a4e07d180bab05b5c3a4d8987"></a><!-- doxytag: member="FixedTempoEstimator::getParameterDescriptors" ref="ae157465a4e07d180bab05b5c3a4d8987" args="() const " -->
Chris@1 607 <div class="memitem">
Chris@1 608 <div class="memproto">
Chris@1 609 <table class="memname">
Chris@1 610 <tr>
Chris@1 611 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">FixedTempoEstimator::ParameterList</a> FixedTempoEstimator::getParameterDescriptors </td>
Chris@1 612 <td>(</td>
Chris@1 613 <td class="paramname"></td><td>)</td>
Chris@1 614 <td> const<code> [virtual]</code></td>
Chris@1 615 </tr>
Chris@1 616 </table>
Chris@1 617 </div>
Chris@1 618 <div class="memdoc">
Chris@1 619
Chris@1 620 <p>Get the controllable parameters of this plugin. </p>
Chris@1 621
Chris@1 622 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
Chris@1 623
Chris@1 624 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00692">692</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 625
Chris@1 626 <p>References <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>.</p>
Chris@1 627
Chris@1 628 </div>
Chris@1 629 </div>
Chris@1 630 <a class="anchor" id="a2030b05fb1228b30ace16200780c9152"></a><!-- doxytag: member="FixedTempoEstimator::getParameter" ref="a2030b05fb1228b30ace16200780c9152" args="(std::string id) 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">float FixedTempoEstimator::getParameter </td>
Chris@1 636 <td>(</td>
Chris@1 637 <td class="paramtype">std::string&#160;</td>
Chris@1 638 <td class="paramname"></td><td>)</td>
Chris@1 639 <td> const<code> [virtual]</code></td>
Chris@1 640 </tr>
Chris@1 641 </table>
Chris@1 642 </div>
Chris@1 643 <div class="memdoc">
Chris@1 644
Chris@1 645 <p>Get the value of a named parameter. </p>
Chris@1 646 <p>The argument is the identifier field from that parameter's descriptor. </p>
Chris@1 647
Chris@1 648 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
Chris@1 649
Chris@1 650 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00698">698</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 651
Chris@1 652 <p>References <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00159">FixedTempoEstimator::D::getParameter()</a>, and <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>.</p>
Chris@1 653
Chris@1 654 </div>
Chris@1 655 </div>
Chris@1 656 <a class="anchor" id="a8a5a413025384cf451c64d2c2ce13a75"></a><!-- doxytag: member="FixedTempoEstimator::setParameter" ref="a8a5a413025384cf451c64d2c2ce13a75" args="(std::string id, float value)" -->
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">void FixedTempoEstimator::setParameter </td>
Chris@1 662 <td>(</td>
Chris@1 663 <td class="paramtype">std::string&#160;</td>
Chris@1 664 <td class="paramname">, </td>
Chris@1 665 </tr>
Chris@1 666 <tr>
Chris@1 667 <td class="paramkey"></td>
Chris@1 668 <td></td>
Chris@1 669 <td class="paramtype">float&#160;</td>
Chris@1 670 <td class="paramname">&#160;</td>
Chris@1 671 </tr>
Chris@1 672 <tr>
Chris@1 673 <td></td>
Chris@1 674 <td>)</td>
Chris@1 675 <td></td><td><code> [virtual]</code></td>
Chris@1 676 </tr>
Chris@1 677 </table>
Chris@1 678 </div>
Chris@1 679 <div class="memdoc">
Chris@1 680
Chris@1 681 <p>Set a named parameter. </p>
Chris@1 682 <p>The first argument is the identifier field from that parameter's descriptor. </p>
Chris@1 683
Chris@1 684 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
Chris@1 685
Chris@1 686 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00704">704</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 687
Chris@1 688 <p>References <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00172">FixedTempoEstimator::D::setParameter()</a>.</p>
Chris@1 689
Chris@1 690 </div>
Chris@1 691 </div>
Chris@1 692 <a class="anchor" id="a83121c205a723fe6297e2bf8870622a4"></a><!-- doxytag: member="FixedTempoEstimator::getOutputDescriptors" ref="a83121c205a723fe6297e2bf8870622a4" args="() const " -->
Chris@1 693 <div class="memitem">
Chris@1 694 <div class="memproto">
Chris@1 695 <table class="memname">
Chris@1 696 <tr>
Chris@1 697 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">FixedTempoEstimator::OutputList</a> FixedTempoEstimator::getOutputDescriptors </td>
Chris@1 698 <td>(</td>
Chris@1 699 <td class="paramname"></td><td>)</td>
Chris@1 700 <td> const<code> [virtual]</code></td>
Chris@1 701 </tr>
Chris@1 702 </table>
Chris@1 703 </div>
Chris@1 704 <div class="memdoc">
Chris@1 705
Chris@1 706 <p>Get the outputs of this plugin. </p>
Chris@1 707 <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="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c" title="Process a single block of input data.">process()</a> call. </p>
Chris@1 708
Chris@1 709 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
Chris@1 710
Chris@1 711 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00710">710</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 712
Chris@1 713 <p>References <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>.</p>
Chris@1 714
Chris@1 715 </div>
Chris@1 716 </div>
Chris@1 717 <a class="anchor" id="a1cf76b0e55cf4ed3da095cffcdeaec3c"></a><!-- doxytag: member="FixedTempoEstimator::process" ref="a1cf76b0e55cf4ed3da095cffcdeaec3c" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
Chris@1 718 <div class="memitem">
Chris@1 719 <div class="memproto">
Chris@1 720 <table class="memname">
Chris@1 721 <tr>
Chris@1 722 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FixedTempoEstimator::FeatureSet</a> FixedTempoEstimator::process </td>
Chris@1 723 <td>(</td>
Chris@1 724 <td class="paramtype">const float *const *&#160;</td>
Chris@1 725 <td class="paramname"><em>inputBuffers</em>, </td>
Chris@1 726 </tr>
Chris@1 727 <tr>
Chris@1 728 <td class="paramkey"></td>
Chris@1 729 <td></td>
Chris@1 730 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
Chris@1 731 <td class="paramname"><em>timestamp</em>&#160;</td>
Chris@1 732 </tr>
Chris@1 733 <tr>
Chris@1 734 <td></td>
Chris@1 735 <td>)</td>
Chris@1 736 <td></td><td><code> [virtual]</code></td>
Chris@1 737 </tr>
Chris@1 738 </table>
Chris@1 739 </div>
Chris@1 740 <div class="memdoc">
Chris@1 741
Chris@1 742 <p>Process a single block of input data. </p>
Chris@1 743 <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 744 <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 745 <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 746
Chris@1 747 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
Chris@1 748
Chris@1 749 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00716">716</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 750
Chris@1 751 <p>References <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00303">FixedTempoEstimator::D::process()</a>.</p>
Chris@1 752
Chris@1 753 </div>
Chris@1 754 </div>
Chris@1 755 <a class="anchor" id="a4965cf99be77fc4d1de51e11d83936b0"></a><!-- doxytag: member="FixedTempoEstimator::getRemainingFeatures" ref="a4965cf99be77fc4d1de51e11d83936b0" args="()" -->
Chris@1 756 <div class="memitem">
Chris@1 757 <div class="memproto">
Chris@1 758 <table class="memname">
Chris@1 759 <tr>
Chris@1 760 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FixedTempoEstimator::FeatureSet</a> FixedTempoEstimator::getRemainingFeatures </td>
Chris@1 761 <td>(</td>
Chris@1 762 <td class="paramname"></td><td>)</td>
Chris@1 763 <td><code> [virtual]</code></td>
Chris@1 764 </tr>
Chris@1 765 </table>
Chris@1 766 </div>
Chris@1 767 <div class="memdoc">
Chris@1 768
Chris@1 769 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
Chris@1 770
Chris@1 771 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
Chris@1 772
Chris@1 773 <p>Definition at line <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00722">722</a> of file <a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a>.</p>
Chris@1 774
Chris@1 775 <p>References <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00352">FixedTempoEstimator::D::getRemainingFeatures()</a>, and <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">m_d</a>.</p>
Chris@1 776
Chris@1 777 </div>
Chris@1 778 </div>
Chris@1 779 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="FixedTempoEstimator::getMinChannelCount" ref="a267b42e866df3cf0d190893e8096f525" args="() const " -->
Chris@1 780 <div class="memitem">
Chris@1 781 <div class="memproto">
Chris@1 782 <table class="memname">
Chris@1 783 <tr>
Chris@1 784 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
Chris@1 785 <td>(</td>
Chris@1 786 <td class="paramname"></td><td>)</td>
Chris@1 787 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 788 </tr>
Chris@1 789 </table>
Chris@1 790 </div>
Chris@1 791 <div class="memdoc">
Chris@1 792
Chris@1 793 <p>Get the minimum supported number of input channels. </p>
Chris@1 794
Chris@1 795 <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 796
Chris@1 797 <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 798
Chris@1 799 <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">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">SpectralCentroid::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 800
Chris@1 801 </div>
Chris@1 802 </div>
Chris@1 803 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="FixedTempoEstimator::getMaxChannelCount" ref="a2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
Chris@1 804 <div class="memitem">
Chris@1 805 <div class="memproto">
Chris@1 806 <table class="memname">
Chris@1 807 <tr>
Chris@1 808 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
Chris@1 809 <td>(</td>
Chris@1 810 <td class="paramname"></td><td>)</td>
Chris@1 811 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 812 </tr>
Chris@1 813 </table>
Chris@1 814 </div>
Chris@1 815 <div class="memdoc">
Chris@1 816
Chris@1 817 <p>Get the maximum supported number of input channels. </p>
Chris@1 818
Chris@1 819 <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 820
Chris@1 821 <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 822
Chris@1 823 <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">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">SpectralCentroid::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 824
Chris@1 825 </div>
Chris@1 826 </div>
Chris@1 827 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="FixedTempoEstimator::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
Chris@1 828 <div class="memitem">
Chris@1 829 <div class="memproto">
Chris@1 830 <table class="memname">
Chris@1 831 <tr>
Chris@1 832 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
Chris@1 833 <td>(</td>
Chris@1 834 <td class="paramname"></td><td>)</td>
Chris@1 835 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 836 </tr>
Chris@1 837 </table>
Chris@1 838 </div>
Chris@1 839 <div class="memdoc">
Chris@1 840
Chris@1 841 <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 842 <p>Do not reimplement this function in your subclass. </p>
Chris@1 843
Chris@1 844 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
Chris@1 845
Chris@1 846 <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 847
Chris@1 848 </div>
Chris@1 849 </div>
Chris@1 850 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="FixedTempoEstimator::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
Chris@1 851 <div class="memitem">
Chris@1 852 <div class="memproto">
Chris@1 853 <table class="memname">
Chris@1 854 <tr>
Chris@1 855 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
Chris@1 856 <td>(</td>
Chris@1 857 <td class="paramname"></td><td>)</td>
Chris@1 858 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 859 </tr>
Chris@1 860 </table>
Chris@1 861 </div>
Chris@1 862 <div class="memdoc">
Chris@1 863
Chris@1 864 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
Chris@1 865
Chris@1 866 <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 867
Chris@1 868 <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 869
Chris@1 870 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
Chris@1 871
Chris@1 872 </div>
Chris@1 873 </div>
Chris@1 874 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="FixedTempoEstimator::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
Chris@1 875 <div class="memitem">
Chris@1 876 <div class="memproto">
Chris@1 877 <table class="memname">
Chris@1 878 <tr>
Chris@1 879 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
Chris@1 880 <td>(</td>
Chris@1 881 <td class="paramname"></td><td>)</td>
Chris@1 882 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 883 </tr>
Chris@1 884 </table>
Chris@1 885 </div>
Chris@1 886 <div class="memdoc">
Chris@1 887
Chris@1 888 <p>Get the program settings available in this plugin. </p>
Chris@1 889 <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 890 <p>The programs must have unique names. </p>
Chris@1 891
Chris@1 892 <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 893
Chris@1 894 <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 895
Chris@1 896 </div>
Chris@1 897 </div>
Chris@1 898 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="FixedTempoEstimator::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
Chris@1 899 <div class="memitem">
Chris@1 900 <div class="memproto">
Chris@1 901 <table class="memname">
Chris@1 902 <tr>
Chris@1 903 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
Chris@1 904 <td>(</td>
Chris@1 905 <td class="paramname"></td><td>)</td>
Chris@1 906 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 907 </tr>
Chris@1 908 </table>
Chris@1 909 </div>
Chris@1 910 <div class="memdoc">
Chris@1 911
Chris@1 912 <p>Get the current program. </p>
Chris@1 913
Chris@1 914 <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 915
Chris@1 916 <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 917
Chris@1 918 </div>
Chris@1 919 </div>
Chris@1 920 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="FixedTempoEstimator::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" -->
Chris@1 921 <div class="memitem">
Chris@1 922 <div class="memproto">
Chris@1 923 <table class="memname">
Chris@1 924 <tr>
Chris@1 925 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
Chris@1 926 <td>(</td>
Chris@1 927 <td class="paramtype">std::string&#160;</td>
Chris@1 928 <td class="paramname"></td><td>)</td>
Chris@1 929 <td><code> [inline, virtual, inherited]</code></td>
Chris@1 930 </tr>
Chris@1 931 </table>
Chris@1 932 </div>
Chris@1 933 <div class="memdoc">
Chris@1 934
Chris@1 935 <p>Select a program. </p>
Chris@1 936 <p>(If the given program name is not one of the available programs, do nothing.) </p>
Chris@1 937
Chris@1 938 <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 939
Chris@1 940 <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 941
Chris@1 942 </div>
Chris@1 943 </div>
Chris@1 944 <hr/><h2>Member Data Documentation</h2>
Chris@1 945 <a class="anchor" id="a5e1c9abaf33e9f48eb7d3b48f8af3308"></a><!-- doxytag: member="FixedTempoEstimator::m_d" ref="a5e1c9abaf33e9f48eb7d3b48f8af3308" args="" -->
Chris@1 946 <div class="memitem">
Chris@1 947 <div class="memproto">
Chris@1 948 <table class="memname">
Chris@1 949 <tr>
Chris@1 950 <td class="memname"><a class="el" href="classFixedTempoEstimator_1_1D.html">D</a>* <a class="el" href="classFixedTempoEstimator.html#a5e1c9abaf33e9f48eb7d3b48f8af3308">FixedTempoEstimator::m_d</a><code> [protected]</code></td>
Chris@1 951 </tr>
Chris@1 952 </table>
Chris@1 953 </div>
Chris@1 954 <div class="memdoc">
Chris@1 955
Chris@1 956 <p>Definition at line <a class="el" href="FixedTempoEstimator_8h_source.html#l00079">79</a> of file <a class="el" href="FixedTempoEstimator_8h_source.html">FixedTempoEstimator.h</a>.</p>
Chris@1 957
Chris@1 958 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00710">getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00698">getParameter()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00692">getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00671">getPreferredBlockSize()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00665">getPreferredStepSize()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00722">getRemainingFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00716">process()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00686">reset()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00704">setParameter()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00623">~FixedTempoEstimator()</a>.</p>
Chris@1 959
Chris@1 960 </div>
Chris@1 961 </div>
Chris@1 962 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="FixedTempoEstimator::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
Chris@1 963 <div class="memitem">
Chris@1 964 <div class="memproto">
Chris@1 965 <table class="memname">
Chris@1 966 <tr>
Chris@1 967 <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 968 </tr>
Chris@1 969 </table>
Chris@1 970 </div>
Chris@1 971 <div class="memdoc">
Chris@1 972
Chris@1 973 <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 974
Chris@1 975 <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="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::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 976
Chris@1 977 </div>
Chris@1 978 </div>
Chris@1 979 <hr/>The documentation for this class was generated from the following files:<ul>
Chris@1 980 <li><a class="el" href="FixedTempoEstimator_8h_source.html">FixedTempoEstimator.h</a></li>
Chris@1 981 <li><a class="el" href="FixedTempoEstimator_8cpp_source.html">FixedTempoEstimator.cpp</a></li>
Chris@1 982 </ul>
Chris@1 983 </div>
Chris@1 984 </div>
Chris@1 985 <div id="nav-path" class="navpath">
Chris@1 986 <ul>
Chris@1 987 <li class="navelem"><a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a> </li>
Chris@1 988
Chris@1 989 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
Chris@1 990 <a href="http://www.doxygen.org/index.html">
Chris@1 991 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 992 </ul>
Chris@1 993 </div>
Chris@1 994
Chris@1 995
Chris@1 996 </body>
Chris@1 997 </html>