Mercurial > hg > vamp-website

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

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