Mercurial > hg > vamp-docs

annotate code-docs/classAmplitudeFollower.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@1 8 <title>VampPluginSDK: AmplitudeFollower Class Reference</title>
Chris@1 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@1 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@1 15 <script type="text/javascript" src="navtree.js"></script>
Chris@1 16 <script type="text/javascript">
Chris@1 17 $(document).ready(initResizable);
Chris@1 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 20 </head>
Chris@1 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@1 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@1 30 </div>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </tbody>
Chris@1 34 </table>
Chris@1 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@1 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 48 <div id="nav-tree">
Chris@1 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@1 51 </div>
Chris@1 52 </div>
Chris@1 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 54 class="ui-resizable-handle">
Chris@1 55 </div>
Chris@1 56 </div>
Chris@1 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('classAmplitudeFollower.html','');});
Chris@1 59 </script>
Chris@1 60 <div id="doc-content">
Chris@1 61 <div class="header">
Chris@1 62 <div class="summary">
Chris@1 63 <a href="#pub-types">Public Types</a> &#124;
Chris@1 64 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@6 65 <a href="#pro-attribs">Protected Attributes</a> &#124;
Chris@6 66 <a href="classAmplitudeFollower-members.html">List of all members</a> </div>
Chris@1 67 <div class="headertitle">
Chris@1 68 <div class="title">AmplitudeFollower Class Reference</div> </div>
Chris@3 69 </div><!--header-->
Chris@1 70 <div class="contents">
Chris@3 71
Chris@1 72 <p>Example plugin implementing the SuperCollider amplitude follower function.
Chris@1 73 <a href="classAmplitudeFollower.html#details">More...</a></p>
Chris@1 74
Chris@1 75 <p><code>#include &lt;<a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>&gt;</code></p>
Chris@1 76 <div class="dynheader">
Chris@1 77 Inheritance diagram for AmplitudeFollower:</div>
Chris@1 78 <div class="dyncontent">
Chris@1 79 <div class="center"><img src="classAmplitudeFollower__inherit__graph.png" border="0" usemap="#AmplitudeFollower_inherit__map" alt="Inheritance graph"/></div>
Chris@1 80 <map name="AmplitudeFollower_inherit__map" id="AmplitudeFollower_inherit__map">
Chris@6 81 <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="20,79,115,104"/>
Chris@6 82 <area shape="rect" id="node3" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. " alt="" coords="6,5,129,31"/>
Chris@6 83 </map>
Chris@1 84 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
Chris@1 85 <table class="memberdecls">
Chris@6 86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Chris@1 87 Public Types</h2></td></tr>
Chris@3 88 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
Chris@1 89 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
Chris@1 90 }</td></tr>
Chris@6 91 <tr class="separator:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 92 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
Chris@6 93 <tr class="separator:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 94 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
Chris@6 95 <tr class="separator:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 96 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
Chris@6 97 <tr class="separator:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 98 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
Chris@6 99 <tr class="separator:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 100 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
Chris@6 101 <tr class="separator:a7f66f00437b21e5f694fe02356b12f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 102 </table><table class="memberdecls">
Chris@6 103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Chris@1 104 Public Member Functions</h2></td></tr>
Chris@3 105 <tr class="memitem:a29eaeffc353da2614ae508abcd0ab63f"><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>
Chris@6 106 <tr class="memdesc:a29eaeffc353da2614ae508abcd0ab63f"><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">More...</a><br /></td></tr>
Chris@6 107 <tr class="separator:a29eaeffc353da2614ae508abcd0ab63f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 108 <tr class="memitem:aa78f98539ad3a1b08691a99b32035b2d"><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>
Chris@6 109 <tr class="separator:aa78f98539ad3a1b08691a99b32035b2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 110 <tr class="memitem:aeb727e44ee8ad1aceb90964d20f8d90d"><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>
Chris@6 111 <tr class="memdesc:aeb727e44ee8ad1aceb90964d20f8d90d"><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">More...</a><br /></td></tr>
Chris@6 112 <tr class="separator:aeb727e44ee8ad1aceb90964d20f8d90d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 113 <tr class="memitem:acebd835e80e84669df078fbd7591d8f7"><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>
Chris@6 114 <tr class="memdesc:acebd835e80e84669df078fbd7591d8f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#acebd835e80e84669df078fbd7591d8f7">More...</a><br /></td></tr>
Chris@6 115 <tr class="separator:acebd835e80e84669df078fbd7591d8f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 116 <tr class="memitem:aa11a470900da2b800b3ab118ae81f69e"><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#aa11a470900da2b800b3ab118ae81f69e">getInputDomain</a> () const</td></tr>
Chris@6 117 <tr class="memdesc:aa11a470900da2b800b3ab118ae81f69e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#aa11a470900da2b800b3ab118ae81f69e">More...</a><br /></td></tr>
Chris@6 118 <tr class="separator:aa11a470900da2b800b3ab118ae81f69e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 119 <tr class="memitem:ad77b59b8e8bc0f415edab073f2e5edef"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ad77b59b8e8bc0f415edab073f2e5edef">getIdentifier</a> () const</td></tr>
Chris@6 120 <tr class="memdesc:ad77b59b8e8bc0f415edab073f2e5edef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ad77b59b8e8bc0f415edab073f2e5edef">More...</a><br /></td></tr>
Chris@6 121 <tr class="separator:ad77b59b8e8bc0f415edab073f2e5edef"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 122 <tr class="memitem:a4a4ea5c0b2e30b420646aa78571176c2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a4a4ea5c0b2e30b420646aa78571176c2">getName</a> () const</td></tr>
Chris@6 123 <tr class="memdesc:a4a4ea5c0b2e30b420646aa78571176c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a4a4ea5c0b2e30b420646aa78571176c2">More...</a><br /></td></tr>
Chris@6 124 <tr class="separator:a4a4ea5c0b2e30b420646aa78571176c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 125 <tr class="memitem:aad780ea62291ef94925d6f4d1cc3f4ac"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aad780ea62291ef94925d6f4d1cc3f4ac">getDescription</a> () const</td></tr>
Chris@6 126 <tr class="memdesc:aad780ea62291ef94925d6f4d1cc3f4ac"><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="#aad780ea62291ef94925d6f4d1cc3f4ac">More...</a><br /></td></tr>
Chris@6 127 <tr class="separator:aad780ea62291ef94925d6f4d1cc3f4ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 128 <tr class="memitem:ac7a9db3ec7daa0e9bd83106bbf641777"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ac7a9db3ec7daa0e9bd83106bbf641777">getMaker</a> () const</td></tr>
Chris@6 129 <tr class="memdesc:ac7a9db3ec7daa0e9bd83106bbf641777"><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="#ac7a9db3ec7daa0e9bd83106bbf641777">More...</a><br /></td></tr>
Chris@6 130 <tr class="separator:ac7a9db3ec7daa0e9bd83106bbf641777"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 131 <tr class="memitem:ad84e40327cb36e470790af9619e8e80e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ad84e40327cb36e470790af9619e8e80e">getPluginVersion</a> () const</td></tr>
Chris@6 132 <tr class="memdesc:ad84e40327cb36e470790af9619e8e80e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#ad84e40327cb36e470790af9619e8e80e">More...</a><br /></td></tr>
Chris@6 133 <tr class="separator:ad84e40327cb36e470790af9619e8e80e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 134 <tr class="memitem:acd61ab359d1b7a5514fb2e1bc191f95a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#acd61ab359d1b7a5514fb2e1bc191f95a">getCopyright</a> () const</td></tr>
Chris@6 135 <tr class="memdesc:acd61ab359d1b7a5514fb2e1bc191f95a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#acd61ab359d1b7a5514fb2e1bc191f95a">More...</a><br /></td></tr>
Chris@6 136 <tr class="separator:acd61ab359d1b7a5514fb2e1bc191f95a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 137 <tr class="memitem:a3e7f3c93c66f161e9b37e7f2aff1fe60"><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#a3e7f3c93c66f161e9b37e7f2aff1fe60">getOutputDescriptors</a> () const</td></tr>
Chris@6 138 <tr class="memdesc:a3e7f3c93c66f161e9b37e7f2aff1fe60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a3e7f3c93c66f161e9b37e7f2aff1fe60">More...</a><br /></td></tr>
Chris@6 139 <tr class="separator:a3e7f3c93c66f161e9b37e7f2aff1fe60"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 140 <tr class="memitem:a4a707648d17d03a66b110b73b99e821b"><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#a4a707648d17d03a66b110b73b99e821b">getParameterDescriptors</a> () const</td></tr>
Chris@6 141 <tr class="memdesc:a4a707648d17d03a66b110b73b99e821b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a4a707648d17d03a66b110b73b99e821b">More...</a><br /></td></tr>
Chris@6 142 <tr class="separator:a4a707648d17d03a66b110b73b99e821b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 143 <tr class="memitem:a93f32b68462f46af5265327a69479c38"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a93f32b68462f46af5265327a69479c38">getParameter</a> (std::string paramid) const</td></tr>
Chris@6 144 <tr class="memdesc:a93f32b68462f46af5265327a69479c38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a93f32b68462f46af5265327a69479c38">More...</a><br /></td></tr>
Chris@6 145 <tr class="separator:a93f32b68462f46af5265327a69479c38"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 146 <tr class="memitem:ae1fc37ece4d20e40f3066a3361a99340"><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>
Chris@6 147 <tr class="memdesc:ae1fc37ece4d20e40f3066a3361a99340"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#ae1fc37ece4d20e40f3066a3361a99340">More...</a><br /></td></tr>
Chris@6 148 <tr class="separator:ae1fc37ece4d20e40f3066a3361a99340"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 149 <tr class="memitem:a48d0f95cac31ffd190cff89b50a2a5bd"><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>
Chris@6 150 <tr class="memdesc:a48d0f95cac31ffd190cff89b50a2a5bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a48d0f95cac31ffd190cff89b50a2a5bd">More...</a><br /></td></tr>
Chris@6 151 <tr class="separator:a48d0f95cac31ffd190cff89b50a2a5bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 152 <tr class="memitem:a368606f643b88e0df0823d85e36f030c"><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>
Chris@6 153 <tr class="memdesc:a368606f643b88e0df0823d85e36f030c"><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">More...</a><br /></td></tr>
Chris@6 154 <tr class="separator:a368606f643b88e0df0823d85e36f030c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 155 <tr class="memitem:ae3b9c32b12796ece152388babad7cc7d"><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#ae3b9c32b12796ece152388babad7cc7d">getPreferredBlockSize</a> () const</td></tr>
Chris@6 156 <tr class="memdesc:ae3b9c32b12796ece152388babad7cc7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size &ndash; 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="#ae3b9c32b12796ece152388babad7cc7d">More...</a><br /></td></tr>
Chris@6 157 <tr class="separator:ae3b9c32b12796ece152388babad7cc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 158 <tr class="memitem:a33eaf9a265bc3a055e156452112456c2"><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#a33eaf9a265bc3a055e156452112456c2">getPreferredStepSize</a> () const</td></tr>
Chris@6 159 <tr class="memdesc:a33eaf9a265bc3a055e156452112456c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment &ndash; 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="#a33eaf9a265bc3a055e156452112456c2">More...</a><br /></td></tr>
Chris@6 160 <tr class="separator:a33eaf9a265bc3a055e156452112456c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 161 <tr class="memitem:ab74f7634c6ac6e3da115667808a79c30"><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#ab74f7634c6ac6e3da115667808a79c30">getMinChannelCount</a> () const</td></tr>
Chris@6 162 <tr class="memdesc:ab74f7634c6ac6e3da115667808a79c30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#ab74f7634c6ac6e3da115667808a79c30">More...</a><br /></td></tr>
Chris@6 163 <tr class="separator:ab74f7634c6ac6e3da115667808a79c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 164 <tr class="memitem:a0bff9464bc8c117470136c396b2405dd"><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#a0bff9464bc8c117470136c396b2405dd">getMaxChannelCount</a> () const</td></tr>
Chris@6 165 <tr class="memdesc:a0bff9464bc8c117470136c396b2405dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a0bff9464bc8c117470136c396b2405dd">More...</a><br /></td></tr>
Chris@6 166 <tr class="separator:a0bff9464bc8c117470136c396b2405dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 167 <tr class="memitem:a530123068767a8728c568ffccfe3e4e5"><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#a530123068767a8728c568ffccfe3e4e5">getType</a> () const</td></tr>
Chris@6 168 <tr class="memdesc:a530123068767a8728c568ffccfe3e4e5"><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="#a530123068767a8728c568ffccfe3e4e5">More...</a><br /></td></tr>
Chris@6 169 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 170 <tr class="memitem:ab4aa9c3e6f6dd9addbc095463c9fb772"><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#ab4aa9c3e6f6dd9addbc095463c9fb772">getVampApiVersion</a> () const</td></tr>
Chris@6 171 <tr class="memdesc:ab4aa9c3e6f6dd9addbc095463c9fb772"><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="#ab4aa9c3e6f6dd9addbc095463c9fb772">More...</a><br /></td></tr>
Chris@6 172 <tr class="separator:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 173 <tr class="memitem:aaf6febff0ab4daf4a5089c98a67f4df8"><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#aaf6febff0ab4daf4a5089c98a67f4df8">getPrograms</a> () const</td></tr>
Chris@6 174 <tr class="memdesc:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#aaf6febff0ab4daf4a5089c98a67f4df8">More...</a><br /></td></tr>
Chris@6 175 <tr class="separator:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 176 <tr class="memitem:aac38c5dc6e87208616122897518ca3d5"><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#aac38c5dc6e87208616122897518ca3d5">getCurrentProgram</a> () const</td></tr>
Chris@6 177 <tr class="memdesc:aac38c5dc6e87208616122897518ca3d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#aac38c5dc6e87208616122897518ca3d5">More...</a><br /></td></tr>
Chris@6 178 <tr class="separator:aac38c5dc6e87208616122897518ca3d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 179 <tr class="memitem:aadd3a547ef140bae200473a9518e3353"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
Chris@6 180 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353">More...</a><br /></td></tr>
Chris@6 181 <tr class="separator:aadd3a547ef140bae200473a9518e3353"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 182 </table><table class="memberdecls">
Chris@6 183 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Chris@1 184 Protected Attributes</h2></td></tr>
Chris@3 185 <tr class="memitem:a959c2647fd3c5feea2591e3618774027"><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>
Chris@6 186 <tr class="separator:a959c2647fd3c5feea2591e3618774027"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 187 <tr class="memitem:ac95e8d2f334821c6c92c706bae29695a"><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>
Chris@6 188 <tr class="separator:ac95e8d2f334821c6c92c706bae29695a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 189 <tr class="memitem:a1cb205b08cfe2ce94a4af05b18f72876"><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>
Chris@6 190 <tr class="separator:a1cb205b08cfe2ce94a4af05b18f72876"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 191 <tr class="memitem:aceecd3b3879f32eb4a2e597c32c41cfc"><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>
Chris@6 192 <tr class="separator:aceecd3b3879f32eb4a2e597c32c41cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 193 <tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
Chris@6 194 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 195 </table>
Chris@6 196 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Chris@1 197 <div class="textblock"><p>Example plugin implementing the SuperCollider amplitude follower function. </p>
Chris@1 198
Chris@6 199 <p class="definition">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>
Chris@6 200 </div><h2 class="groupheader">Member Typedef Documentation</h2>
Chris@6 201 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
Chris@6 202 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
Chris@6 203
Chris@6 204 <div class="memitem">
Chris@6 205 <div class="memproto">
Chris@6 206 <table class="mlabels">
Chris@6 207 <tr>
Chris@6 208 <td class="mlabels-left">
Chris@6 209 <table class="memname">
Chris@6 210 <tr>
Chris@6 211 <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></td>
Chris@6 212 </tr>
Chris@6 213 </table>
Chris@6 214 </td>
Chris@6 215 <td class="mlabels-right">
Chris@6 216 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 217 </tr>
Chris@6 218 </table>
Chris@6 219 </div><div class="memdoc">
Chris@6 220
Chris@6 221 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00335">335</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 222
Chris@6 223 </div>
Chris@6 224 </div>
Chris@6 225 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
Chris@6 226 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
Chris@6 227
Chris@6 228 <div class="memitem">
Chris@6 229 <div class="memproto">
Chris@6 230 <table class="mlabels">
Chris@6 231 <tr>
Chris@6 232 <td class="mlabels-left">
Chris@6 233 <table class="memname">
Chris@6 234 <tr>
Chris@6 235 <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></td>
Chris@6 236 </tr>
Chris@6 237 </table>
Chris@6 238 </td>
Chris@6 239 <td class="mlabels-right">
Chris@6 240 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 241 </tr>
Chris@6 242 </table>
Chris@6 243 </div><div class="memdoc">
Chris@6 244
Chris@6 245 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00393">393</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 246
Chris@6 247 </div>
Chris@6 248 </div>
Chris@6 249 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
Chris@6 250 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
Chris@6 251
Chris@6 252 <div class="memitem">
Chris@6 253 <div class="memproto">
Chris@6 254 <table class="mlabels">
Chris@6 255 <tr>
Chris@6 256 <td class="mlabels-left">
Chris@6 257 <table class="memname">
Chris@6 258 <tr>
Chris@6 259 <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></td>
Chris@6 260 </tr>
Chris@6 261 </table>
Chris@6 262 </td>
Chris@6 263 <td class="mlabels-right">
Chris@6 264 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 265 </tr>
Chris@6 266 </table>
Chris@6 267 </div><div class="memdoc">
Chris@6 268
Chris@6 269 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00395">395</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 270
Chris@6 271 </div>
Chris@6 272 </div>
Chris@6 273 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
Chris@6 274 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
Chris@6 275
Chris@6 276 <div class="memitem">
Chris@6 277 <div class="memproto">
Chris@6 278 <table class="mlabels">
Chris@6 279 <tr>
Chris@6 280 <td class="mlabels-left">
Chris@6 281 <table class="memname">
Chris@6 282 <tr>
Chris@6 283 <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></td>
Chris@6 284 </tr>
Chris@6 285 </table>
Chris@6 286 </td>
Chris@6 287 <td class="mlabels-right">
Chris@6 288 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 289 </tr>
Chris@6 290 </table>
Chris@6 291 </div><div class="memdoc">
Chris@6 292
Chris@6 293 <p class="definition">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>
Chris@6 294
Chris@6 295 </div>
Chris@6 296 </div>
Chris@6 297 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
Chris@6 298 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
Chris@6 299
Chris@6 300 <div class="memitem">
Chris@6 301 <div class="memproto">
Chris@6 302 <table class="mlabels">
Chris@6 303 <tr>
Chris@6 304 <td class="mlabels-left">
Chris@6 305 <table class="memname">
Chris@6 306 <tr>
Chris@6 307 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
Chris@6 308 </tr>
Chris@6 309 </table>
Chris@6 310 </td>
Chris@6 311 <td class="mlabels-right">
Chris@6 312 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 313 </tr>
Chris@6 314 </table>
Chris@6 315 </div><div class="memdoc">
Chris@6 316
Chris@6 317 <p class="definition">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>
Chris@6 318
Chris@6 319 </div>
Chris@6 320 </div>
Chris@6 321 <h2 class="groupheader">Member Enumeration Documentation</h2>
Chris@6 322 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
Chris@6 323 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
Chris@6 324
Chris@6 325 <div class="memitem">
Chris@6 326 <div class="memproto">
Chris@6 327 <table class="mlabels">
Chris@6 328 <tr>
Chris@6 329 <td class="mlabels-left">
Chris@6 330 <table class="memname">
Chris@6 331 <tr>
Chris@6 332 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
Chris@6 333 </tr>
Chris@6 334 </table>
Chris@6 335 </td>
Chris@6 336 <td class="mlabels-right">
Chris@6 337 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 338 </tr>
Chris@6 339 </table>
Chris@6 340 </div><div class="memdoc">
Chris@6 341 <table class="fieldtable">
Chris@6 342 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain&#160;</td><td class="fielddoc"></td></tr>
Chris@6 343 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
Chris@6 344 </table>
Chris@6 345
Chris@6 346 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 347
Chris@6 348 </div>
Chris@6 349 </div>
Chris@6 350 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
Chris@6 351 <a id="a29eaeffc353da2614ae508abcd0ab63f"></a>
Chris@6 352 <h2 class="memtitle"><span class="permalink"><a href="#a29eaeffc353da2614ae508abcd0ab63f">&#9670;&nbsp;</a></span>AmplitudeFollower()</h2>
Chris@6 353
Chris@1 354 <div class="memitem">
Chris@1 355 <div class="memproto">
Chris@1 356 <table class="memname">
Chris@1 357 <tr>
Chris@6 358 <td class="memname">AmplitudeFollower::AmplitudeFollower </td>
Chris@1 359 <td>(</td>
Chris@1 360 <td class="paramtype">float&#160;</td>
Chris@1 361 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
Chris@1 362 <td></td>
Chris@1 363 </tr>
Chris@1 364 </table>
Chris@6 365 </div><div class="memdoc">
Chris@1 366
Chris@1 367 <p>An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. </p>
Chris@1 368
Chris@6 369 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00056">56</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 370
Chris@1 371 </div>
Chris@1 372 </div>
Chris@6 373 <a id="aa78f98539ad3a1b08691a99b32035b2d"></a>
Chris@6 374 <h2 class="memtitle"><span class="permalink"><a href="#aa78f98539ad3a1b08691a99b32035b2d">&#9670;&nbsp;</a></span>~AmplitudeFollower()</h2>
Chris@6 375
Chris@1 376 <div class="memitem">
Chris@1 377 <div class="memproto">
Chris@6 378 <table class="mlabels">
Chris@6 379 <tr>
Chris@6 380 <td class="mlabels-left">
Chris@1 381 <table class="memname">
Chris@1 382 <tr>
Chris@6 383 <td class="memname">AmplitudeFollower::~AmplitudeFollower </td>
Chris@1 384 <td>(</td>
Chris@1 385 <td class="paramname"></td><td>)</td>
Chris@6 386 <td></td>
Chris@1 387 </tr>
Chris@1 388 </table>
Chris@6 389 </td>
Chris@6 390 <td class="mlabels-right">
Chris@6 391 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 392 </tr>
Chris@6 393 </table>
Chris@6 394 </div><div class="memdoc">
Chris@1 395
Chris@6 396 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00065">65</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 397
Chris@1 398 </div>
Chris@1 399 </div>
Chris@6 400 <h2 class="groupheader">Member Function Documentation</h2>
Chris@6 401 <a id="aeb727e44ee8ad1aceb90964d20f8d90d"></a>
Chris@6 402 <h2 class="memtitle"><span class="permalink"><a href="#aeb727e44ee8ad1aceb90964d20f8d90d">&#9670;&nbsp;</a></span>initialise()</h2>
Chris@6 403
Chris@1 404 <div class="memitem">
Chris@1 405 <div class="memproto">
Chris@6 406 <table class="mlabels">
Chris@6 407 <tr>
Chris@6 408 <td class="mlabels-left">
Chris@1 409 <table class="memname">
Chris@1 410 <tr>
Chris@6 411 <td class="memname">bool AmplitudeFollower::initialise </td>
Chris@1 412 <td>(</td>
Chris@1 413 <td class="paramtype">size_t&#160;</td>
Chris@1 414 <td class="paramname"><em>inputChannels</em>, </td>
Chris@1 415 </tr>
Chris@1 416 <tr>
Chris@1 417 <td class="paramkey"></td>
Chris@1 418 <td></td>
Chris@1 419 <td class="paramtype">size_t&#160;</td>
Chris@1 420 <td class="paramname"><em>stepSize</em>, </td>
Chris@1 421 </tr>
Chris@1 422 <tr>
Chris@1 423 <td class="paramkey"></td>
Chris@1 424 <td></td>
Chris@1 425 <td class="paramtype">size_t&#160;</td>
Chris@1 426 <td class="paramname"><em>blockSize</em>&#160;</td>
Chris@1 427 </tr>
Chris@1 428 <tr>
Chris@1 429 <td></td>
Chris@1 430 <td>)</td>
Chris@6 431 <td></td><td></td>
Chris@1 432 </tr>
Chris@1 433 </table>
Chris@6 434 </td>
Chris@6 435 <td class="mlabels-right">
Chris@6 436 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 437 </tr>
Chris@6 438 </table>
Chris@6 439 </div><div class="memdoc">
Chris@1 440
Chris@1 441 <p>Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). </p>
Chris@1 442 <p>The input sample rate should have been already specified at construction time.</p>
Chris@1 443 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
Chris@1 444
Chris@1 445 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
Chris@1 446
Chris@6 447 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">106</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 448
Chris@6 449 <p class="reference">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#l00444">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>
Chris@1 450
Chris@1 451 </div>
Chris@1 452 </div>
Chris@6 453 <a id="acebd835e80e84669df078fbd7591d8f7"></a>
Chris@6 454 <h2 class="memtitle"><span class="permalink"><a href="#acebd835e80e84669df078fbd7591d8f7">&#9670;&nbsp;</a></span>reset()</h2>
Chris@6 455
Chris@1 456 <div class="memitem">
Chris@1 457 <div class="memproto">
Chris@6 458 <table class="mlabels">
Chris@6 459 <tr>
Chris@6 460 <td class="mlabels-left">
Chris@1 461 <table class="memname">
Chris@1 462 <tr>
Chris@6 463 <td class="memname">void AmplitudeFollower::reset </td>
Chris@1 464 <td>(</td>
Chris@1 465 <td class="paramname"></td><td>)</td>
Chris@6 466 <td></td>
Chris@1 467 </tr>
Chris@1 468 </table>
Chris@6 469 </td>
Chris@6 470 <td class="mlabels-right">
Chris@6 471 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 472 </tr>
Chris@6 473 </table>
Chris@6 474 </div><div class="memdoc">
Chris@1 475
Chris@1 476 <p>Reset the plugin after use, to prepare it for another clean run. </p>
Chris@1 477 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
Chris@1 478
Chris@1 479 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
Chris@1 480
Chris@6 481 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00123">123</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 482
Chris@6 483 <p class="reference">References <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>.</p>
Chris@1 484
Chris@1 485 </div>
Chris@1 486 </div>
Chris@6 487 <a id="aa11a470900da2b800b3ab118ae81f69e"></a>
Chris@6 488 <h2 class="memtitle"><span class="permalink"><a href="#aa11a470900da2b800b3ab118ae81f69e">&#9670;&nbsp;</a></span>getInputDomain()</h2>
Chris@6 489
Chris@1 490 <div class="memitem">
Chris@1 491 <div class="memproto">
Chris@6 492 <table class="mlabels">
Chris@6 493 <tr>
Chris@6 494 <td class="mlabels-left">
Chris@1 495 <table class="memname">
Chris@1 496 <tr>
Chris@6 497 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> AmplitudeFollower::getInputDomain </td>
Chris@1 498 <td>(</td>
Chris@1 499 <td class="paramname"></td><td>)</td>
Chris@6 500 <td> const</td>
Chris@1 501 </tr>
Chris@1 502 </table>
Chris@6 503 </td>
Chris@6 504 <td class="mlabels-right">
Chris@6 505 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
Chris@6 506 </tr>
Chris@6 507 </table>
Chris@6 508 </div><div class="memdoc">
Chris@1 509
Chris@1 510 <p>Get the plugin's required input domain. </p>
Chris@6 511 <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>
Chris@6 512 <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 &ndash; the host will either let the user do so, or will use a Hanning window. </p>
Chris@1 513
Chris@1 514 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
Chris@1 515
Chris@6 516 <p class="definition">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>
Chris@1 517
Chris@6 518 <p class="reference">References <a class="el" href="AmplitudeFollower_8cpp_source.html#l00100">getCopyright()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00082">getDescription()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00070">getIdentifier()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00088">getMaker()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00076">getName()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00189">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00149">getParameterDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00094">getPluginVersion()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00244">getRemainingFeatures()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00180">setParameter()</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p>
Chris@1 519
Chris@1 520 </div>
Chris@1 521 </div>
Chris@6 522 <a id="ad77b59b8e8bc0f415edab073f2e5edef"></a>
Chris@6 523 <h2 class="memtitle"><span class="permalink"><a href="#ad77b59b8e8bc0f415edab073f2e5edef">&#9670;&nbsp;</a></span>getIdentifier()</h2>
Chris@6 524
Chris@1 525 <div class="memitem">
Chris@1 526 <div class="memproto">
Chris@6 527 <table class="mlabels">
Chris@6 528 <tr>
Chris@6 529 <td class="mlabels-left">
Chris@1 530 <table class="memname">
Chris@1 531 <tr>
Chris@6 532 <td class="memname">string AmplitudeFollower::getIdentifier </td>
Chris@1 533 <td>(</td>
Chris@1 534 <td class="paramname"></td><td>)</td>
Chris@6 535 <td> const</td>
Chris@1 536 </tr>
Chris@1 537 </table>
Chris@6 538 </td>
Chris@6 539 <td class="mlabels-right">
Chris@6 540 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 541 </tr>
Chris@6 542 </table>
Chris@6 543 </div><div class="memdoc">
Chris@1 544
Chris@1 545 <p>Get the computer-usable name of the plugin. </p>
Chris@1 546 <p>This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.</p>
Chris@1 547 <p>This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).</p>
Chris@1 548 <p>Example: "zero_crossings" </p>
Chris@1 549
Chris@1 550 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
Chris@1 551
Chris@6 552 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00070">70</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@6 553
Chris@6 554 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 555
Chris@1 556 </div>
Chris@1 557 </div>
Chris@6 558 <a id="a4a4ea5c0b2e30b420646aa78571176c2"></a>
Chris@6 559 <h2 class="memtitle"><span class="permalink"><a href="#a4a4ea5c0b2e30b420646aa78571176c2">&#9670;&nbsp;</a></span>getName()</h2>
Chris@6 560
Chris@1 561 <div class="memitem">
Chris@1 562 <div class="memproto">
Chris@6 563 <table class="mlabels">
Chris@6 564 <tr>
Chris@6 565 <td class="mlabels-left">
Chris@1 566 <table class="memname">
Chris@1 567 <tr>
Chris@6 568 <td class="memname">string AmplitudeFollower::getName </td>
Chris@1 569 <td>(</td>
Chris@1 570 <td class="paramname"></td><td>)</td>
Chris@6 571 <td> const</td>
Chris@1 572 </tr>
Chris@1 573 </table>
Chris@6 574 </td>
Chris@6 575 <td class="mlabels-right">
Chris@6 576 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 577 </tr>
Chris@6 578 </table>
Chris@6 579 </div><div class="memdoc">
Chris@1 580
Chris@1 581 <p>Get a human-readable name or title of the plugin. </p>
Chris@1 582 <p>This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").</p>
Chris@1 583 <p>Example: "Zero Crossings" </p>
Chris@1 584
Chris@1 585 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
Chris@1 586
Chris@6 587 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00076">76</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@6 588
Chris@6 589 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 590
Chris@1 591 </div>
Chris@1 592 </div>
Chris@6 593 <a id="aad780ea62291ef94925d6f4d1cc3f4ac"></a>
Chris@6 594 <h2 class="memtitle"><span class="permalink"><a href="#aad780ea62291ef94925d6f4d1cc3f4ac">&#9670;&nbsp;</a></span>getDescription()</h2>
Chris@6 595
Chris@1 596 <div class="memitem">
Chris@1 597 <div class="memproto">
Chris@6 598 <table class="mlabels">
Chris@6 599 <tr>
Chris@6 600 <td class="mlabels-left">
Chris@1 601 <table class="memname">
Chris@1 602 <tr>
Chris@6 603 <td class="memname">string AmplitudeFollower::getDescription </td>
Chris@1 604 <td>(</td>
Chris@1 605 <td class="paramname"></td><td>)</td>
Chris@6 606 <td> const</td>
Chris@1 607 </tr>
Chris@1 608 </table>
Chris@6 609 </td>
Chris@6 610 <td class="mlabels-right">
Chris@6 611 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 612 </tr>
Chris@6 613 </table>
Chris@6 614 </div><div class="memdoc">
Chris@1 615
Chris@1 616 <p>Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p>
Chris@1 617 <p>May be empty if the name has said it all already.</p>
Chris@1 618 <p>Example: "Detect and count zero crossing points" </p>
Chris@1 619
Chris@1 620 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
Chris@1 621
Chris@6 622 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00082">82</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@6 623
Chris@6 624 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 625
Chris@1 626 </div>
Chris@1 627 </div>
Chris@6 628 <a id="ac7a9db3ec7daa0e9bd83106bbf641777"></a>
Chris@6 629 <h2 class="memtitle"><span class="permalink"><a href="#ac7a9db3ec7daa0e9bd83106bbf641777">&#9670;&nbsp;</a></span>getMaker()</h2>
Chris@6 630
Chris@1 631 <div class="memitem">
Chris@1 632 <div class="memproto">
Chris@6 633 <table class="mlabels">
Chris@6 634 <tr>
Chris@6 635 <td class="mlabels-left">
Chris@1 636 <table class="memname">
Chris@1 637 <tr>
Chris@6 638 <td class="memname">string AmplitudeFollower::getMaker </td>
Chris@1 639 <td>(</td>
Chris@1 640 <td class="paramname"></td><td>)</td>
Chris@6 641 <td> const</td>
Chris@1 642 </tr>
Chris@1 643 </table>
Chris@6 644 </td>
Chris@6 645 <td class="mlabels-right">
Chris@6 646 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 647 </tr>
Chris@6 648 </table>
Chris@6 649 </div><div class="memdoc">
Chris@1 650
Chris@1 651 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
Chris@1 652 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
Chris@1 653
Chris@1 654 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
Chris@1 655
Chris@6 656 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00088">88</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@6 657
Chris@6 658 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 659
Chris@1 660 </div>
Chris@1 661 </div>
Chris@6 662 <a id="ad84e40327cb36e470790af9619e8e80e"></a>
Chris@6 663 <h2 class="memtitle"><span class="permalink"><a href="#ad84e40327cb36e470790af9619e8e80e">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
Chris@6 664
Chris@1 665 <div class="memitem">
Chris@1 666 <div class="memproto">
Chris@6 667 <table class="mlabels">
Chris@6 668 <tr>
Chris@6 669 <td class="mlabels-left">
Chris@1 670 <table class="memname">
Chris@1 671 <tr>
Chris@6 672 <td class="memname">int AmplitudeFollower::getPluginVersion </td>
Chris@1 673 <td>(</td>
Chris@1 674 <td class="paramname"></td><td>)</td>
Chris@6 675 <td> const</td>
Chris@1 676 </tr>
Chris@1 677 </table>
Chris@6 678 </td>
Chris@6 679 <td class="mlabels-right">
Chris@6 680 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 681 </tr>
Chris@6 682 </table>
Chris@6 683 </div><div class="memdoc">
Chris@1 684
Chris@1 685 <p>Get the version number of the plugin. </p>
Chris@1 686
Chris@1 687 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
Chris@1 688
Chris@6 689 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00094">94</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@6 690
Chris@6 691 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 692
Chris@1 693 </div>
Chris@1 694 </div>
Chris@6 695 <a id="acd61ab359d1b7a5514fb2e1bc191f95a"></a>
Chris@6 696 <h2 class="memtitle"><span class="permalink"><a href="#acd61ab359d1b7a5514fb2e1bc191f95a">&#9670;&nbsp;</a></span>getCopyright()</h2>
Chris@6 697
Chris@1 698 <div class="memitem">
Chris@1 699 <div class="memproto">
Chris@6 700 <table class="mlabels">
Chris@6 701 <tr>
Chris@6 702 <td class="mlabels-left">
Chris@1 703 <table class="memname">
Chris@1 704 <tr>
Chris@6 705 <td class="memname">string AmplitudeFollower::getCopyright </td>
Chris@1 706 <td>(</td>
Chris@1 707 <td class="paramname"></td><td>)</td>
Chris@6 708 <td> const</td>
Chris@1 709 </tr>
Chris@1 710 </table>
Chris@6 711 </td>
Chris@6 712 <td class="mlabels-right">
Chris@6 713 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 714 </tr>
Chris@6 715 </table>
Chris@6 716 </div><div class="memdoc">
Chris@1 717
Chris@1 718 <p>Get the copyright statement or licensing summary for the plugin. </p>
Chris@1 719 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
Chris@1 720
Chris@1 721 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
Chris@1 722
Chris@6 723 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00100">100</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@6 724
Chris@6 725 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 726
Chris@1 727 </div>
Chris@1 728 </div>
Chris@6 729 <a id="a3e7f3c93c66f161e9b37e7f2aff1fe60"></a>
Chris@6 730 <h2 class="memtitle"><span class="permalink"><a href="#a3e7f3c93c66f161e9b37e7f2aff1fe60">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
Chris@6 731
Chris@1 732 <div class="memitem">
Chris@1 733 <div class="memproto">
Chris@6 734 <table class="mlabels">
Chris@6 735 <tr>
Chris@6 736 <td class="mlabels-left">
Chris@1 737 <table class="memname">
Chris@1 738 <tr>
Chris@6 739 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">AmplitudeFollower::OutputList</a> AmplitudeFollower::getOutputDescriptors </td>
Chris@1 740 <td>(</td>
Chris@1 741 <td class="paramname"></td><td>)</td>
Chris@6 742 <td> const</td>
Chris@1 743 </tr>
Chris@1 744 </table>
Chris@6 745 </td>
Chris@6 746 <td class="mlabels-right">
Chris@6 747 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 748 </tr>
Chris@6 749 </table>
Chris@6 750 </div><div class="memdoc">
Chris@1 751
Chris@1 752 <p>Get the outputs of this plugin. </p>
Chris@6 753 <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>
Chris@1 754
Chris@1 755 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
Chris@1 756
Chris@6 757 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">129</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 758
Chris@6 759 <p class="reference">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>
Chris@6 760
Chris@6 761 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 762
Chris@1 763 </div>
Chris@1 764 </div>
Chris@6 765 <a id="a4a707648d17d03a66b110b73b99e821b"></a>
Chris@6 766 <h2 class="memtitle"><span class="permalink"><a href="#a4a707648d17d03a66b110b73b99e821b">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
Chris@6 767
Chris@1 768 <div class="memitem">
Chris@1 769 <div class="memproto">
Chris@6 770 <table class="mlabels">
Chris@6 771 <tr>
Chris@6 772 <td class="mlabels-left">
Chris@1 773 <table class="memname">
Chris@1 774 <tr>
Chris@6 775 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">AmplitudeFollower::ParameterList</a> AmplitudeFollower::getParameterDescriptors </td>
Chris@1 776 <td>(</td>
Chris@1 777 <td class="paramname"></td><td>)</td>
Chris@6 778 <td> const</td>
Chris@1 779 </tr>
Chris@1 780 </table>
Chris@6 781 </td>
Chris@6 782 <td class="mlabels-right">
Chris@6 783 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 784 </tr>
Chris@6 785 </table>
Chris@6 786 </div><div class="memdoc">
Chris@1 787
Chris@1 788 <p>Get the controllable parameters of this plugin. </p>
Chris@1 789
Chris@6 790 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">Vamp::PluginBase</a>.</p>
Chris@1 791
Chris@6 792 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00149">149</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 793
Chris@6 794 <p class="reference">References <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00167">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00144">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00133">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00173">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00159">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00154">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00138">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00149">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p>
Chris@6 795
Chris@6 796 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 797
Chris@1 798 </div>
Chris@1 799 </div>
Chris@6 800 <a id="a93f32b68462f46af5265327a69479c38"></a>
Chris@6 801 <h2 class="memtitle"><span class="permalink"><a href="#a93f32b68462f46af5265327a69479c38">&#9670;&nbsp;</a></span>getParameter()</h2>
Chris@6 802
Chris@1 803 <div class="memitem">
Chris@1 804 <div class="memproto">
Chris@6 805 <table class="mlabels">
Chris@6 806 <tr>
Chris@6 807 <td class="mlabels-left">
Chris@1 808 <table class="memname">
Chris@1 809 <tr>
Chris@6 810 <td class="memname">float AmplitudeFollower::getParameter </td>
Chris@1 811 <td>(</td>
Chris@1 812 <td class="paramtype">std::string&#160;</td>
Chris@1 813 <td class="paramname"></td><td>)</td>
Chris@6 814 <td> const</td>
Chris@1 815 </tr>
Chris@1 816 </table>
Chris@6 817 </td>
Chris@6 818 <td class="mlabels-right">
Chris@6 819 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 820 </tr>
Chris@6 821 </table>
Chris@6 822 </div><div class="memdoc">
Chris@1 823
Chris@1 824 <p>Get the value of a named parameter. </p>
Chris@1 825 <p>The argument is the identifier field from that parameter's descriptor. </p>
Chris@1 826
Chris@6 827 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">Vamp::PluginBase</a>.</p>
Chris@1 828
Chris@6 829 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00189">189</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 830
Chris@6 831 <p class="reference">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>
Chris@6 832
Chris@6 833 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 834
Chris@1 835 </div>
Chris@1 836 </div>
Chris@6 837 <a id="ae1fc37ece4d20e40f3066a3361a99340"></a>
Chris@6 838 <h2 class="memtitle"><span class="permalink"><a href="#ae1fc37ece4d20e40f3066a3361a99340">&#9670;&nbsp;</a></span>setParameter()</h2>
Chris@6 839
Chris@1 840 <div class="memitem">
Chris@1 841 <div class="memproto">
Chris@6 842 <table class="mlabels">
Chris@6 843 <tr>
Chris@6 844 <td class="mlabels-left">
Chris@1 845 <table class="memname">
Chris@1 846 <tr>
Chris@6 847 <td class="memname">void AmplitudeFollower::setParameter </td>
Chris@1 848 <td>(</td>
Chris@1 849 <td class="paramtype">std::string&#160;</td>
Chris@1 850 <td class="paramname">, </td>
Chris@1 851 </tr>
Chris@1 852 <tr>
Chris@1 853 <td class="paramkey"></td>
Chris@1 854 <td></td>
Chris@1 855 <td class="paramtype">float&#160;</td>
Chris@1 856 <td class="paramname">&#160;</td>
Chris@1 857 </tr>
Chris@1 858 <tr>
Chris@1 859 <td></td>
Chris@1 860 <td>)</td>
Chris@6 861 <td></td><td></td>
Chris@1 862 </tr>
Chris@1 863 </table>
Chris@6 864 </td>
Chris@6 865 <td class="mlabels-right">
Chris@6 866 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 867 </tr>
Chris@6 868 </table>
Chris@6 869 </div><div class="memdoc">
Chris@1 870
Chris@1 871 <p>Set a named parameter. </p>
Chris@1 872 <p>The first argument is the identifier field from that parameter's descriptor. </p>
Chris@1 873
Chris@1 874 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
Chris@1 875
Chris@6 876 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00180">180</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 877
Chris@6 878 <p class="reference">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>
Chris@6 879
Chris@6 880 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 881
Chris@1 882 </div>
Chris@1 883 </div>
Chris@6 884 <a id="a48d0f95cac31ffd190cff89b50a2a5bd"></a>
Chris@6 885 <h2 class="memtitle"><span class="permalink"><a href="#a48d0f95cac31ffd190cff89b50a2a5bd">&#9670;&nbsp;</a></span>process()</h2>
Chris@6 886
Chris@1 887 <div class="memitem">
Chris@1 888 <div class="memproto">
Chris@6 889 <table class="mlabels">
Chris@6 890 <tr>
Chris@6 891 <td class="mlabels-left">
Chris@1 892 <table class="memname">
Chris@1 893 <tr>
Chris@6 894 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::process </td>
Chris@1 895 <td>(</td>
Chris@1 896 <td class="paramtype">const float *const *&#160;</td>
Chris@1 897 <td class="paramname"><em>inputBuffers</em>, </td>
Chris@1 898 </tr>
Chris@1 899 <tr>
Chris@1 900 <td class="paramkey"></td>
Chris@1 901 <td></td>
Chris@1 902 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
Chris@1 903 <td class="paramname"><em>timestamp</em>&#160;</td>
Chris@1 904 </tr>
Chris@1 905 <tr>
Chris@1 906 <td></td>
Chris@1 907 <td>)</td>
Chris@6 908 <td></td><td></td>
Chris@1 909 </tr>
Chris@1 910 </table>
Chris@6 911 </td>
Chris@6 912 <td class="mlabels-right">
Chris@6 913 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 914 </tr>
Chris@6 915 </table>
Chris@6 916 </div><div class="memdoc">
Chris@1 917
Chris@1 918 <p>Process a single block of input data. </p>
Chris@1 919 <p>If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp in this case will be the real time in seconds of the start of the supplied block of samples.</p>
Chris@1 920 <p>If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p>
Chris@1 921 <p>Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.) </p>
Chris@1 922
Chris@1 923 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
Chris@1 924
Chris@6 925 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">201</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@1 926
Chris@6 927 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00352">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#l00382">Vamp::Plugin::Feature::values</a>.</p>
Chris@6 928
Chris@6 929 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 930
Chris@1 931 </div>
Chris@1 932 </div>
Chris@6 933 <a id="a368606f643b88e0df0823d85e36f030c"></a>
Chris@6 934 <h2 class="memtitle"><span class="permalink"><a href="#a368606f643b88e0df0823d85e36f030c">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
Chris@6 935
Chris@1 936 <div class="memitem">
Chris@1 937 <div class="memproto">
Chris@6 938 <table class="mlabels">
Chris@6 939 <tr>
Chris@6 940 <td class="mlabels-left">
Chris@1 941 <table class="memname">
Chris@1 942 <tr>
Chris@6 943 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::getRemainingFeatures </td>
Chris@1 944 <td>(</td>
Chris@1 945 <td class="paramname"></td><td>)</td>
Chris@6 946 <td></td>
Chris@1 947 </tr>
Chris@1 948 </table>
Chris@6 949 </td>
Chris@6 950 <td class="mlabels-right">
Chris@6 951 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 952 </tr>
Chris@6 953 </table>
Chris@6 954 </div><div class="memdoc">
Chris@1 955
Chris@1 956 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
Chris@1 957
Chris@1 958 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
Chris@1 959
Chris@6 960 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00244">244</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
Chris@6 961
Chris@6 962 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 963
Chris@1 964 </div>
Chris@1 965 </div>
Chris@6 966 <a id="ae3b9c32b12796ece152388babad7cc7d"></a>
Chris@6 967 <h2 class="memtitle"><span class="permalink"><a href="#ae3b9c32b12796ece152388babad7cc7d">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
Chris@6 968
Chris@1 969 <div class="memitem">
Chris@1 970 <div class="memproto">
Chris@6 971 <table class="mlabels">
Chris@6 972 <tr>
Chris@6 973 <td class="mlabels-left">
Chris@1 974 <table class="memname">
Chris@1 975 <tr>
Chris@6 976 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
Chris@1 977 <td>(</td>
Chris@1 978 <td class="paramname"></td><td>)</td>
Chris@6 979 <td> const</td>
Chris@1 980 </tr>
Chris@1 981 </table>
Chris@6 982 </td>
Chris@6 983 <td class="mlabels-right">
Chris@6 984 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 985 </tr>
Chris@6 986 </table>
Chris@6 987 </div><div class="memdoc">
Chris@1 988
Chris@6 989 <p>Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data. ">process()</a> function). </p>
Chris@6 990 <p>This should be called before <a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). ">initialise()</a>.</p>
Chris@6 991 <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="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). ">initialise()</a> call. </p>
Chris@1 992
Chris@6 993 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a39dd1770dd0a737ff295d70082d86fd3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a030b94dc3af4228a518f860952148bdd">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a9ee8ecc8406f633c68e9aa1516700332">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a94f855a2cf674ccc2e7315484f706d68">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#a9a2706b057bb269531f5c2797c42ddf4">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#abacdc27486aab9b37d1a51e35e6a9444">PercussionOnsetDetector</a>.</p>
Chris@1 994
Chris@6 995 <p class="definition">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>
Chris@1 996
Chris@6 997 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
Chris@1 998
Chris@1 999 </div>
Chris@1 1000 </div>
Chris@6 1001 <a id="a33eaf9a265bc3a055e156452112456c2"></a>
Chris@6 1002 <h2 class="memtitle"><span class="permalink"><a href="#a33eaf9a265bc3a055e156452112456c2">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
Chris@6 1003
Chris@1 1004 <div class="memitem">
Chris@1 1005 <div class="memproto">
Chris@6 1006 <table class="mlabels">
Chris@6 1007 <tr>
Chris@6 1008 <td class="mlabels-left">
Chris@1 1009 <table class="memname">
Chris@1 1010 <tr>
Chris@6 1011 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
Chris@1 1012 <td>(</td>
Chris@1 1013 <td class="paramname"></td><td>)</td>
Chris@6 1014 <td> const</td>
Chris@1 1015 </tr>
Chris@1 1016 </table>
Chris@6 1017 </td>
Chris@6 1018 <td class="mlabels-right">
Chris@6 1019 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1020 </tr>
Chris@6 1021 </table>
Chris@6 1022 </div><div class="memdoc">
Chris@1 1023
Chris@6 1024 <p>Get the preferred step size (window increment &ndash; the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
Chris@6 1025 <p>This should be called before <a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). ">initialise()</a>.</p>
Chris@6 1026 <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="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). ">initialise()</a> call. </p>
Chris@1 1027
Chris@6 1028 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ac7b43a08f1b1f42ed871fd6962c570f4">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a344c85cc017c97bf4f0f144e7d6e0f42">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#acb6b82c61ebac4610a8b92f94cd50682">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#adf2ea98d6eeb0435c0c8d7cdc29fed7c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#ac7c25bbeeef013210f4ab808ad12b659">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a0ad851545302fc87e8226104584667a0">PercussionOnsetDetector</a>.</p>
Chris@1 1029
Chris@6 1030 <p class="definition">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>
Chris@1 1031
Chris@6 1032 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
Chris@1 1033
Chris@1 1034 </div>
Chris@1 1035 </div>
Chris@6 1036 <a id="ab74f7634c6ac6e3da115667808a79c30"></a>
Chris@6 1037 <h2 class="memtitle"><span class="permalink"><a href="#ab74f7634c6ac6e3da115667808a79c30">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
Chris@6 1038
Chris@1 1039 <div class="memitem">
Chris@1 1040 <div class="memproto">
Chris@6 1041 <table class="mlabels">
Chris@6 1042 <tr>
Chris@6 1043 <td class="mlabels-left">
Chris@1 1044 <table class="memname">
Chris@1 1045 <tr>
Chris@6 1046 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
Chris@1 1047 <td>(</td>
Chris@1 1048 <td class="paramname"></td><td>)</td>
Chris@6 1049 <td> const</td>
Chris@1 1050 </tr>
Chris@1 1051 </table>
Chris@6 1052 </td>
Chris@6 1053 <td class="mlabels-right">
Chris@6 1054 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1055 </tr>
Chris@6 1056 </table>
Chris@6 1057 </div><div class="memdoc">
Chris@1 1058
Chris@1 1059 <p>Get the minimum supported number of input channels. </p>
Chris@1 1060
Chris@6 1061 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8e7f62e03adea0321080839f6ef6c77b">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#abc0a4e6ce0ae9de39c40725de1f30d2f">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1062
Chris@6 1063 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1064
Chris@6 1065 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">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#l00106">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">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#l00268">runPlugin()</a>.</p>
Chris@1 1066
Chris@1 1067 </div>
Chris@1 1068 </div>
Chris@6 1069 <a id="a0bff9464bc8c117470136c396b2405dd"></a>
Chris@6 1070 <h2 class="memtitle"><span class="permalink"><a href="#a0bff9464bc8c117470136c396b2405dd">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
Chris@6 1071
Chris@1 1072 <div class="memitem">
Chris@1 1073 <div class="memproto">
Chris@6 1074 <table class="mlabels">
Chris@6 1075 <tr>
Chris@6 1076 <td class="mlabels-left">
Chris@1 1077 <table class="memname">
Chris@1 1078 <tr>
Chris@6 1079 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
Chris@1 1080 <td>(</td>
Chris@1 1081 <td class="paramname"></td><td>)</td>
Chris@6 1082 <td> const</td>
Chris@1 1083 </tr>
Chris@1 1084 </table>
Chris@6 1085 </td>
Chris@6 1086 <td class="mlabels-right">
Chris@6 1087 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1088 </tr>
Chris@6 1089 </table>
Chris@6 1090 </div><div class="memdoc">
Chris@1 1091
Chris@1 1092 <p>Get the maximum supported number of input channels. </p>
Chris@1 1093
Chris@6 1094 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a626ad6e35eb0f4ed93bc3c6d976cdca4">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#acfed040cd91e797ee89d077db22b4a97">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1095
Chris@6 1096 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1097
Chris@6 1098 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">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#l00106">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">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#l00268">runPlugin()</a>.</p>
Chris@1 1099
Chris@1 1100 </div>
Chris@1 1101 </div>
Chris@6 1102 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
Chris@6 1103 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
Chris@6 1104
Chris@1 1105 <div class="memitem">
Chris@1 1106 <div class="memproto">
Chris@6 1107 <table class="mlabels">
Chris@6 1108 <tr>
Chris@6 1109 <td class="mlabels-left">
Chris@1 1110 <table class="memname">
Chris@1 1111 <tr>
Chris@6 1112 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
Chris@1 1113 <td>(</td>
Chris@1 1114 <td class="paramname"></td><td>)</td>
Chris@6 1115 <td> const</td>
Chris@1 1116 </tr>
Chris@1 1117 </table>
Chris@6 1118 </td>
Chris@6 1119 <td class="mlabels-right">
Chris@6 1120 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1121 </tr>
Chris@6 1122 </table>
Chris@6 1123 </div><div class="memdoc">
Chris@1 1124
Chris@6 1125 <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 PluginBase. </p>
Chris@1 1126 <p>Do not reimplement this function in your subclass. </p>
Chris@1 1127
Chris@1 1128 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
Chris@1 1129
Chris@6 1130 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00438">438</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1131
Chris@1 1132 </div>
Chris@1 1133 </div>
Chris@6 1134 <a id="ab4aa9c3e6f6dd9addbc095463c9fb772"></a>
Chris@6 1135 <h2 class="memtitle"><span class="permalink"><a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
Chris@6 1136
Chris@1 1137 <div class="memitem">
Chris@1 1138 <div class="memproto">
Chris@6 1139 <table class="mlabels">
Chris@6 1140 <tr>
Chris@6 1141 <td class="mlabels-left">
Chris@1 1142 <table class="memname">
Chris@1 1143 <tr>
Chris@6 1144 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
Chris@1 1145 <td>(</td>
Chris@1 1146 <td class="paramname"></td><td>)</td>
Chris@6 1147 <td> const</td>
Chris@1 1148 </tr>
Chris@1 1149 </table>
Chris@6 1150 </td>
Chris@6 1151 <td class="mlabels-right">
Chris@6 1152 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1153 </tr>
Chris@6 1154 </table>
Chris@6 1155 </div><div class="memdoc">
Chris@1 1156
Chris@1 1157 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
Chris@1 1158
Chris@6 1159 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#adc708325d057516bd92d5ea1c0808dbc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#afa79272f991fb720ddd09784be1b3cb8">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1160
Chris@6 1161 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 1162
Chris@6 1163 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
Chris@1 1164
Chris@1 1165 </div>
Chris@1 1166 </div>
Chris@6 1167 <a id="aaf6febff0ab4daf4a5089c98a67f4df8"></a>
Chris@6 1168 <h2 class="memtitle"><span class="permalink"><a href="#aaf6febff0ab4daf4a5089c98a67f4df8">&#9670;&nbsp;</a></span>getPrograms()</h2>
Chris@6 1169
Chris@1 1170 <div class="memitem">
Chris@1 1171 <div class="memproto">
Chris@6 1172 <table class="mlabels">
Chris@6 1173 <tr>
Chris@6 1174 <td class="mlabels-left">
Chris@1 1175 <table class="memname">
Chris@1 1176 <tr>
Chris@6 1177 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
Chris@1 1178 <td>(</td>
Chris@1 1179 <td class="paramname"></td><td>)</td>
Chris@6 1180 <td> const</td>
Chris@1 1181 </tr>
Chris@1 1182 </table>
Chris@6 1183 </td>
Chris@6 1184 <td class="mlabels-right">
Chris@6 1185 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1186 </tr>
Chris@6 1187 </table>
Chris@6 1188 </div><div class="memdoc">
Chris@1 1189
Chris@1 1190 <p>Get the program settings available in this plugin. </p>
Chris@1 1191 <p>A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.</p>
Chris@1 1192 <p>The programs must have unique names. </p>
Chris@1 1193
Chris@6 1194 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a1e3c40e9b9d8dc876d2e732976950c4b">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa0b72ea17766266d20539f293ccae7c8">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1195
Chris@6 1196 <p class="definition">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>
Chris@1 1197
Chris@1 1198 </div>
Chris@1 1199 </div>
Chris@6 1200 <a id="aac38c5dc6e87208616122897518ca3d5"></a>
Chris@6 1201 <h2 class="memtitle"><span class="permalink"><a href="#aac38c5dc6e87208616122897518ca3d5">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
Chris@6 1202
Chris@1 1203 <div class="memitem">
Chris@1 1204 <div class="memproto">
Chris@6 1205 <table class="mlabels">
Chris@6 1206 <tr>
Chris@6 1207 <td class="mlabels-left">
Chris@1 1208 <table class="memname">
Chris@1 1209 <tr>
Chris@6 1210 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
Chris@1 1211 <td>(</td>
Chris@1 1212 <td class="paramname"></td><td>)</td>
Chris@6 1213 <td> const</td>
Chris@1 1214 </tr>
Chris@1 1215 </table>
Chris@6 1216 </td>
Chris@6 1217 <td class="mlabels-right">
Chris@6 1218 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1219 </tr>
Chris@6 1220 </table>
Chris@6 1221 </div><div class="memdoc">
Chris@1 1222
Chris@1 1223 <p>Get the current program. </p>
Chris@1 1224
Chris@6 1225 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#abf984c347c4dac9e4b01123498bfe68f">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a3936fe2c4b3c960dd244849a7c3320ad">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1226
Chris@6 1227 <p class="definition">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>
Chris@1 1228
Chris@1 1229 </div>
Chris@1 1230 </div>
Chris@6 1231 <a id="aadd3a547ef140bae200473a9518e3353"></a>
Chris@6 1232 <h2 class="memtitle"><span class="permalink"><a href="#aadd3a547ef140bae200473a9518e3353">&#9670;&nbsp;</a></span>selectProgram()</h2>
Chris@6 1233
Chris@1 1234 <div class="memitem">
Chris@1 1235 <div class="memproto">
Chris@6 1236 <table class="mlabels">
Chris@6 1237 <tr>
Chris@6 1238 <td class="mlabels-left">
Chris@1 1239 <table class="memname">
Chris@1 1240 <tr>
Chris@6 1241 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
Chris@1 1242 <td>(</td>
Chris@1 1243 <td class="paramtype">std::string&#160;</td>
Chris@1 1244 <td class="paramname"></td><td>)</td>
Chris@6 1245 <td></td>
Chris@1 1246 </tr>
Chris@1 1247 </table>
Chris@6 1248 </td>
Chris@6 1249 <td class="mlabels-right">
Chris@6 1250 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1251 </tr>
Chris@6 1252 </table>
Chris@6 1253 </div><div class="memdoc">
Chris@1 1254
Chris@1 1255 <p>Select a program. </p>
Chris@1 1256 <p>(If the given program name is not one of the available programs, do nothing.) </p>
Chris@1 1257
Chris@1 1258 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1259
Chris@6 1260 <p class="definition">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>
Chris@6 1261
Chris@6 1262 <p class="reference">References <a class="el" href="plugguard_8h_source.html#l00080">_VAMP_SDK_PLUGSPACE_END</a>.</p>
Chris@1 1263
Chris@1 1264 </div>
Chris@1 1265 </div>
Chris@6 1266 <h2 class="groupheader">Member Data Documentation</h2>
Chris@6 1267 <a id="a959c2647fd3c5feea2591e3618774027"></a>
Chris@6 1268 <h2 class="memtitle"><span class="permalink"><a href="#a959c2647fd3c5feea2591e3618774027">&#9670;&nbsp;</a></span>m_stepSize</h2>
Chris@6 1269
Chris@1 1270 <div class="memitem">
Chris@1 1271 <div class="memproto">
Chris@6 1272 <table class="mlabels">
Chris@6 1273 <tr>
Chris@6 1274 <td class="mlabels-left">
Chris@1 1275 <table class="memname">
Chris@1 1276 <tr>
Chris@6 1277 <td class="memname">size_t AmplitudeFollower::m_stepSize</td>
Chris@1 1278 </tr>
Chris@1 1279 </table>
Chris@6 1280 </td>
Chris@6 1281 <td class="mlabels-right">
Chris@6 1282 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1283 </tr>
Chris@6 1284 </table>
Chris@6 1285 </div><div class="memdoc">
Chris@1 1286
Chris@6 1287 <p class="definition">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>
Chris@1 1288
Chris@6 1289 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>.</p>
Chris@1 1290
Chris@1 1291 </div>
Chris@1 1292 </div>
Chris@6 1293 <a id="ac95e8d2f334821c6c92c706bae29695a"></a>
Chris@6 1294 <h2 class="memtitle"><span class="permalink"><a href="#ac95e8d2f334821c6c92c706bae29695a">&#9670;&nbsp;</a></span>m_previn</h2>
Chris@6 1295
Chris@1 1296 <div class="memitem">
Chris@1 1297 <div class="memproto">
Chris@6 1298 <table class="mlabels">
Chris@6 1299 <tr>
Chris@6 1300 <td class="mlabels-left">
Chris@1 1301 <table class="memname">
Chris@1 1302 <tr>
Chris@6 1303 <td class="memname">float AmplitudeFollower::m_previn</td>
Chris@1 1304 </tr>
Chris@1 1305 </table>
Chris@6 1306 </td>
Chris@6 1307 <td class="mlabels-right">
Chris@6 1308 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1309 </tr>
Chris@6 1310 </table>
Chris@6 1311 </div><div class="memdoc">
Chris@1 1312
Chris@6 1313 <p class="definition">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>
Chris@1 1314
Chris@6 1315 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00123">reset()</a>.</p>
Chris@1 1316
Chris@1 1317 </div>
Chris@1 1318 </div>
Chris@6 1319 <a id="a1cb205b08cfe2ce94a4af05b18f72876"></a>
Chris@6 1320 <h2 class="memtitle"><span class="permalink"><a href="#a1cb205b08cfe2ce94a4af05b18f72876">&#9670;&nbsp;</a></span>m_clampcoef</h2>
Chris@6 1321
Chris@1 1322 <div class="memitem">
Chris@1 1323 <div class="memproto">
Chris@6 1324 <table class="mlabels">
Chris@6 1325 <tr>
Chris@6 1326 <td class="mlabels-left">
Chris@1 1327 <table class="memname">
Chris@1 1328 <tr>
Chris@6 1329 <td class="memname">float AmplitudeFollower::m_clampcoef</td>
Chris@1 1330 </tr>
Chris@1 1331 </table>
Chris@6 1332 </td>
Chris@6 1333 <td class="mlabels-right">
Chris@6 1334 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1335 </tr>
Chris@6 1336 </table>
Chris@6 1337 </div><div class="memdoc">
Chris@1 1338
Chris@6 1339 <p class="definition">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>
Chris@1 1340
Chris@6 1341 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00189">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00180">setParameter()</a>.</p>
Chris@1 1342
Chris@1 1343 </div>
Chris@1 1344 </div>
Chris@6 1345 <a id="aceecd3b3879f32eb4a2e597c32c41cfc"></a>
Chris@6 1346 <h2 class="memtitle"><span class="permalink"><a href="#aceecd3b3879f32eb4a2e597c32c41cfc">&#9670;&nbsp;</a></span>m_relaxcoef</h2>
Chris@6 1347
Chris@1 1348 <div class="memitem">
Chris@1 1349 <div class="memproto">
Chris@6 1350 <table class="mlabels">
Chris@6 1351 <tr>
Chris@6 1352 <td class="mlabels-left">
Chris@1 1353 <table class="memname">
Chris@1 1354 <tr>
Chris@6 1355 <td class="memname">float AmplitudeFollower::m_relaxcoef</td>
Chris@1 1356 </tr>
Chris@1 1357 </table>
Chris@6 1358 </td>
Chris@6 1359 <td class="mlabels-right">
Chris@6 1360 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1361 </tr>
Chris@6 1362 </table>
Chris@6 1363 </div><div class="memdoc">
Chris@1 1364
Chris@6 1365 <p class="definition">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>
Chris@1 1366
Chris@6 1367 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00189">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00180">setParameter()</a>.</p>
Chris@1 1368
Chris@1 1369 </div>
Chris@1 1370 </div>
Chris@6 1371 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
Chris@6 1372 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
Chris@6 1373
Chris@1 1374 <div class="memitem">
Chris@1 1375 <div class="memproto">
Chris@6 1376 <table class="mlabels">
Chris@6 1377 <tr>
Chris@6 1378 <td class="mlabels-left">
Chris@1 1379 <table class="memname">
Chris@1 1380 <tr>
Chris@6 1381 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
Chris@1 1382 </tr>
Chris@1 1383 </table>
Chris@6 1384 </td>
Chris@6 1385 <td class="mlabels-right">
Chris@6 1386 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1387 </tr>
Chris@6 1388 </table>
Chris@6 1389 </div><div class="memdoc">
Chris@1 1390
Chris@6 1391 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">444</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1392
Chris@6 1393 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
Chris@1 1394
Chris@1 1395 </div>
Chris@1 1396 </div>
Chris@1 1397 <hr/>The documentation for this class was generated from the following files:<ul>
Chris@1 1398 <li><a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a></li>
Chris@1 1399 <li><a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a></li>
Chris@1 1400 </ul>
Chris@3 1401 </div><!-- contents -->
Chris@6 1402 </div><!-- doc-content -->
Chris@6 1403 <!-- start footer part -->
Chris@6 1404 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 1405 <ul>
Chris@6 1406 <li class="navelem"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a></li>
Chris@6 1407 <li class="footer">Generated by
Chris@6 1408 <a href="http://www.doxygen.org/index.html">
Chris@6 1409 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 1410 </ul>
Chris@1 1411 </div>
Chris@1 1412 </body>
Chris@1 1413 </html>