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