Mercurial > hg > vamp-docs

comparison code-docs/classAmplitudeFollower.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
comparison
equal deleted inserted replaced
0:895ae8fffdb7 1:3c430ef1ed66
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>VampPluginSDK: AmplitudeFollower Class Reference</title>
6
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="resize.js"></script>
12 <script type="text/javascript" src="navtree.js"></script>
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 &#160;<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&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
49 <li><a href="files.html"><span>Files</span></a></li>
50 <li><a href="dirs.html"><span>Directories</span></a></li>
51 </ul>
52 </div>
53 <div id="navrow2" class="tabs2">
54 <ul class="tablist">
55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
58 </ul>
59 </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('classAmplitudeFollower.html','');
72 </script>
73 <div id="doc-content">
74 <div class="header">
75 <div class="summary">
76 <a href="#pub-types">Public Types</a> &#124;
77 <a href="#pub-methods">Public Member Functions</a> &#124;
78 <a href="#pro-attribs">Protected Attributes</a> </div>
79 <div class="headertitle">
80 <div class="title">AmplitudeFollower Class Reference</div> </div>
81 </div>
82 <div class="contents">
83 <!-- doxytag: class="AmplitudeFollower" --><!-- doxytag: inherits="Vamp::Plugin" -->
84 <p>Example plugin implementing the SuperCollider amplitude follower function.
85 <a href="classAmplitudeFollower.html#details">More...</a></p>
86
87 <p><code>#include &lt;<a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>&gt;</code></p>
88 <div class="dynheader">
89 Inheritance diagram for AmplitudeFollower:</div>
90 <div class="dyncontent">
91 <div class="center"><img src="classAmplitudeFollower__inherit__graph.png" border="0" usemap="#AmplitudeFollower_inherit__map" alt="Inheritance graph"/></div>
92 <map name="AmplitudeFollower_inherit__map" id="AmplitudeFollower_inherit__map">
93 <area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="21,81,112,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="7,6,125,31"/></map>
94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
95
96 <p><a href="classAmplitudeFollower-members.html">List of all members.</a></p>
97 <table class="memberdecls">
98 <tr><td colspan="2"><h2><a name="pub-types"></a>
99 Public Types</h2></td></tr>
100 <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
101 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
102 }</td></tr>
103 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
104 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
105 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
106 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
107 <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
108 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
109 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
110 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
111 <tr><td colspan="2"><h2><a name="pub-methods"></a>
112 Public Member Functions</h2></td></tr>
113 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a29eaeffc353da2614ae508abcd0ab63f">AmplitudeFollower</a> (float inputSampleRate)</td></tr>
114 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. <a href="#a29eaeffc353da2614ae508abcd0ab63f"></a><br/></td></tr>
115 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aa78f98539ad3a1b08691a99b32035b2d">~AmplitudeFollower</a> ()</td></tr>
116 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
117 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#aeb727e44ee8ad1aceb90964d20f8d90d"></a><br/></td></tr>
118 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#acebd835e80e84669df078fbd7591d8f7">reset</a> ()</td></tr>
119 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#acebd835e80e84669df078fbd7591d8f7"></a><br/></td></tr>
120 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#afc07a389b5f922b944b0350fd232d2eb">getInputDomain</a> () const </td></tr>
121 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#afc07a389b5f922b944b0350fd232d2eb"></a><br/></td></tr>
122 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#afe7576af95c8fcc7f5bad42eec9f9f29">getIdentifier</a> () const </td></tr>
123 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#afe7576af95c8fcc7f5bad42eec9f9f29"></a><br/></td></tr>
124 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a7cfed00bc9d96ba6c709b69ab6a40594">getName</a> () const </td></tr>
125 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a7cfed00bc9d96ba6c709b69ab6a40594"></a><br/></td></tr>
126 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a6f0f2fea1fdb4b51e688edfe859d5062">getDescription</a> () const </td></tr>
127 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#a6f0f2fea1fdb4b51e688edfe859d5062"></a><br/></td></tr>
128 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a44fc43838f203f58bc2ce6e3cb2b03dd">getMaker</a> () const </td></tr>
129 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a44fc43838f203f58bc2ce6e3cb2b03dd"></a><br/></td></tr>
130 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a8a5d7a834eb996d517c51f84b2a72250">getPluginVersion</a> () const </td></tr>
131 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a8a5d7a834eb996d517c51f84b2a72250"></a><br/></td></tr>
132 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a0c197fc90f30d91cb4403115c83c9134">getCopyright</a> () const </td></tr>
133 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#a0c197fc90f30d91cb4403115c83c9134"></a><br/></td></tr>
134 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a043e3c3db77d76267cd8069e1485bf26">getOutputDescriptors</a> () const </td></tr>
135 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a043e3c3db77d76267cd8069e1485bf26"></a><br/></td></tr>
136 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">getParameterDescriptors</a> () const </td></tr>
137 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9df01323a09e117bc12354ebe9244edf"></a><br/></td></tr>
138 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">getParameter</a> (std::string paramid) const </td></tr>
139 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#ab278c4b6f2ca23248dc94ad775273f39"></a><br/></td></tr>
140 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">setParameter</a> (std::string paramid, float newval)</td></tr>
141 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#ae1fc37ece4d20e40f3066a3361a99340"></a><br/></td></tr>
142 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
143 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a48d0f95cac31ffd190cff89b50a2a5bd"></a><br/></td></tr>
144 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a368606f643b88e0df0823d85e36f030c">getRemainingFeatures</a> ()</td></tr>
145 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#a368606f643b88e0df0823d85e36f030c"></a><br/></td></tr>
146 <tr><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr>
147 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). <a href="#aa529adf83f87a603954eb31407602aac"></a><br/></td></tr>
148 <tr><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr>
149 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a514c716c22f81c055f19b56c3f882567"></a><br/></td></tr>
150 <tr><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr>
151 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a267b42e866df3cf0d190893e8096f525"></a><br/></td></tr>
152 <tr><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr>
153 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br/></td></tr>
154 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
155 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr>
156 <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr>
157 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr>
158 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr>
159 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr>
160 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr>
161 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr>
162 <tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
163 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr>
164 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
165 Protected Attributes</h2></td></tr>
166 <tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">m_stepSize</a></td></tr>
167 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">m_previn</a></td></tr>
168 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a></td></tr>
169 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a></td></tr>
170 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
171 </table>
172 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
173 <div class="textblock"><p>Example plugin implementing the SuperCollider amplitude follower function. </p>
174
175 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00047">47</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
176 </div><hr/><h2>Member Typedef Documentation</h2>
177 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="AmplitudeFollower::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
178 <div class="memitem">
179 <div class="memproto">
180 <table class="memname">
181 <tr>
182 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code></td>
183 </tr>
184 </table>
185 </div>
186 <div class="memdoc">
187
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>
189
190 </div>
191 </div>
192 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="AmplitudeFollower::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
193 <div class="memitem">
194 <div class="memproto">
195 <table class="memname">
196 <tr>
197 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code></td>
198 </tr>
199 </table>
200 </div>
201 <div class="memdoc">
202
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>
204
205 </div>
206 </div>
207 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="AmplitudeFollower::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
208 <div class="memitem">
209 <div class="memproto">
210 <table class="memname">
211 <tr>
212 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code></td>
213 </tr>
214 </table>
215 </div>
216 <div class="memdoc">
217
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>
219
220 </div>
221 </div>
222 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="AmplitudeFollower::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
223 <div class="memitem">
224 <div class="memproto">
225 <table class="memname">
226 <tr>
227 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code></td>
228 </tr>
229 </table>
230 </div>
231 <div class="memdoc">
232
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>
234
235 </div>
236 </div>
237 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="AmplitudeFollower::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
238 <div class="memitem">
239 <div class="memproto">
240 <table class="memname">
241 <tr>
242 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code></td>
243 </tr>
244 </table>
245 </div>
246 <div class="memdoc">
247
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>
249
250 </div>
251 </div>
252 <hr/><h2>Member Enumeration Documentation</h2>
253 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="AmplitudeFollower::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
254 <div class="memitem">
255 <div class="memproto">
256 <table class="memname">
257 <tr>
258 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
259 </tr>
260 </table>
261 </div>
262 <div class="memdoc">
263 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
264 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
265 </td></tr>
266 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
267 </td></tr>
268 </table>
269 </dd>
270 </dl>
271
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>
273
274 </div>
275 </div>
276 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
277 <a class="anchor" id="a29eaeffc353da2614ae508abcd0ab63f"></a><!-- doxytag: member="AmplitudeFollower::AmplitudeFollower" ref="a29eaeffc353da2614ae508abcd0ab63f" args="(float inputSampleRate)" -->
278 <div class="memitem">
279 <div class="memproto">
280 <table class="memname">
281 <tr>
282 <td class="memname">AmplitudeFollower::AmplitudeFollower </td>
283 <td>(</td>
284 <td class="paramtype">float&#160;</td>
285 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
286 <td></td>
287 </tr>
288 </table>
289 </div>
290 <div class="memdoc">
291
292 <p>An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. </p>
293
294 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00055">55</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
295
296 </div>
297 </div>
298 <a class="anchor" id="aa78f98539ad3a1b08691a99b32035b2d"></a><!-- doxytag: member="AmplitudeFollower::~AmplitudeFollower" ref="aa78f98539ad3a1b08691a99b32035b2d" args="()" -->
299 <div class="memitem">
300 <div class="memproto">
301 <table class="memname">
302 <tr>
303 <td class="memname">AmplitudeFollower::~AmplitudeFollower </td>
304 <td>(</td>
305 <td class="paramname"></td><td>)</td>
306 <td><code> [virtual]</code></td>
307 </tr>
308 </table>
309 </div>
310 <div class="memdoc">
311
312 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00064">64</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
313
314 </div>
315 </div>
316 <hr/><h2>Member Function Documentation</h2>
317 <a class="anchor" id="aeb727e44ee8ad1aceb90964d20f8d90d"></a><!-- doxytag: member="AmplitudeFollower::initialise" ref="aeb727e44ee8ad1aceb90964d20f8d90d" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
318 <div class="memitem">
319 <div class="memproto">
320 <table class="memname">
321 <tr>
322 <td class="memname">bool AmplitudeFollower::initialise </td>
323 <td>(</td>
324 <td class="paramtype">size_t&#160;</td>
325 <td class="paramname"><em>inputChannels</em>, </td>
326 </tr>
327 <tr>
328 <td class="paramkey"></td>
329 <td></td>
330 <td class="paramtype">size_t&#160;</td>
331 <td class="paramname"><em>stepSize</em>, </td>
332 </tr>
333 <tr>
334 <td class="paramkey"></td>
335 <td></td>
336 <td class="paramtype">size_t&#160;</td>
337 <td class="paramname"><em>blockSize</em>&#160;</td>
338 </tr>
339 <tr>
340 <td></td>
341 <td>)</td>
342 <td></td><td><code> [virtual]</code></td>
343 </tr>
344 </table>
345 </div>
346 <div class="memdoc">
347
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>
349 <p>The input sample rate should have been already specified at construction time.</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>
351
352 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
353
354 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">105</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
355
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="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00077">m_stepSize</a>.</p>
357
358 </div>
359 </div>
360 <a class="anchor" id="acebd835e80e84669df078fbd7591d8f7"></a><!-- doxytag: member="AmplitudeFollower::reset" ref="acebd835e80e84669df078fbd7591d8f7" args="()" -->
361 <div class="memitem">
362 <div class="memproto">
363 <table class="memname">
364 <tr>
365 <td class="memname">void AmplitudeFollower::reset </td>
366 <td>(</td>
367 <td class="paramname"></td><td>)</td>
368 <td><code> [virtual]</code></td>
369 </tr>
370 </table>
371 </div>
372 <div class="memdoc">
373
374 <p>Reset the plugin after use, to prepare it for another clean run. </p>
375 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
376
377 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
378
379 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00122">122</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
380
381 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>.</p>
382
383 </div>
384 </div>
385 <a class="anchor" id="afc07a389b5f922b944b0350fd232d2eb"></a><!-- doxytag: member="AmplitudeFollower::getInputDomain" ref="afc07a389b5f922b944b0350fd232d2eb" args="() const " -->
386 <div class="memitem">
387 <div class="memproto">
388 <table class="memname">
389 <tr>
390 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> AmplitudeFollower::getInputDomain </td>
391 <td>(</td>
392 <td class="paramname"></td><td>)</td>
393 <td> const<code> [inline, virtual]</code></td>
394 </tr>
395 </table>
396 </div>
397 <div class="memdoc">
398
399 <p>Get the plugin's required input domain. </p>
400 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" 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>
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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" 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>
402
403 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
404
405 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00056">56</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
406
407 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p>
408
409 </div>
410 </div>
411 <a class="anchor" id="afe7576af95c8fcc7f5bad42eec9f9f29"></a><!-- doxytag: member="AmplitudeFollower::getIdentifier" ref="afe7576af95c8fcc7f5bad42eec9f9f29" args="() const " -->
412 <div class="memitem">
413 <div class="memproto">
414 <table class="memname">
415 <tr>
416 <td class="memname">string AmplitudeFollower::getIdentifier </td>
417 <td>(</td>
418 <td class="paramname"></td><td>)</td>
419 <td> const<code> [virtual]</code></td>
420 </tr>
421 </table>
422 </div>
423 <div class="memdoc">
424
425 <p>Get the computer-usable name of the plugin. </p>
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>
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>
428 <p>Example: "zero_crossings" </p>
429
430 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
431
432 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00069">69</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
433
434 </div>
435 </div>
436 <a class="anchor" id="a7cfed00bc9d96ba6c709b69ab6a40594"></a><!-- doxytag: member="AmplitudeFollower::getName" ref="a7cfed00bc9d96ba6c709b69ab6a40594" args="() const " -->
437 <div class="memitem">
438 <div class="memproto">
439 <table class="memname">
440 <tr>
441 <td class="memname">string AmplitudeFollower::getName </td>
442 <td>(</td>
443 <td class="paramname"></td><td>)</td>
444 <td> const<code> [virtual]</code></td>
445 </tr>
446 </table>
447 </div>
448 <div class="memdoc">
449
450 <p>Get a human-readable name or title of the plugin. </p>
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>
452 <p>Example: "Zero Crossings" </p>
453
454 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
455
456 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00075">75</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
457
458 </div>
459 </div>
460 <a class="anchor" id="a6f0f2fea1fdb4b51e688edfe859d5062"></a><!-- doxytag: member="AmplitudeFollower::getDescription" ref="a6f0f2fea1fdb4b51e688edfe859d5062" args="() const " -->
461 <div class="memitem">
462 <div class="memproto">
463 <table class="memname">
464 <tr>
465 <td class="memname">string AmplitudeFollower::getDescription </td>
466 <td>(</td>
467 <td class="paramname"></td><td>)</td>
468 <td> const<code> [virtual]</code></td>
469 </tr>
470 </table>
471 </div>
472 <div class="memdoc">
473
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>
475 <p>May be empty if the name has said it all already.</p>
476 <p>Example: "Detect and count zero crossing points" </p>
477
478 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
479
480 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00081">81</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
481
482 </div>
483 </div>
484 <a class="anchor" id="a44fc43838f203f58bc2ce6e3cb2b03dd"></a><!-- doxytag: member="AmplitudeFollower::getMaker" ref="a44fc43838f203f58bc2ce6e3cb2b03dd" args="() const " -->
485 <div class="memitem">
486 <div class="memproto">
487 <table class="memname">
488 <tr>
489 <td class="memname">string AmplitudeFollower::getMaker </td>
490 <td>(</td>
491 <td class="paramname"></td><td>)</td>
492 <td> const<code> [virtual]</code></td>
493 </tr>
494 </table>
495 </div>
496 <div class="memdoc">
497
498 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
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>
500
501 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
502
503 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00087">87</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
504
505 </div>
506 </div>
507 <a class="anchor" id="a8a5d7a834eb996d517c51f84b2a72250"></a><!-- doxytag: member="AmplitudeFollower::getPluginVersion" ref="a8a5d7a834eb996d517c51f84b2a72250" args="() const " -->
508 <div class="memitem">
509 <div class="memproto">
510 <table class="memname">
511 <tr>
512 <td class="memname">int AmplitudeFollower::getPluginVersion </td>
513 <td>(</td>
514 <td class="paramname"></td><td>)</td>
515 <td> const<code> [virtual]</code></td>
516 </tr>
517 </table>
518 </div>
519 <div class="memdoc">
520
521 <p>Get the version number of the plugin. </p>
522
523 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
524
525 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00093">93</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
526
527 </div>
528 </div>
529 <a class="anchor" id="a0c197fc90f30d91cb4403115c83c9134"></a><!-- doxytag: member="AmplitudeFollower::getCopyright" ref="a0c197fc90f30d91cb4403115c83c9134" args="() const " -->
530 <div class="memitem">
531 <div class="memproto">
532 <table class="memname">
533 <tr>
534 <td class="memname">string AmplitudeFollower::getCopyright </td>
535 <td>(</td>
536 <td class="paramname"></td><td>)</td>
537 <td> const<code> [virtual]</code></td>
538 </tr>
539 </table>
540 </div>
541 <div class="memdoc">
542
543 <p>Get the copyright statement or licensing summary for the plugin. </p>
544 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
545
546 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
547
548 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00099">99</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
549
550 </div>
551 </div>
552 <a class="anchor" id="a043e3c3db77d76267cd8069e1485bf26"></a><!-- doxytag: member="AmplitudeFollower::getOutputDescriptors" ref="a043e3c3db77d76267cd8069e1485bf26" args="() const " -->
553 <div class="memitem">
554 <div class="memproto">
555 <table class="memname">
556 <tr>
557 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">AmplitudeFollower::OutputList</a> AmplitudeFollower::getOutputDescriptors </td>
558 <td>(</td>
559 <td class="paramname"></td><td>)</td>
560 <td> const<code> [virtual]</code></td>
561 </tr>
562 </table>
563 </div>
564 <div class="memdoc">
565
566 <p>Get the outputs of this plugin. </p>
567 <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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">process()</a> call. </p>
568
569 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
570
571 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">128</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
572
573 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00247">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00227">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00239">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00260">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00214">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00278">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00220">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00290">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">Vamp::Plugin::OutputDescriptor::sampleType</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">Vamp::Plugin::OutputDescriptor::unit</a>.</p>
574
575 </div>
576 </div>
577 <a class="anchor" id="a9df01323a09e117bc12354ebe9244edf"></a><!-- doxytag: member="AmplitudeFollower::getParameterDescriptors" ref="a9df01323a09e117bc12354ebe9244edf" args="() const " -->
578 <div class="memitem">
579 <div class="memproto">
580 <table class="memname">
581 <tr>
582 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">AmplitudeFollower::ParameterList</a> AmplitudeFollower::getParameterDescriptors </td>
583 <td>(</td>
584 <td class="paramname"></td><td>)</td>
585 <td> const<code> [virtual]</code></td>
586 </tr>
587 </table>
588 </div>
589 <div class="memdoc">
590
591 <p>Get the controllable parameters of this plugin. </p>
592
593 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
594
595 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">148</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
596
597 <p>References <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00171">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00148">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00137">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00177">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00163">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00158">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00142">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00153">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p>
598
599 </div>
600 </div>
601 <a class="anchor" id="ab278c4b6f2ca23248dc94ad775273f39"></a><!-- doxytag: member="AmplitudeFollower::getParameter" ref="ab278c4b6f2ca23248dc94ad775273f39" args="(std::string paramid) const " -->
602 <div class="memitem">
603 <div class="memproto">
604 <table class="memname">
605 <tr>
606 <td class="memname">float AmplitudeFollower::getParameter </td>
607 <td>(</td>
608 <td class="paramtype">std::string&#160;</td>
609 <td class="paramname"></td><td>)</td>
610 <td> const<code> [virtual]</code></td>
611 </tr>
612 </table>
613 </div>
614 <div class="memdoc">
615
616 <p>Get the value of a named parameter. </p>
617 <p>The argument is the identifier field from that parameter's descriptor. </p>
618
619 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
620
621 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">188</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
622
623 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>.</p>
624
625 </div>
626 </div>
627 <a class="anchor" id="ae1fc37ece4d20e40f3066a3361a99340"></a><!-- doxytag: member="AmplitudeFollower::setParameter" ref="ae1fc37ece4d20e40f3066a3361a99340" args="(std::string paramid, float newval)" -->
628 <div class="memitem">
629 <div class="memproto">
630 <table class="memname">
631 <tr>
632 <td class="memname">void AmplitudeFollower::setParameter </td>
633 <td>(</td>
634 <td class="paramtype">std::string&#160;</td>
635 <td class="paramname">, </td>
636 </tr>
637 <tr>
638 <td class="paramkey"></td>
639 <td></td>
640 <td class="paramtype">float&#160;</td>
641 <td class="paramname">&#160;</td>
642 </tr>
643 <tr>
644 <td></td>
645 <td>)</td>
646 <td></td><td><code> [virtual]</code></td>
647 </tr>
648 </table>
649 </div>
650 <div class="memdoc">
651
652 <p>Set a named parameter. </p>
653 <p>The first argument is the identifier field from that parameter's descriptor. </p>
654
655 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
656
657 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">179</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
658
659 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>.</p>
660
661 </div>
662 </div>
663 <a class="anchor" id="a48d0f95cac31ffd190cff89b50a2a5bd"></a><!-- doxytag: member="AmplitudeFollower::process" ref="a48d0f95cac31ffd190cff89b50a2a5bd" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
664 <div class="memitem">
665 <div class="memproto">
666 <table class="memname">
667 <tr>
668 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::process </td>
669 <td>(</td>
670 <td class="paramtype">const float *const *&#160;</td>
671 <td class="paramname"><em>inputBuffers</em>, </td>
672 </tr>
673 <tr>
674 <td class="paramkey"></td>
675 <td></td>
676 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
677 <td class="paramname"><em>timestamp</em>&#160;</td>
678 </tr>
679 <tr>
680 <td></td>
681 <td>)</td>
682 <td></td><td><code> [virtual]</code></td>
683 </tr>
684 </table>
685 </div>
686 <div class="memdoc">
687
688 <p>Process a single block of input data. </p>
689 <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>
690 <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>
691 <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>
692
693 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
694
695 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">200</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
696
697 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00077">m_stepSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00374">Vamp::Plugin::Feature::values</a>.</p>
698
699 </div>
700 </div>
701 <a class="anchor" id="a368606f643b88e0df0823d85e36f030c"></a><!-- doxytag: member="AmplitudeFollower::getRemainingFeatures" ref="a368606f643b88e0df0823d85e36f030c" args="()" -->
702 <div class="memitem">
703 <div class="memproto">
704 <table class="memname">
705 <tr>
706 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::getRemainingFeatures </td>
707 <td>(</td>
708 <td class="paramname"></td><td>)</td>
709 <td><code> [virtual]</code></td>
710 </tr>
711 </table>
712 </div>
713 <div class="memdoc">
714
715 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
716
717 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
718
719 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00243">243</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
720
721 </div>
722 </div>
723 <a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="AmplitudeFollower::getPreferredBlockSize" ref="aa529adf83f87a603954eb31407602aac" args="() const " -->
724 <div class="memitem">
725 <div class="memproto">
726 <table class="memname">
727 <tr>
728 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
729 <td>(</td>
730 <td class="paramname"></td><td>)</td>
731 <td> const<code> [inline, virtual, inherited]</code></td>
732 </tr>
733 </table>
734 </div>
735 <div class="memdoc">
736
737 <p>Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). </p>
738 <p>This should be called before <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p>
739 <p>A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p>
740
741 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#ad5e0ea8042bdec4dd18428991117e07a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#a68b8569b71504a0478caf990dbe30683">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0">PercussionOnsetDetector</a>.</p>
742
743 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00179">179</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
744
745 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
746
747 </div>
748 </div>
749 <a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="AmplitudeFollower::getPreferredStepSize" ref="a514c716c22f81c055f19b56c3f882567" args="() const " -->
750 <div class="memitem">
751 <div class="memproto">
752 <table class="memname">
753 <tr>
754 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
755 <td>(</td>
756 <td class="paramname"></td><td>)</td>
757 <td> const<code> [inline, virtual, inherited]</code></td>
758 </tr>
759 </table>
760 </div>
761 <div class="memdoc">
762
763 <p>Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. </p>
764 <p>This should be called before <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p>
765 <p>A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p>
766
767 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ad979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a859ad5d59402691daed3cf1af1899ebe">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#ad450bb7e7df559ae3d68dfbfb085676f">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968">PercussionOnsetDetector</a>.</p>
768
769 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00194">194</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
770
771 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
772
773 </div>
774 </div>
775 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="AmplitudeFollower::getMinChannelCount" ref="a267b42e866df3cf0d190893e8096f525" args="() const " -->
776 <div class="memitem">
777 <div class="memproto">
778 <table class="memname">
779 <tr>
780 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
781 <td>(</td>
782 <td class="paramname"></td><td>)</td>
783 <td> const<code> [inline, virtual, inherited]</code></td>
784 </tr>
785 </table>
786 </div>
787 <div class="memdoc">
788
789 <p>Get the minimum supported number of input channels. </p>
790
791 <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>
792
793 <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>
794
795 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">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>
796
797 </div>
798 </div>
799 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="AmplitudeFollower::getMaxChannelCount" ref="a2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
800 <div class="memitem">
801 <div class="memproto">
802 <table class="memname">
803 <tr>
804 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
805 <td>(</td>
806 <td class="paramname"></td><td>)</td>
807 <td> const<code> [inline, virtual, inherited]</code></td>
808 </tr>
809 </table>
810 </div>
811 <div class="memdoc">
812
813 <p>Get the maximum supported number of input channels. </p>
814
815 <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>
816
817 <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>
818
819 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">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
821 </div>
822 </div>
823 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="AmplitudeFollower::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
824 <div class="memitem">
825 <div class="memproto">
826 <table class="memname">
827 <tr>
828 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
829 <td>(</td>
830 <td class="paramname"></td><td>)</td>
831 <td> const<code> [inline, virtual, inherited]</code></td>
832 </tr>
833 </table>
834 </div>
835 <div class="memdoc">
836
837 <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>
838 <p>Do not reimplement this function in your subclass. </p>
839
840 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
841
842 <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>
843
844 </div>
845 </div>
846 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="AmplitudeFollower::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
847 <div class="memitem">
848 <div class="memproto">
849 <table class="memname">
850 <tr>
851 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
852 <td>(</td>
853 <td class="paramname"></td><td>)</td>
854 <td> const<code> [inline, virtual, inherited]</code></td>
855 </tr>
856 </table>
857 </div>
858 <div class="memdoc">
859
860 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
861
862 <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>
863
864 <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>
865
866 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
867
868 </div>
869 </div>
870 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="AmplitudeFollower::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
871 <div class="memitem">
872 <div class="memproto">
873 <table class="memname">
874 <tr>
875 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
876 <td>(</td>
877 <td class="paramname"></td><td>)</td>
878 <td> const<code> [inline, virtual, inherited]</code></td>
879 </tr>
880 </table>
881 </div>
882 <div class="memdoc">
883
884 <p>Get the program settings available in this plugin. </p>
885 <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>
886 <p>The programs must have unique names. </p>
887
888 <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>
889
890 <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>
891
892 </div>
893 </div>
894 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="AmplitudeFollower::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
895 <div class="memitem">
896 <div class="memproto">
897 <table class="memname">
898 <tr>
899 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
900 <td>(</td>
901 <td class="paramname"></td><td>)</td>
902 <td> const<code> [inline, virtual, inherited]</code></td>
903 </tr>
904 </table>
905 </div>
906 <div class="memdoc">
907
908 <p>Get the current program. </p>
909
910 <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>
911
912 <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>
913
914 </div>
915 </div>
916 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="AmplitudeFollower::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" -->
917 <div class="memitem">
918 <div class="memproto">
919 <table class="memname">
920 <tr>
921 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
922 <td>(</td>
923 <td class="paramtype">std::string&#160;</td>
924 <td class="paramname"></td><td>)</td>
925 <td><code> [inline, virtual, inherited]</code></td>
926 </tr>
927 </table>
928 </div>
929 <div class="memdoc">
930
931 <p>Select a program. </p>
932 <p>(If the given program name is not one of the available programs, do nothing.) </p>
933
934 <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>
935
936 <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>
937
938 </div>
939 </div>
940 <hr/><h2>Member Data Documentation</h2>
941 <a class="anchor" id="a959c2647fd3c5feea2591e3618774027"></a><!-- doxytag: member="AmplitudeFollower::m_stepSize" ref="a959c2647fd3c5feea2591e3618774027" args="" -->
942 <div class="memitem">
943 <div class="memproto">
944 <table class="memname">
945 <tr>
946 <td class="memname">size_t <a class="el" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">AmplitudeFollower::m_stepSize</a><code> [protected]</code></td>
947 </tr>
948 </table>
949 </div>
950 <div class="memdoc">
951
952 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00077">77</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
953
954 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>.</p>
955
956 </div>
957 </div>
958 <a class="anchor" id="ac95e8d2f334821c6c92c706bae29695a"></a><!-- doxytag: member="AmplitudeFollower::m_previn" ref="ac95e8d2f334821c6c92c706bae29695a" args="" -->
959 <div class="memitem">
960 <div class="memproto">
961 <table class="memname">
962 <tr>
963 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">AmplitudeFollower::m_previn</a><code> [protected]</code></td>
964 </tr>
965 </table>
966 </div>
967 <div class="memdoc">
968
969 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00078">78</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
970
971 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00122">reset()</a>.</p>
972
973 </div>
974 </div>
975 <a class="anchor" id="a1cb205b08cfe2ce94a4af05b18f72876"></a><!-- doxytag: member="AmplitudeFollower::m_clampcoef" ref="a1cb205b08cfe2ce94a4af05b18f72876" args="" -->
976 <div class="memitem">
977 <div class="memproto">
978 <table class="memname">
979 <tr>
980 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">AmplitudeFollower::m_clampcoef</a><code> [protected]</code></td>
981 </tr>
982 </table>
983 </div>
984 <div class="memdoc">
985
986 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00079">79</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
987
988 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">setParameter()</a>.</p>
989
990 </div>
991 </div>
992 <a class="anchor" id="aceecd3b3879f32eb4a2e597c32c41cfc"></a><!-- doxytag: member="AmplitudeFollower::m_relaxcoef" ref="aceecd3b3879f32eb4a2e597c32c41cfc" args="" -->
993 <div class="memitem">
994 <div class="memproto">
995 <table class="memname">
996 <tr>
997 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">AmplitudeFollower::m_relaxcoef</a><code> [protected]</code></td>
998 </tr>
999 </table>
1000 </div>
1001 <div class="memdoc">
1002
1003 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00080">80</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
1004
1005 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">setParameter()</a>.</p>
1006
1007 </div>
1008 </div>
1009 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="AmplitudeFollower::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
1010 <div class="memitem">
1011 <div class="memproto">
1012 <table class="memname">
1013 <tr>
1014 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
1015 </tr>
1016 </table>
1017 </div>
1018 <div class="memdoc">
1019
1020 <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>
1021
1022 <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">initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p>
1023
1024 </div>
1025 </div>
1026 <hr/>The documentation for this class was generated from the following files:<ul>
1027 <li><a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a></li>
1028 <li><a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a></li>
1029 </ul>
1030 </div>
1031 </div>
1032 <div id="nav-path" class="navpath">
1033 <ul>
1034 <li class="navelem"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> </li>
1035
1036 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
1037 <a href="http://www.doxygen.org/index.html">
1038 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
1039 </ul>
1040 </div>
1041
1042
1043 </body>
1044 </html>