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

Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
rev   line source
cannam@50 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@50 2 <html xmlns="http://www.w3.org/1999/xhtml">
cannam@50 3 <head>
cannam@50 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
cannam@0 5 <title>VampPluginSDK: AmplitudeFollower Class Reference</title>
cannam@50 6
cannam@50 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
cannam@50 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
cannam@50 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
cannam@50 10 <script type="text/javascript" src="jquery.js"></script>
cannam@50 11 <script type="text/javascript" src="resize.js"></script>
cannam@50 12 <script type="text/javascript" src="navtree.js"></script>
cannam@50 13 <script type="text/javascript">
cannam@50 14 $(document).ready(initResizable);
cannam@50 15 </script>
cannam@50 16
cannam@50 17
cannam@50 18 </head>
cannam@50 19 <body>
cannam@50 20 <div id="top"><!-- do not remove this div! -->
cannam@50 21
cannam@50 22
cannam@50 23 <div id="titlearea">
cannam@50 24 <table cellspacing="0" cellpadding="0">
cannam@50 25 <tbody>
cannam@50 26 <tr style="height: 56px;">
cannam@50 27
cannam@50 28
cannam@50 29 <td style="padding-left: 0.5em;">
cannam@50 30 <div id="projectname">VampPluginSDK
cannam@50 31 &#160;<span id="projectnumber">2.1</span>
cannam@50 32 </div>
cannam@50 33
cannam@50 34 </td>
cannam@50 35
cannam@50 36
cannam@50 37
cannam@50 38 </tr>
cannam@50 39 </tbody>
cannam@50 40 </table>
cannam@50 41 </div>
cannam@50 42
cannam@50 43 <!-- Generated by Doxygen 1.7.5.1 -->
cannam@50 44 <div id="navrow1" class="tabs">
cannam@50 45 <ul class="tablist">
cannam@50 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
cannam@0 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 49 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 50 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 51 </ul>
cannam@0 52 </div>
cannam@50 53 <div id="navrow2" class="tabs2">
cannam@50 54 <ul class="tablist">
cannam@50 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
cannam@50 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
cannam@50 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
cannam@0 58 </ul>
cannam@0 59 </div>
cannam@0 60 </div>
cannam@50 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
cannam@50 62 <div id="nav-tree">
cannam@50 63 <div id="nav-tree-contents">
cannam@50 64 </div>
cannam@50 65 </div>
cannam@50 66 <div id="splitbar" style="-moz-user-select:none;"
cannam@50 67 class="ui-resizable-handle">
cannam@50 68 </div>
cannam@50 69 </div>
cannam@50 70 <script type="text/javascript">
cannam@50 71 initNavTree('classAmplitudeFollower.html','');
cannam@50 72 </script>
cannam@50 73 <div id="doc-content">
cannam@50 74 <div class="header">
cannam@50 75 <div class="summary">
cannam@50 76 <a href="#pub-types">Public Types</a> &#124;
cannam@50 77 <a href="#pub-methods">Public Member Functions</a> &#124;
cannam@50 78 <a href="#pro-attribs">Protected Attributes</a> </div>
cannam@50 79 <div class="headertitle">
cannam@50 80 <div class="title">AmplitudeFollower Class Reference</div> </div>
cannam@50 81 </div>
cannam@0 82 <div class="contents">
cannam@50 83 <!-- doxytag: class="AmplitudeFollower" --><!-- doxytag: inherits="Vamp::Plugin" -->
cannam@50 84 <p>Example plugin implementing the SuperCollider amplitude follower function.
cannam@50 85 <a href="classAmplitudeFollower.html#details">More...</a></p>
cannam@50 86
cannam@50 87 <p><code>#include &lt;<a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>&gt;</code></p>
cannam@0 88 <div class="dynheader">
cannam@0 89 Inheritance diagram for AmplitudeFollower:</div>
cannam@50 90 <div class="dyncontent">
cannam@50 91 <div class="center"><img src="classAmplitudeFollower__inherit__graph.png" border="0" usemap="#AmplitudeFollower_inherit__map" alt="Inheritance graph"/></div>
cannam@50 92 <map name="AmplitudeFollower_inherit__map" id="AmplitudeFollower_inherit__map">
cannam@50 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>
cannam@50 94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
cannam@0 95
cannam@50 96 <p><a href="classAmplitudeFollower-members.html">List of all members.</a></p>
cannam@50 97 <table class="memberdecls">
cannam@50 98 <tr><td colspan="2"><h2><a name="pub-types"></a>
cannam@50 99 Public Types</h2></td></tr>
cannam@50 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>,
cannam@50 101 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
cannam@0 102 }</td></tr>
cannam@50 103 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
cannam@50 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>
cannam@50 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>
cannam@50 106 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
cannam@50 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>
cannam@50 108 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
cannam@50 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>
cannam@50 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>
cannam@50 111 <tr><td colspan="2"><h2><a name="pub-methods"></a>
cannam@50 112 Public Member Functions</h2></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 121 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#afc07a389b5f922b944b0350fd232d2eb"></a><br/></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 131 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a8a5d7a834eb996d517c51f84b2a72250"></a><br/></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 135 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a043e3c3db77d76267cd8069e1485bf26"></a><br/></td></tr>
cannam@50 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>
cannam@50 137 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9df01323a09e117bc12354ebe9244edf"></a><br/></td></tr>
cannam@50 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>
cannam@50 139 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#ab278c4b6f2ca23248dc94ad775273f39"></a><br/></td></tr>
cannam@50 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>
cannam@50 141 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#ae1fc37ece4d20e40f3066a3361a99340"></a><br/></td></tr>
cannam@50 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>
cannam@50 143 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a48d0f95cac31ffd190cff89b50a2a5bd"></a><br/></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 161 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr>
cannam@50 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>
cannam@50 163 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr>
cannam@50 164 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
cannam@50 165 Protected Attributes</h2></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 170 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
cannam@50 171 </table>
cannam@50 172 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
cannam@50 173 <div class="textblock"><p>Example plugin implementing the SuperCollider amplitude follower function. </p>
cannam@0 174
cannam@50 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>
cannam@50 176 </div><hr/><h2>Member Typedef Documentation</h2>
cannam@50 177 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="AmplitudeFollower::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
cannam@0 178 <div class="memitem">
cannam@0 179 <div class="memproto">
cannam@0 180 <table class="memname">
cannam@0 181 <tr>
cannam@50 182 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code></td>
cannam@0 183 </tr>
cannam@0 184 </table>
cannam@0 185 </div>
cannam@0 186 <div class="memdoc">
cannam@0 187
cannam@50 188 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00327">327</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 189
cannam@0 190 </div>
cannam@50 191 </div>
cannam@50 192 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="AmplitudeFollower::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
cannam@0 193 <div class="memitem">
cannam@0 194 <div class="memproto">
cannam@0 195 <table class="memname">
cannam@0 196 <tr>
cannam@50 197 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code></td>
cannam@0 198 </tr>
cannam@0 199 </table>
cannam@0 200 </div>
cannam@0 201 <div class="memdoc">
cannam@0 202
cannam@50 203 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00385">385</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 204
cannam@0 205 </div>
cannam@50 206 </div>
cannam@50 207 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="AmplitudeFollower::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
cannam@0 208 <div class="memitem">
cannam@0 209 <div class="memproto">
cannam@0 210 <table class="memname">
cannam@0 211 <tr>
cannam@50 212 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code></td>
cannam@0 213 </tr>
cannam@0 214 </table>
cannam@0 215 </div>
cannam@0 216 <div class="memdoc">
cannam@0 217
cannam@50 218 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 219
cannam@0 220 </div>
cannam@50 221 </div>
cannam@50 222 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="AmplitudeFollower::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
cannam@0 223 <div class="memitem">
cannam@0 224 <div class="memproto">
cannam@0 225 <table class="memname">
cannam@0 226 <tr>
cannam@50 227 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code></td>
cannam@0 228 </tr>
cannam@0 229 </table>
cannam@0 230 </div>
cannam@0 231 <div class="memdoc">
cannam@0 232
cannam@50 233 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 234
cannam@0 235 </div>
cannam@50 236 </div>
cannam@50 237 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="AmplitudeFollower::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
cannam@0 238 <div class="memitem">
cannam@0 239 <div class="memproto">
cannam@0 240 <table class="memname">
cannam@0 241 <tr>
cannam@50 242 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code></td>
cannam@0 243 </tr>
cannam@0 244 </table>
cannam@0 245 </div>
cannam@0 246 <div class="memdoc">
cannam@0 247
cannam@50 248 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 249
cannam@0 250 </div>
cannam@50 251 </div>
cannam@50 252 <hr/><h2>Member Enumeration Documentation</h2>
cannam@50 253 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="AmplitudeFollower::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
cannam@0 254 <div class="memitem">
cannam@0 255 <div class="memproto">
cannam@0 256 <table class="memname">
cannam@0 257 <tr>
cannam@50 258 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
cannam@0 259 </tr>
cannam@0 260 </table>
cannam@0 261 </div>
cannam@0 262 <div class="memdoc">
cannam@50 263 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
cannam@50 264 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
cannam@0 265 </td></tr>
cannam@50 266 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
cannam@0 267 </td></tr>
cannam@0 268 </table>
cannam@50 269 </dd>
cannam@0 270 </dl>
cannam@0 271
cannam@50 272 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 273
cannam@0 274 </div>
cannam@50 275 </div>
cannam@50 276 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
cannam@50 277 <a class="anchor" id="a29eaeffc353da2614ae508abcd0ab63f"></a><!-- doxytag: member="AmplitudeFollower::AmplitudeFollower" ref="a29eaeffc353da2614ae508abcd0ab63f" args="(float inputSampleRate)" -->
cannam@0 278 <div class="memitem">
cannam@0 279 <div class="memproto">
cannam@0 280 <table class="memname">
cannam@0 281 <tr>
cannam@50 282 <td class="memname">AmplitudeFollower::AmplitudeFollower </td>
cannam@0 283 <td>(</td>
cannam@50 284 <td class="paramtype">float&#160;</td>
cannam@50 285 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
cannam@21 286 <td></td>
cannam@0 287 </tr>
cannam@0 288 </table>
cannam@0 289 </div>
cannam@0 290 <div class="memdoc">
cannam@0 291
cannam@50 292 <p>An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. </p>
cannam@0 293
cannam@50 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>
cannam@0 295
cannam@0 296 </div>
cannam@50 297 </div>
cannam@50 298 <a class="anchor" id="aa78f98539ad3a1b08691a99b32035b2d"></a><!-- doxytag: member="AmplitudeFollower::~AmplitudeFollower" ref="aa78f98539ad3a1b08691a99b32035b2d" args="()" -->
cannam@0 299 <div class="memitem">
cannam@0 300 <div class="memproto">
cannam@0 301 <table class="memname">
cannam@0 302 <tr>
cannam@50 303 <td class="memname">AmplitudeFollower::~AmplitudeFollower </td>
cannam@0 304 <td>(</td>
cannam@50 305 <td class="paramname"></td><td>)</td>
cannam@21 306 <td><code> [virtual]</code></td>
cannam@0 307 </tr>
cannam@0 308 </table>
cannam@0 309 </div>
cannam@0 310 <div class="memdoc">
cannam@0 311
cannam@50 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>
cannam@0 313
cannam@0 314 </div>
cannam@50 315 </div>
cannam@50 316 <hr/><h2>Member Function Documentation</h2>
cannam@50 317 <a class="anchor" id="aeb727e44ee8ad1aceb90964d20f8d90d"></a><!-- doxytag: member="AmplitudeFollower::initialise" ref="aeb727e44ee8ad1aceb90964d20f8d90d" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
cannam@0 318 <div class="memitem">
cannam@0 319 <div class="memproto">
cannam@0 320 <table class="memname">
cannam@0 321 <tr>
cannam@50 322 <td class="memname">bool AmplitudeFollower::initialise </td>
cannam@0 323 <td>(</td>
cannam@50 324 <td class="paramtype">size_t&#160;</td>
cannam@50 325 <td class="paramname"><em>inputChannels</em>, </td>
cannam@0 326 </tr>
cannam@0 327 <tr>
cannam@0 328 <td class="paramkey"></td>
cannam@0 329 <td></td>
cannam@50 330 <td class="paramtype">size_t&#160;</td>
cannam@50 331 <td class="paramname"><em>stepSize</em>, </td>
cannam@0 332 </tr>
cannam@0 333 <tr>
cannam@0 334 <td class="paramkey"></td>
cannam@0 335 <td></td>
cannam@50 336 <td class="paramtype">size_t&#160;</td>
cannam@50 337 <td class="paramname"><em>blockSize</em>&#160;</td>
cannam@0 338 </tr>
cannam@0 339 <tr>
cannam@0 340 <td></td>
cannam@0 341 <td>)</td>
cannam@50 342 <td></td><td><code> [virtual]</code></td>
cannam@0 343 </tr>
cannam@0 344 </table>
cannam@0 345 </div>
cannam@0 346 <div class="memdoc">
cannam@0 347
cannam@50 348 <p>Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). </p>
cannam@50 349 <p>The input sample rate should have been already specified at construction time.</p>
cannam@50 350 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
cannam@0 351
cannam@50 352 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
cannam@0 353
cannam@50 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>
cannam@50 355
cannam@50 356 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="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>
cannam@0 357
cannam@0 358 </div>
cannam@50 359 </div>
cannam@50 360 <a class="anchor" id="acebd835e80e84669df078fbd7591d8f7"></a><!-- doxytag: member="AmplitudeFollower::reset" ref="acebd835e80e84669df078fbd7591d8f7" args="()" -->
cannam@0 361 <div class="memitem">
cannam@0 362 <div class="memproto">
cannam@0 363 <table class="memname">
cannam@0 364 <tr>
cannam@50 365 <td class="memname">void AmplitudeFollower::reset </td>
cannam@0 366 <td>(</td>
cannam@50 367 <td class="paramname"></td><td>)</td>
cannam@21 368 <td><code> [virtual]</code></td>
cannam@0 369 </tr>
cannam@0 370 </table>
cannam@0 371 </div>
cannam@0 372 <div class="memdoc">
cannam@0 373
cannam@50 374 <p>Reset the plugin after use, to prepare it for another clean run. </p>
cannam@50 375 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
cannam@0 376
cannam@50 377 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
cannam@0 378
cannam@50 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>
cannam@50 380
cannam@50 381 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>.</p>
cannam@0 382
cannam@0 383 </div>
cannam@50 384 </div>
cannam@50 385 <a class="anchor" id="afc07a389b5f922b944b0350fd232d2eb"></a><!-- doxytag: member="AmplitudeFollower::getInputDomain" ref="afc07a389b5f922b944b0350fd232d2eb" args="() const " -->
cannam@0 386 <div class="memitem">
cannam@0 387 <div class="memproto">
cannam@0 388 <table class="memname">
cannam@0 389 <tr>
cannam@50 390 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> AmplitudeFollower::getInputDomain </td>
cannam@0 391 <td>(</td>
cannam@50 392 <td class="paramname"></td><td>)</td>
cannam@21 393 <td> const<code> [inline, virtual]</code></td>
cannam@0 394 </tr>
cannam@0 395 </table>
cannam@0 396 </div>
cannam@0 397 <div class="memdoc">
cannam@0 398
cannam@50 399 <p>Get the plugin's required input domain. </p>
cannam@50 400 <p>If this is TimeDomain, the samples provided to the <a class="el" href="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>
cannam@50 401 <p>If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="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>
cannam@0 402
cannam@50 403 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
cannam@0 404
cannam@50 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>
cannam@50 406
cannam@50 407 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p>
cannam@0 408
cannam@0 409 </div>
cannam@50 410 </div>
cannam@50 411 <a class="anchor" id="afe7576af95c8fcc7f5bad42eec9f9f29"></a><!-- doxytag: member="AmplitudeFollower::getIdentifier" ref="afe7576af95c8fcc7f5bad42eec9f9f29" args="() const " -->
cannam@0 412 <div class="memitem">
cannam@0 413 <div class="memproto">
cannam@0 414 <table class="memname">
cannam@0 415 <tr>
cannam@50 416 <td class="memname">string AmplitudeFollower::getIdentifier </td>
cannam@0 417 <td>(</td>
cannam@50 418 <td class="paramname"></td><td>)</td>
cannam@21 419 <td> const<code> [virtual]</code></td>
cannam@0 420 </tr>
cannam@0 421 </table>
cannam@0 422 </div>
cannam@0 423 <div class="memdoc">
cannam@0 424
cannam@50 425 <p>Get the computer-usable name of the plugin. </p>
cannam@50 426 <p>This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.</p>
cannam@50 427 <p>This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).</p>
cannam@50 428 <p>Example: "zero_crossings" </p>
cannam@0 429
cannam@50 430 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
cannam@50 431
cannam@50 432 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00069">69</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
cannam@0 433
cannam@0 434 </div>
cannam@50 435 </div>
cannam@50 436 <a class="anchor" id="a7cfed00bc9d96ba6c709b69ab6a40594"></a><!-- doxytag: member="AmplitudeFollower::getName" ref="a7cfed00bc9d96ba6c709b69ab6a40594" args="() const " -->
cannam@0 437 <div class="memitem">
cannam@0 438 <div class="memproto">
cannam@0 439 <table class="memname">
cannam@0 440 <tr>
cannam@50 441 <td class="memname">string AmplitudeFollower::getName </td>
cannam@0 442 <td>(</td>
cannam@50 443 <td class="paramname"></td><td>)</td>
cannam@21 444 <td> const<code> [virtual]</code></td>
cannam@0 445 </tr>
cannam@0 446 </table>
cannam@0 447 </div>
cannam@0 448 <div class="memdoc">
cannam@0 449
cannam@50 450 <p>Get a human-readable name or title of the plugin. </p>
cannam@50 451 <p>This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").</p>
cannam@50 452 <p>Example: "Zero Crossings" </p>
cannam@0 453
cannam@50 454 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
cannam@50 455
cannam@50 456 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00075">75</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
cannam@0 457
cannam@0 458 </div>
cannam@50 459 </div>
cannam@50 460 <a class="anchor" id="a6f0f2fea1fdb4b51e688edfe859d5062"></a><!-- doxytag: member="AmplitudeFollower::getDescription" ref="a6f0f2fea1fdb4b51e688edfe859d5062" args="() const " -->
cannam@0 461 <div class="memitem">
cannam@0 462 <div class="memproto">
cannam@0 463 <table class="memname">
cannam@0 464 <tr>
cannam@50 465 <td class="memname">string AmplitudeFollower::getDescription </td>
cannam@0 466 <td>(</td>
cannam@50 467 <td class="paramname"></td><td>)</td>
cannam@21 468 <td> const<code> [virtual]</code></td>
cannam@0 469 </tr>
cannam@0 470 </table>
cannam@0 471 </div>
cannam@0 472 <div class="memdoc">
cannam@0 473
cannam@50 474 <p>Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p>
cannam@50 475 <p>May be empty if the name has said it all already.</p>
cannam@50 476 <p>Example: "Detect and count zero crossing points" </p>
cannam@0 477
cannam@50 478 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
cannam@50 479
cannam@50 480 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00081">81</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
cannam@0 481
cannam@0 482 </div>
cannam@50 483 </div>
cannam@50 484 <a class="anchor" id="a44fc43838f203f58bc2ce6e3cb2b03dd"></a><!-- doxytag: member="AmplitudeFollower::getMaker" ref="a44fc43838f203f58bc2ce6e3cb2b03dd" args="() const " -->
cannam@0 485 <div class="memitem">
cannam@0 486 <div class="memproto">
cannam@0 487 <table class="memname">
cannam@0 488 <tr>
cannam@50 489 <td class="memname">string AmplitudeFollower::getMaker </td>
cannam@0 490 <td>(</td>
cannam@50 491 <td class="paramname"></td><td>)</td>
cannam@21 492 <td> const<code> [virtual]</code></td>
cannam@0 493 </tr>
cannam@0 494 </table>
cannam@0 495 </div>
cannam@0 496 <div class="memdoc">
cannam@0 497
cannam@50 498 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
cannam@50 499 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
cannam@0 500
cannam@50 501 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
cannam@50 502
cannam@50 503 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00087">87</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
cannam@0 504
cannam@0 505 </div>
cannam@50 506 </div>
cannam@50 507 <a class="anchor" id="a8a5d7a834eb996d517c51f84b2a72250"></a><!-- doxytag: member="AmplitudeFollower::getPluginVersion" ref="a8a5d7a834eb996d517c51f84b2a72250" args="() const " -->
cannam@0 508 <div class="memitem">
cannam@0 509 <div class="memproto">
cannam@0 510 <table class="memname">
cannam@0 511 <tr>
cannam@50 512 <td class="memname">int AmplitudeFollower::getPluginVersion </td>
cannam@0 513 <td>(</td>
cannam@50 514 <td class="paramname"></td><td>)</td>
cannam@21 515 <td> const<code> [virtual]</code></td>
cannam@0 516 </tr>
cannam@0 517 </table>
cannam@0 518 </div>
cannam@0 519 <div class="memdoc">
cannam@0 520
cannam@50 521 <p>Get the version number of the plugin. </p>
cannam@0 522
cannam@50 523 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
cannam@0 524
cannam@50 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>
cannam@0 526
cannam@0 527 </div>
cannam@50 528 </div>
cannam@50 529 <a class="anchor" id="a0c197fc90f30d91cb4403115c83c9134"></a><!-- doxytag: member="AmplitudeFollower::getCopyright" ref="a0c197fc90f30d91cb4403115c83c9134" args="() const " -->
cannam@0 530 <div class="memitem">
cannam@0 531 <div class="memproto">
cannam@0 532 <table class="memname">
cannam@0 533 <tr>
cannam@50 534 <td class="memname">string AmplitudeFollower::getCopyright </td>
cannam@0 535 <td>(</td>
cannam@50 536 <td class="paramname"></td><td>)</td>
cannam@21 537 <td> const<code> [virtual]</code></td>
cannam@0 538 </tr>
cannam@0 539 </table>
cannam@0 540 </div>
cannam@0 541 <div class="memdoc">
cannam@0 542
cannam@50 543 <p>Get the copyright statement or licensing summary for the plugin. </p>
cannam@50 544 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
cannam@0 545
cannam@50 546 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
cannam@50 547
cannam@50 548 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00099">99</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
cannam@0 549
cannam@0 550 </div>
cannam@50 551 </div>
cannam@50 552 <a class="anchor" id="a043e3c3db77d76267cd8069e1485bf26"></a><!-- doxytag: member="AmplitudeFollower::getOutputDescriptors" ref="a043e3c3db77d76267cd8069e1485bf26" args="() const " -->
cannam@0 553 <div class="memitem">
cannam@0 554 <div class="memproto">
cannam@0 555 <table class="memname">
cannam@0 556 <tr>
cannam@50 557 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">AmplitudeFollower::OutputList</a> AmplitudeFollower::getOutputDescriptors </td>
cannam@0 558 <td>(</td>
cannam@50 559 <td class="paramname"></td><td>)</td>
cannam@21 560 <td> const<code> [virtual]</code></td>
cannam@0 561 </tr>
cannam@0 562 </table>
cannam@0 563 </div>
cannam@0 564 <div class="memdoc">
cannam@0 565
cannam@50 566 <p>Get the outputs of this plugin. </p>
cannam@50 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>
cannam@0 568
cannam@50 569 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
cannam@0 570
cannam@50 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>
cannam@50 572
cannam@50 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>
cannam@0 574
cannam@0 575 </div>
cannam@50 576 </div>
cannam@50 577 <a class="anchor" id="a9df01323a09e117bc12354ebe9244edf"></a><!-- doxytag: member="AmplitudeFollower::getParameterDescriptors" ref="a9df01323a09e117bc12354ebe9244edf" args="() const " -->
cannam@0 578 <div class="memitem">
cannam@0 579 <div class="memproto">
cannam@0 580 <table class="memname">
cannam@0 581 <tr>
cannam@50 582 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">AmplitudeFollower::ParameterList</a> AmplitudeFollower::getParameterDescriptors </td>
cannam@0 583 <td>(</td>
cannam@50 584 <td class="paramname"></td><td>)</td>
cannam@21 585 <td> const<code> [virtual]</code></td>
cannam@0 586 </tr>
cannam@0 587 </table>
cannam@0 588 </div>
cannam@0 589 <div class="memdoc">
cannam@0 590
cannam@50 591 <p>Get the controllable parameters of this plugin. </p>
cannam@0 592
cannam@50 593 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
cannam@0 594
cannam@50 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>
cannam@0 596
cannam@50 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>
cannam@0 598
cannam@0 599 </div>
cannam@50 600 </div>
cannam@50 601 <a class="anchor" id="ab278c4b6f2ca23248dc94ad775273f39"></a><!-- doxytag: member="AmplitudeFollower::getParameter" ref="ab278c4b6f2ca23248dc94ad775273f39" args="(std::string paramid) const " -->
cannam@0 602 <div class="memitem">
cannam@0 603 <div class="memproto">
cannam@0 604 <table class="memname">
cannam@0 605 <tr>
cannam@50 606 <td class="memname">float AmplitudeFollower::getParameter </td>
cannam@0 607 <td>(</td>
cannam@50 608 <td class="paramtype">std::string&#160;</td>
cannam@50 609 <td class="paramname"></td><td>)</td>
cannam@21 610 <td> const<code> [virtual]</code></td>
cannam@0 611 </tr>
cannam@0 612 </table>
cannam@0 613 </div>
cannam@0 614 <div class="memdoc">
cannam@0 615
cannam@50 616 <p>Get the value of a named parameter. </p>
cannam@50 617 <p>The argument is the identifier field from that parameter's descriptor. </p>
cannam@0 618
cannam@50 619 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
cannam@0 620
cannam@50 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>
cannam@50 622
cannam@50 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>
cannam@0 624
cannam@0 625 </div>
cannam@50 626 </div>
cannam@50 627 <a class="anchor" id="ae1fc37ece4d20e40f3066a3361a99340"></a><!-- doxytag: member="AmplitudeFollower::setParameter" ref="ae1fc37ece4d20e40f3066a3361a99340" args="(std::string paramid, float newval)" -->
cannam@0 628 <div class="memitem">
cannam@0 629 <div class="memproto">
cannam@0 630 <table class="memname">
cannam@0 631 <tr>
cannam@50 632 <td class="memname">void AmplitudeFollower::setParameter </td>
cannam@0 633 <td>(</td>
cannam@50 634 <td class="paramtype">std::string&#160;</td>
cannam@0 635 <td class="paramname">, </td>
cannam@0 636 </tr>
cannam@0 637 <tr>
cannam@0 638 <td class="paramkey"></td>
cannam@0 639 <td></td>
cannam@50 640 <td class="paramtype">float&#160;</td>
cannam@50 641 <td class="paramname">&#160;</td>
cannam@0 642 </tr>
cannam@0 643 <tr>
cannam@0 644 <td></td>
cannam@0 645 <td>)</td>
cannam@50 646 <td></td><td><code> [virtual]</code></td>
cannam@0 647 </tr>
cannam@0 648 </table>
cannam@0 649 </div>
cannam@0 650 <div class="memdoc">
cannam@0 651
cannam@50 652 <p>Set a named parameter. </p>
cannam@50 653 <p>The first argument is the identifier field from that parameter's descriptor. </p>
cannam@0 654
cannam@50 655 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
cannam@0 656
cannam@50 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>
cannam@50 658
cannam@50 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>
cannam@0 660
cannam@0 661 </div>
cannam@50 662 </div>
cannam@50 663 <a class="anchor" id="a48d0f95cac31ffd190cff89b50a2a5bd"></a><!-- doxytag: member="AmplitudeFollower::process" ref="a48d0f95cac31ffd190cff89b50a2a5bd" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
cannam@0 664 <div class="memitem">
cannam@0 665 <div class="memproto">
cannam@0 666 <table class="memname">
cannam@0 667 <tr>
cannam@50 668 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::process </td>
cannam@0 669 <td>(</td>
cannam@50 670 <td class="paramtype">const float *const *&#160;</td>
cannam@50 671 <td class="paramname"><em>inputBuffers</em>, </td>
cannam@0 672 </tr>
cannam@0 673 <tr>
cannam@0 674 <td class="paramkey"></td>
cannam@0 675 <td></td>
cannam@50 676 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
cannam@50 677 <td class="paramname"><em>timestamp</em>&#160;</td>
cannam@0 678 </tr>
cannam@0 679 <tr>
cannam@0 680 <td></td>
cannam@0 681 <td>)</td>
cannam@50 682 <td></td><td><code> [virtual]</code></td>
cannam@0 683 </tr>
cannam@0 684 </table>
cannam@0 685 </div>
cannam@0 686 <div class="memdoc">
cannam@0 687
cannam@50 688 <p>Process a single block of input data. </p>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@0 692
cannam@50 693 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
cannam@0 694
cannam@50 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>
cannam@50 696
cannam@50 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>
cannam@0 698
cannam@0 699 </div>
cannam@50 700 </div>
cannam@50 701 <a class="anchor" id="a368606f643b88e0df0823d85e36f030c"></a><!-- doxytag: member="AmplitudeFollower::getRemainingFeatures" ref="a368606f643b88e0df0823d85e36f030c" args="()" -->
cannam@0 702 <div class="memitem">
cannam@0 703 <div class="memproto">
cannam@0 704 <table class="memname">
cannam@0 705 <tr>
cannam@50 706 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::getRemainingFeatures </td>
cannam@0 707 <td>(</td>
cannam@50 708 <td class="paramname"></td><td>)</td>
cannam@21 709 <td><code> [virtual]</code></td>
cannam@0 710 </tr>
cannam@0 711 </table>
cannam@0 712 </div>
cannam@0 713 <div class="memdoc">
cannam@0 714
cannam@50 715 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
cannam@0 716
cannam@50 717 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
cannam@0 718
cannam@50 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>
cannam@0 720
cannam@0 721 </div>
cannam@50 722 </div>
cannam@50 723 <a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="AmplitudeFollower::getPreferredBlockSize" ref="aa529adf83f87a603954eb31407602aac" args="() const " -->
cannam@0 724 <div class="memitem">
cannam@0 725 <div class="memproto">
cannam@0 726 <table class="memname">
cannam@0 727 <tr>
cannam@50 728 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
cannam@0 729 <td>(</td>
cannam@50 730 <td class="paramname"></td><td>)</td>
cannam@21 731 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 732 </tr>
cannam@0 733 </table>
cannam@0 734 </div>
cannam@0 735 <div class="memdoc">
cannam@0 736
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@0 740
cannam@50 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>
cannam@0 742
cannam@50 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>
cannam@50 744
cannam@50 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>
cannam@0 746
cannam@0 747 </div>
cannam@50 748 </div>
cannam@50 749 <a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="AmplitudeFollower::getPreferredStepSize" ref="a514c716c22f81c055f19b56c3f882567" args="() const " -->
cannam@0 750 <div class="memitem">
cannam@0 751 <div class="memproto">
cannam@0 752 <table class="memname">
cannam@0 753 <tr>
cannam@50 754 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
cannam@0 755 <td>(</td>
cannam@50 756 <td class="paramname"></td><td>)</td>
cannam@21 757 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 758 </tr>
cannam@0 759 </table>
cannam@0 760 </div>
cannam@0 761 <div class="memdoc">
cannam@0 762
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@0 766
cannam@50 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>
cannam@0 768
cannam@50 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>
cannam@50 770
cannam@50 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>
cannam@0 772
cannam@0 773 </div>
cannam@50 774 </div>
cannam@50 775 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="AmplitudeFollower::getMinChannelCount" ref="a267b42e866df3cf0d190893e8096f525" args="() const " -->
cannam@0 776 <div class="memitem">
cannam@0 777 <div class="memproto">
cannam@0 778 <table class="memname">
cannam@0 779 <tr>
cannam@50 780 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
cannam@0 781 <td>(</td>
cannam@50 782 <td class="paramname"></td><td>)</td>
cannam@21 783 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 784 </tr>
cannam@0 785 </table>
cannam@0 786 </div>
cannam@0 787 <div class="memdoc">
cannam@0 788
cannam@50 789 <p>Get the minimum supported number of input channels. </p>
cannam@0 790
cannam@50 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>
cannam@0 792
cannam@50 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>
cannam@0 794
cannam@50 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>
cannam@0 796
cannam@0 797 </div>
cannam@50 798 </div>
cannam@50 799 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="AmplitudeFollower::getMaxChannelCount" ref="a2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
cannam@0 800 <div class="memitem">
cannam@0 801 <div class="memproto">
cannam@0 802 <table class="memname">
cannam@0 803 <tr>
cannam@50 804 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
cannam@0 805 <td>(</td>
cannam@50 806 <td class="paramname"></td><td>)</td>
cannam@21 807 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 808 </tr>
cannam@0 809 </table>
cannam@0 810 </div>
cannam@0 811 <div class="memdoc">
cannam@0 812
cannam@50 813 <p>Get the maximum supported number of input channels. </p>
cannam@0 814
cannam@50 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>
cannam@0 816
cannam@50 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>
cannam@0 818
cannam@50 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>
cannam@0 820
cannam@0 821 </div>
cannam@50 822 </div>
cannam@50 823 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="AmplitudeFollower::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
cannam@0 824 <div class="memitem">
cannam@0 825 <div class="memproto">
cannam@0 826 <table class="memname">
cannam@0 827 <tr>
cannam@50 828 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
cannam@0 829 <td>(</td>
cannam@50 830 <td class="paramname"></td><td>)</td>
cannam@21 831 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 832 </tr>
cannam@0 833 </table>
cannam@0 834 </div>
cannam@0 835 <div class="memdoc">
cannam@0 836
cannam@50 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>
cannam@50 838 <p>Do not reimplement this function in your subclass. </p>
cannam@0 839
cannam@50 840 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
cannam@50 841
cannam@50 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>
cannam@0 843
cannam@0 844 </div>
cannam@50 845 </div>
cannam@50 846 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="AmplitudeFollower::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
cannam@0 847 <div class="memitem">
cannam@0 848 <div class="memproto">
cannam@0 849 <table class="memname">
cannam@0 850 <tr>
cannam@50 851 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
cannam@0 852 <td>(</td>
cannam@50 853 <td class="paramname"></td><td>)</td>
cannam@21 854 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 855 </tr>
cannam@0 856 </table>
cannam@0 857 </div>
cannam@0 858 <div class="memdoc">
cannam@0 859
cannam@50 860 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
cannam@0 861
cannam@50 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>
cannam@0 863
cannam@50 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>
cannam@0 865
cannam@50 866 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
cannam@0 867
cannam@0 868 </div>
cannam@50 869 </div>
cannam@50 870 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="AmplitudeFollower::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
cannam@0 871 <div class="memitem">
cannam@0 872 <div class="memproto">
cannam@0 873 <table class="memname">
cannam@0 874 <tr>
cannam@50 875 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
cannam@0 876 <td>(</td>
cannam@50 877 <td class="paramname"></td><td>)</td>
cannam@21 878 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 879 </tr>
cannam@0 880 </table>
cannam@0 881 </div>
cannam@0 882 <div class="memdoc">
cannam@0 883
cannam@50 884 <p>Get the program settings available in this plugin. </p>
cannam@50 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>
cannam@50 886 <p>The programs must have unique names. </p>
cannam@0 887
cannam@50 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>
cannam@50 889
cannam@50 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>
cannam@0 891
cannam@0 892 </div>
cannam@50 893 </div>
cannam@50 894 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="AmplitudeFollower::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
cannam@0 895 <div class="memitem">
cannam@0 896 <div class="memproto">
cannam@0 897 <table class="memname">
cannam@0 898 <tr>
cannam@50 899 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
cannam@0 900 <td>(</td>
cannam@50 901 <td class="paramname"></td><td>)</td>
cannam@21 902 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 903 </tr>
cannam@0 904 </table>
cannam@0 905 </div>
cannam@0 906 <div class="memdoc">
cannam@0 907
cannam@50 908 <p>Get the current program. </p>
cannam@0 909
cannam@50 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>
cannam@0 911
cannam@50 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>
cannam@0 913
cannam@0 914 </div>
cannam@50 915 </div>
cannam@50 916 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="AmplitudeFollower::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" -->
cannam@0 917 <div class="memitem">
cannam@0 918 <div class="memproto">
cannam@0 919 <table class="memname">
cannam@0 920 <tr>
cannam@50 921 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
cannam@0 922 <td>(</td>
cannam@50 923 <td class="paramtype">std::string&#160;</td>
cannam@50 924 <td class="paramname"></td><td>)</td>
cannam@21 925 <td><code> [inline, virtual, inherited]</code></td>
cannam@0 926 </tr>
cannam@0 927 </table>
cannam@0 928 </div>
cannam@0 929 <div class="memdoc">
cannam@0 930
cannam@50 931 <p>Select a program. </p>
cannam@50 932 <p>(If the given program name is not one of the available programs, do nothing.) </p>
cannam@0 933
cannam@50 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>
cannam@50 935
cannam@50 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>
cannam@0 937
cannam@0 938 </div>
cannam@50 939 </div>
cannam@50 940 <hr/><h2>Member Data Documentation</h2>
cannam@50 941 <a class="anchor" id="a959c2647fd3c5feea2591e3618774027"></a><!-- doxytag: member="AmplitudeFollower::m_stepSize" ref="a959c2647fd3c5feea2591e3618774027" args="" -->
cannam@0 942 <div class="memitem">
cannam@0 943 <div class="memproto">
cannam@0 944 <table class="memname">
cannam@0 945 <tr>
cannam@50 946 <td class="memname">size_t <a class="el" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">AmplitudeFollower::m_stepSize</a><code> [protected]</code></td>
cannam@0 947 </tr>
cannam@0 948 </table>
cannam@0 949 </div>
cannam@0 950 <div class="memdoc">
cannam@0 951
cannam@50 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>
cannam@0 953
cannam@50 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>
cannam@0 955
cannam@0 956 </div>
cannam@50 957 </div>
cannam@50 958 <a class="anchor" id="ac95e8d2f334821c6c92c706bae29695a"></a><!-- doxytag: member="AmplitudeFollower::m_previn" ref="ac95e8d2f334821c6c92c706bae29695a" args="" -->
cannam@0 959 <div class="memitem">
cannam@0 960 <div class="memproto">
cannam@0 961 <table class="memname">
cannam@0 962 <tr>
cannam@50 963 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">AmplitudeFollower::m_previn</a><code> [protected]</code></td>
cannam@0 964 </tr>
cannam@0 965 </table>
cannam@0 966 </div>
cannam@0 967 <div class="memdoc">
cannam@0 968
cannam@50 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>
cannam@0 970
cannam@50 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>
cannam@0 972
cannam@0 973 </div>
cannam@50 974 </div>
cannam@50 975 <a class="anchor" id="a1cb205b08cfe2ce94a4af05b18f72876"></a><!-- doxytag: member="AmplitudeFollower::m_clampcoef" ref="a1cb205b08cfe2ce94a4af05b18f72876" args="" -->
cannam@0 976 <div class="memitem">
cannam@0 977 <div class="memproto">
cannam@0 978 <table class="memname">
cannam@0 979 <tr>
cannam@50 980 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">AmplitudeFollower::m_clampcoef</a><code> [protected]</code></td>
cannam@0 981 </tr>
cannam@0 982 </table>
cannam@0 983 </div>
cannam@0 984 <div class="memdoc">
cannam@0 985
cannam@50 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>
cannam@0 987
cannam@50 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>
cannam@0 989
cannam@0 990 </div>
cannam@50 991 </div>
cannam@50 992 <a class="anchor" id="aceecd3b3879f32eb4a2e597c32c41cfc"></a><!-- doxytag: member="AmplitudeFollower::m_relaxcoef" ref="aceecd3b3879f32eb4a2e597c32c41cfc" args="" -->
cannam@0 993 <div class="memitem">
cannam@0 994 <div class="memproto">
cannam@0 995 <table class="memname">
cannam@0 996 <tr>
cannam@50 997 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">AmplitudeFollower::m_relaxcoef</a><code> [protected]</code></td>
cannam@0 998 </tr>
cannam@0 999 </table>
cannam@0 1000 </div>
cannam@0 1001 <div class="memdoc">
cannam@0 1002
cannam@50 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>
cannam@0 1004
cannam@50 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>
cannam@0 1006
cannam@0 1007 </div>
cannam@50 1008 </div>
cannam@50 1009 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="AmplitudeFollower::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
cannam@0 1010 <div class="memitem">
cannam@0 1011 <div class="memproto">
cannam@0 1012 <table class="memname">
cannam@0 1013 <tr>
cannam@50 1014 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
cannam@0 1015 </tr>
cannam@0 1016 </table>
cannam@0 1017 </div>
cannam@0 1018 <div class="memdoc">
cannam@0 1019
cannam@50 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>
cannam@0 1021
cannam@50 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>
cannam@0 1023
cannam@0 1024 </div>
cannam@0 1025 </div>
cannam@50 1026 <hr/>The documentation for this class was generated from the following files:<ul>
cannam@50 1027 <li><a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a></li>
cannam@50 1028 <li><a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a></li>
cannam@50 1029 </ul>
cannam@50 1030 </div>
cannam@50 1031 </div>
cannam@50 1032 <div id="nav-path" class="navpath">
cannam@50 1033 <ul>
cannam@50 1034 <li class="navelem"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> </li>
cannam@50 1035
cannam@50 1036 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
cannam@50 1037 <a href="http://www.doxygen.org/index.html">
cannam@50 1038 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
cannam@50 1039 </ul>
cannam@50 1040 </div>
cannam@50 1041
cannam@50 1042
cannam@0 1043 </body>
cannam@0 1044 </html>