Mercurial > hg > vamp-docs

annotate code-docs/classFixedTempoEstimator.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

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