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

Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
rev   line source
cannam@50 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@50 2 <html xmlns="http://www.w3.org/1999/xhtml">
cannam@50 3 <head>
cannam@50 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
cannam@50 5 <title>VampPluginSDK: AmplitudeFollower.cpp Source File</title>
cannam@50 6
cannam@50 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
cannam@50 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
cannam@50 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
cannam@50 10 <script type="text/javascript" src="jquery.js"></script>
cannam@50 11 <script type="text/javascript" src="resize.js"></script>
cannam@50 12 <script type="text/javascript" src="navtree.js"></script>
cannam@50 13 <script type="text/javascript">
cannam@50 14 $(document).ready(initResizable);
cannam@50 15 </script>
cannam@50 16
cannam@50 17
cannam@50 18 </head>
cannam@50 19 <body>
cannam@50 20 <div id="top"><!-- do not remove this div! -->
cannam@50 21
cannam@50 22
cannam@50 23 <div id="titlearea">
cannam@50 24 <table cellspacing="0" cellpadding="0">
cannam@50 25 <tbody>
cannam@50 26 <tr style="height: 56px;">
cannam@50 27
cannam@50 28
cannam@50 29 <td style="padding-left: 0.5em;">
cannam@50 30 <div id="projectname">VampPluginSDK
cannam@50 31 &#160;<span id="projectnumber">2.1</span>
cannam@50 32 </div>
cannam@50 33
cannam@50 34 </td>
cannam@50 35
cannam@50 36
cannam@50 37
cannam@50 38 </tr>
cannam@50 39 </tbody>
cannam@50 40 </table>
cannam@50 41 </div>
cannam@50 42
cannam@50 43 <!-- Generated by Doxygen 1.7.5.1 -->
cannam@50 44 <div id="navrow1" class="tabs">
cannam@50 45 <ul class="tablist">
cannam@50 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
cannam@50 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@50 48 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@50 49 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@50 50 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@50 51 </ul>
cannam@50 52 </div>
cannam@50 53 <div id="navrow2" class="tabs2">
cannam@50 54 <ul class="tablist">
cannam@50 55 <li><a href="files.html"><span>File&#160;List</span></a></li>
cannam@50 56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
cannam@50 57 </ul>
cannam@50 58 </div>
cannam@50 59 </div>
cannam@50 60 <div id="side-nav" class="ui-resizable side-nav-resizable">
cannam@50 61 <div id="nav-tree">
cannam@50 62 <div id="nav-tree-contents">
cannam@50 63 </div>
cannam@50 64 </div>
cannam@50 65 <div id="splitbar" style="-moz-user-select:none;"
cannam@50 66 class="ui-resizable-handle">
cannam@50 67 </div>
cannam@50 68 </div>
cannam@50 69 <script type="text/javascript">
cannam@50 70 initNavTree('AmplitudeFollower_8cpp.html','');
cannam@50 71 </script>
cannam@50 72 <div id="doc-content">
cannam@50 73 <div class="header">
cannam@50 74 <div class="headertitle">
cannam@50 75 <div class="title">AmplitudeFollower.cpp</div> </div>
cannam@50 76 </div>
cannam@50 77 <div class="contents">
cannam@50 78 <a href="AmplitudeFollower_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span>
cannam@50 79 <a name="l00002"></a>00002
cannam@50 80 <a name="l00003"></a>00003 <span class="comment">/*</span>
cannam@50 81 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
cannam@50 82 <a name="l00005"></a>00005 <span class="comment"></span>
cannam@50 83 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
cannam@50 84 <a name="l00007"></a>00007 <span class="comment"></span>
cannam@50 85 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
cannam@50 86 <a name="l00009"></a>00009 <span class="comment"> This file copyright 2006 Dan Stowell.</span>
cannam@50 87 <a name="l00010"></a>00010 <span class="comment"> </span>
cannam@50 88 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
cannam@50 89 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
cannam@50 90 <a name="l00013"></a>00013 <span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span>
cannam@50 91 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
cannam@50 92 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
cannam@50 93 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
cannam@50 94 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
cannam@50 95 <a name="l00018"></a>00018 <span class="comment"></span>
cannam@50 96 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
cannam@50 97 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
cannam@50 98 <a name="l00021"></a>00021 <span class="comment"></span>
cannam@50 99 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
cannam@50 100 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
cannam@50 101 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
cannam@50 102 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
cannam@50 103 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
cannam@50 104 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
cannam@50 105 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
cannam@50 106 <a name="l00029"></a>00029 <span class="comment"></span>
cannam@50 107 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
cannam@50 108 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
cannam@50 109 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
cannam@50 110 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
cannam@50 111 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
cannam@50 112 <a name="l00035"></a>00035 <span class="comment">*/</span>
cannam@50 113 <a name="l00036"></a>00036
cannam@50 114 <a name="l00037"></a>00037 <span class="preprocessor">#include &quot;<a class="code" href="AmplitudeFollower_8h.html">AmplitudeFollower.h</a>&quot;</span>
cannam@50 115 <a name="l00038"></a>00038
cannam@50 116 <a name="l00039"></a>00039 <span class="preprocessor">#include &lt;cmath&gt;</span>
cannam@50 117 <a name="l00040"></a>00040
cannam@50 118 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;string&gt;</span>
cannam@50 119 <a name="l00042"></a>00042 <span class="preprocessor">#include &lt;vector&gt;</span>
cannam@50 120 <a name="l00043"></a>00043 <span class="preprocessor">#include &lt;iostream&gt;</span>
cannam@50 121 <a name="l00044"></a>00044
cannam@50 122 <a name="l00045"></a>00045 <span class="keyword">using</span> std::string;
cannam@50 123 <a name="l00046"></a>00046 <span class="keyword">using</span> std::vector;
cannam@50 124 <a name="l00047"></a>00047 <span class="keyword">using</span> std::cerr;
cannam@50 125 <a name="l00048"></a>00048 <span class="keyword">using</span> std::endl;
cannam@50 126 <a name="l00049"></a>00049
cannam@50 127 <a name="l00055"></a><a class="code" href="classAmplitudeFollower.html#a29eaeffc353da2614ae508abcd0ab63f">00055</a> <a class="code" href="classAmplitudeFollower.html#a29eaeffc353da2614ae508abcd0ab63f" title="An implementation of SuperCollider&#39;s amplitude-follower algorithm as a simple Vamp plugin...">AmplitudeFollower::AmplitudeFollower</a>(<span class="keywordtype">float</span> inputSampleRate) :
cannam@50 128 <a name="l00056"></a>00056 Plugin(inputSampleRate),
cannam@50 129 <a name="l00057"></a>00057 m_stepSize(0),
cannam@50 130 <a name="l00058"></a>00058 m_previn(0.0f),
cannam@50 131 <a name="l00059"></a>00059 m_clampcoef(0.01f),
cannam@50 132 <a name="l00060"></a>00060 m_relaxcoef(0.01f)
cannam@50 133 <a name="l00061"></a>00061 {
cannam@50 134 <a name="l00062"></a>00062 }
cannam@50 135 <a name="l00063"></a>00063
cannam@50 136 <a name="l00064"></a><a class="code" href="classAmplitudeFollower.html#aa78f98539ad3a1b08691a99b32035b2d">00064</a> <a class="code" href="classAmplitudeFollower.html#aa78f98539ad3a1b08691a99b32035b2d">AmplitudeFollower::~AmplitudeFollower</a>()
cannam@50 137 <a name="l00065"></a>00065 {
cannam@50 138 <a name="l00066"></a>00066 }
cannam@50 139 <a name="l00067"></a>00067
cannam@50 140 <a name="l00068"></a>00068 <span class="keywordtype">string</span>
cannam@50 141 <a name="l00069"></a><a class="code" href="classAmplitudeFollower.html#afe7576af95c8fcc7f5bad42eec9f9f29">00069</a> <a class="code" href="classAmplitudeFollower.html#afe7576af95c8fcc7f5bad42eec9f9f29" title="Get the computer-usable name of the plugin.">AmplitudeFollower::getIdentifier</a>()<span class="keyword"> const</span>
cannam@50 142 <a name="l00070"></a>00070 <span class="keyword"></span>{
cannam@50 143 <a name="l00071"></a>00071 <span class="keywordflow">return</span> <span class="stringliteral">&quot;amplitudefollower&quot;</span>;
cannam@50 144 <a name="l00072"></a>00072 }
cannam@50 145 <a name="l00073"></a>00073
cannam@50 146 <a name="l00074"></a>00074 <span class="keywordtype">string</span>
cannam@50 147 <a name="l00075"></a><a class="code" href="classAmplitudeFollower.html#a7cfed00bc9d96ba6c709b69ab6a40594">00075</a> <a class="code" href="classAmplitudeFollower.html#a7cfed00bc9d96ba6c709b69ab6a40594" title="Get a human-readable name or title of the plugin.">AmplitudeFollower::getName</a>()<span class="keyword"> const</span>
cannam@50 148 <a name="l00076"></a>00076 <span class="keyword"></span>{
cannam@50 149 <a name="l00077"></a>00077 <span class="keywordflow">return</span> <span class="stringliteral">&quot;Amplitude Follower&quot;</span>;
cannam@50 150 <a name="l00078"></a>00078 }
cannam@50 151 <a name="l00079"></a>00079
cannam@50 152 <a name="l00080"></a>00080 <span class="keywordtype">string</span>
cannam@50 153 <a name="l00081"></a><a class="code" href="classAmplitudeFollower.html#a6f0f2fea1fdb4b51e688edfe859d5062">00081</a> <a class="code" href="classAmplitudeFollower.html#a6f0f2fea1fdb4b51e688edfe859d5062" title="Get a human-readable description for the plugin, typically a line of text that may optionally be disp...">AmplitudeFollower::getDescription</a>()<span class="keyword"> const</span>
cannam@50 154 <a name="l00082"></a>00082 <span class="keyword"></span>{
cannam@50 155 <a name="l00083"></a>00083 <span class="keywordflow">return</span> <span class="stringliteral">&quot;Track the amplitude of the audio signal&quot;</span>;
cannam@50 156 <a name="l00084"></a>00084 }
cannam@50 157 <a name="l00085"></a>00085
cannam@50 158 <a name="l00086"></a>00086 <span class="keywordtype">string</span>
cannam@50 159 <a name="l00087"></a><a class="code" href="classAmplitudeFollower.html#a44fc43838f203f58bc2ce6e3cb2b03dd">00087</a> <a class="code" href="classAmplitudeFollower.html#a44fc43838f203f58bc2ce6e3cb2b03dd" title="Get the name of the author or vendor of the plugin in human-readable form.">AmplitudeFollower::getMaker</a>()<span class="keyword"> const</span>
cannam@50 160 <a name="l00088"></a>00088 <span class="keyword"></span>{
cannam@50 161 <a name="l00089"></a>00089 <span class="keywordflow">return</span> <span class="stringliteral">&quot;Vamp SDK Example Plugins&quot;</span>;
cannam@50 162 <a name="l00090"></a>00090 }
cannam@50 163 <a name="l00091"></a>00091
cannam@50 164 <a name="l00092"></a>00092 <span class="keywordtype">int</span>
cannam@50 165 <a name="l00093"></a><a class="code" href="classAmplitudeFollower.html#a8a5d7a834eb996d517c51f84b2a72250">00093</a> <a class="code" href="classAmplitudeFollower.html#a8a5d7a834eb996d517c51f84b2a72250" title="Get the version number of the plugin.">AmplitudeFollower::getPluginVersion</a>()<span class="keyword"> const</span>
cannam@50 166 <a name="l00094"></a>00094 <span class="keyword"></span>{
cannam@50 167 <a name="l00095"></a>00095 <span class="keywordflow">return</span> 1;
cannam@50 168 <a name="l00096"></a>00096 }
cannam@50 169 <a name="l00097"></a>00097
cannam@50 170 <a name="l00098"></a>00098 <span class="keywordtype">string</span>
cannam@50 171 <a name="l00099"></a><a class="code" href="classAmplitudeFollower.html#a0c197fc90f30d91cb4403115c83c9134">00099</a> <a class="code" href="classAmplitudeFollower.html#a0c197fc90f30d91cb4403115c83c9134" title="Get the copyright statement or licensing summary for the plugin.">AmplitudeFollower::getCopyright</a>()<span class="keyword"> const</span>
cannam@50 172 <a name="l00100"></a>00100 <span class="keyword"></span>{
cannam@50 173 <a name="l00101"></a>00101 <span class="keywordflow">return</span> <span class="stringliteral">&quot;Code copyright 2006 Dan Stowell; method from SuperCollider. Freely redistributable (BSD license)&quot;</span>;
cannam@50 174 <a name="l00102"></a>00102 }
cannam@50 175 <a name="l00103"></a>00103
cannam@50 176 <a name="l00104"></a>00104 <span class="keywordtype">bool</span>
cannam@50 177 <a name="l00105"></a><a class="code" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d">00105</a> <a class="code" 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).">AmplitudeFollower::initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize)
cannam@50 178 <a name="l00106"></a>00106 {
cannam@50 179 <a name="l00107"></a>00107 <span class="keywordflow">if</span> (channels &lt; <a class="code" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525" title="Get the minimum supported number of input channels.">getMinChannelCount</a>() ||
cannam@50 180 <a name="l00108"></a>00108 channels &gt; <a class="code" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>()) <span class="keywordflow">return</span> <span class="keyword">false</span>;
cannam@50 181 <a name="l00109"></a>00109
cannam@50 182 <a name="l00110"></a>00110 <a class="code" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">m_stepSize</a> = std::min(stepSize, blockSize);
cannam@50 183 <a name="l00111"></a>00111
cannam@50 184 <a name="l00112"></a>00112 <span class="comment">// Translate the coefficients </span>
cannam@50 185 <a name="l00113"></a>00113 <span class="comment">// from their &quot;convenient&quot; 60dB convergence-time values</span>
cannam@50 186 <a name="l00114"></a>00114 <span class="comment">// to real coefficients</span>
cannam@50 187 <a name="l00115"></a>00115 <a class="code" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a> = <a class="code" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a>==0.0 ? 0.0 : exp(log(0.1)/(<a class="code" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a> * <a class="code" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>));
cannam@50 188 <a name="l00116"></a>00116 <a class="code" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a> = <a class="code" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a>==0.0 ? 0.0 : exp(log(0.1)/(<a class="code" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a> * m_inputSampleRate));
cannam@50 189 <a name="l00117"></a>00117
cannam@50 190 <a name="l00118"></a>00118 <span class="keywordflow">return</span> <span class="keyword">true</span>;
cannam@50 191 <a name="l00119"></a>00119 }
cannam@50 192 <a name="l00120"></a>00120
cannam@50 193 <a name="l00121"></a>00121 <span class="keywordtype">void</span>
cannam@50 194 <a name="l00122"></a><a class="code" href="classAmplitudeFollower.html#acebd835e80e84669df078fbd7591d8f7">00122</a> <a class="code" href="classAmplitudeFollower.html#acebd835e80e84669df078fbd7591d8f7" title="Reset the plugin after use, to prepare it for another clean run.">AmplitudeFollower::reset</a>()
cannam@50 195 <a name="l00123"></a>00123 {
cannam@50 196 <a name="l00124"></a>00124 <a class="code" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">m_previn</a> = 0.0f;
cannam@50 197 <a name="l00125"></a>00125 }
cannam@50 198 <a name="l00126"></a>00126
cannam@50 199 <a name="l00127"></a>00127 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">AmplitudeFollower::OutputList</a>
cannam@50 200 <a name="l00128"></a><a class="code" href="classAmplitudeFollower.html#a043e3c3db77d76267cd8069e1485bf26">00128</a> <a class="code" href="classAmplitudeFollower.html#a043e3c3db77d76267cd8069e1485bf26" title="Get the outputs of this plugin.">AmplitudeFollower::getOutputDescriptors</a>()<span class="keyword"> const</span>
cannam@50 201 <a name="l00129"></a>00129 <span class="keyword"></span>{
cannam@50 202 <a name="l00130"></a>00130 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> list;
cannam@50 203 <a name="l00131"></a>00131
cannam@50 204 <a name="l00132"></a>00132 <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> sca;
cannam@50 205 <a name="l00133"></a>00133 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b" title="The name of the output, in computer-usable form.">identifier</a> = <span class="stringliteral">&quot;amplitude&quot;</span>;
cannam@50 206 <a name="l00134"></a>00134 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87" title="The human-readable name of the output.">name</a> = <span class="stringliteral">&quot;Amplitude&quot;</span>;
cannam@50 207 <a name="l00135"></a>00135 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1" title="A human-readable short text describing the output.">description</a> = <span class="stringliteral">&quot;The peak tracked amplitude for the current processing block&quot;</span>;
cannam@50 208 <a name="l00136"></a>00136 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4" title="The unit of the output, in human-readable form.">unit</a> = <span class="stringliteral">&quot;V&quot;</span>;
cannam@50 209 <a name="l00137"></a>00137 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d" title="True if the output has the same number of values per sample for every output sample.">hasFixedBinCount</a> = <span class="keyword">true</span>;
cannam@50 210 <a name="l00138"></a>00138 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = 1;
cannam@50 211 <a name="l00139"></a>00139 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31" title="True if the results in each output bin fall within a fixed numeric range (minimum and maximum values)...">hasKnownExtents</a> = <span class="keyword">false</span>;
cannam@50 212 <a name="l00140"></a>00140 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4" title="True if the output values are quantized to a particular resolution.">isQuantized</a> = <span class="keyword">false</span>;
cannam@50 213 <a name="l00141"></a>00141 sca.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d" title="Positioning in time of the output results.">sampleType</a> = <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca" title="Results from each process() align with that call&#39;s block start.">OutputDescriptor::OneSamplePerStep</a>;
cannam@50 214 <a name="l00142"></a>00142 list.push_back(sca);
cannam@50 215 <a name="l00143"></a>00143
cannam@50 216 <a name="l00144"></a>00144 <span class="keywordflow">return</span> list;
cannam@50 217 <a name="l00145"></a>00145 }
cannam@50 218 <a name="l00146"></a>00146
cannam@50 219 <a name="l00147"></a>00147 <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">AmplitudeFollower::ParameterList</a>
cannam@50 220 <a name="l00148"></a><a class="code" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">00148</a> <a class="code" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf" title="Get the controllable parameters of this plugin.">AmplitudeFollower::getParameterDescriptors</a>()<span class="keyword"> const</span>
cannam@50 221 <a name="l00149"></a>00149 <span class="keyword"></span>{
cannam@50 222 <a name="l00150"></a>00150 <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> list;
cannam@50 223 <a name="l00151"></a>00151
cannam@50 224 <a name="l00152"></a>00152 <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> att;
cannam@50 225 <a name="l00153"></a>00153 att.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c" title="The name of the parameter, in computer-usable form.">identifier</a> = <span class="stringliteral">&quot;attack&quot;</span>;
cannam@50 226 <a name="l00154"></a>00154 att.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084" title="The human-readable name of the parameter.">name</a> = <span class="stringliteral">&quot;Attack time&quot;</span>;
cannam@50 227 <a name="l00155"></a>00155 att.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf" title="A human-readable short text describing the parameter.">description</a> = <span class="stringliteral">&quot;The 60dB convergence time for an increase in amplitude&quot;</span>;
cannam@50 228 <a name="l00156"></a>00156 att.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b" title="The unit of the parameter, in human-readable form.">unit</a> = <span class="stringliteral">&quot;s&quot;</span>;
cannam@50 229 <a name="l00157"></a>00157 att.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8" title="The minimum value of the parameter.">minValue</a> = 0.0f;
cannam@50 230 <a name="l00158"></a>00158 att.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4" title="The maximum value of the parameter.">maxValue</a> = 1.f;
cannam@50 231 <a name="l00159"></a>00159 att.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc" title="The default value of the parameter.">defaultValue</a> = 0.01f;
cannam@50 232 <a name="l00160"></a>00160 att.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425" title="True if the parameter values are quantized to a particular resolution.">isQuantized</a> = <span class="keyword">false</span>;
cannam@50 233 <a name="l00161"></a>00161
cannam@50 234 <a name="l00162"></a>00162 list.push_back(att);
cannam@50 235 <a name="l00163"></a>00163
cannam@50 236 <a name="l00164"></a>00164 <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> dec;
cannam@50 237 <a name="l00165"></a>00165 dec.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c" title="The name of the parameter, in computer-usable form.">identifier</a> = <span class="stringliteral">&quot;release&quot;</span>;
cannam@50 238 <a name="l00166"></a>00166 dec.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084" title="The human-readable name of the parameter.">name</a> = <span class="stringliteral">&quot;Release time&quot;</span>;
cannam@50 239 <a name="l00167"></a>00167 dec.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf" title="A human-readable short text describing the parameter.">description</a> = <span class="stringliteral">&quot;The 60dB convergence time for a decrease in amplitude&quot;</span>;
cannam@50 240 <a name="l00168"></a>00168 dec.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b" title="The unit of the parameter, in human-readable form.">unit</a> = <span class="stringliteral">&quot;s&quot;</span>;
cannam@50 241 <a name="l00169"></a>00169 dec.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8" title="The minimum value of the parameter.">minValue</a> = 0.0f;
cannam@50 242 <a name="l00170"></a>00170 dec.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4" title="The maximum value of the parameter.">maxValue</a> = 1.f;
cannam@50 243 <a name="l00171"></a>00171 dec.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc" title="The default value of the parameter.">defaultValue</a> = 0.01f;
cannam@50 244 <a name="l00172"></a>00172 dec.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425" title="True if the parameter values are quantized to a particular resolution.">isQuantized</a> = <span class="keyword">false</span>;
cannam@50 245 <a name="l00173"></a>00173
cannam@50 246 <a name="l00174"></a>00174 list.push_back(dec);
cannam@50 247 <a name="l00175"></a>00175
cannam@50 248 <a name="l00176"></a>00176 <span class="keywordflow">return</span> list;
cannam@50 249 <a name="l00177"></a>00177 }
cannam@50 250 <a name="l00178"></a>00178
cannam@50 251 <a name="l00179"></a><a class="code" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">00179</a> <span class="keywordtype">void</span> <a class="code" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340" title="Set a named parameter.">AmplitudeFollower::setParameter</a>(std::string paramid, <span class="keywordtype">float</span> newval)
cannam@50 252 <a name="l00180"></a>00180 {
cannam@50 253 <a name="l00181"></a>00181 <span class="keywordflow">if</span> (paramid == <span class="stringliteral">&quot;attack&quot;</span>) {
cannam@50 254 <a name="l00182"></a>00182 <a class="code" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a> = newval;
cannam@50 255 <a name="l00183"></a>00183 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (paramid == <span class="stringliteral">&quot;release&quot;</span>) {
cannam@50 256 <a name="l00184"></a>00184 <a class="code" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a> = newval;
cannam@50 257 <a name="l00185"></a>00185 }
cannam@50 258 <a name="l00186"></a>00186 }
cannam@50 259 <a name="l00187"></a>00187
cannam@50 260 <a name="l00188"></a><a class="code" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">00188</a> <span class="keywordtype">float</span> <a class="code" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39" title="Get the value of a named parameter.">AmplitudeFollower::getParameter</a>(std::string paramid)<span class="keyword"> const</span>
cannam@50 261 <a name="l00189"></a>00189 <span class="keyword"></span>{
cannam@50 262 <a name="l00190"></a>00190 <span class="keywordflow">if</span> (paramid == <span class="stringliteral">&quot;attack&quot;</span>) {
cannam@50 263 <a name="l00191"></a>00191 <span class="keywordflow">return</span> <a class="code" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a>;
cannam@50 264 <a name="l00192"></a>00192 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (paramid == <span class="stringliteral">&quot;release&quot;</span>) {
cannam@50 265 <a name="l00193"></a>00193 <span class="keywordflow">return</span> <a class="code" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a>;
cannam@50 266 <a name="l00194"></a>00194 }
cannam@50 267 <a name="l00195"></a>00195
cannam@50 268 <a name="l00196"></a>00196 <span class="keywordflow">return</span> 0.0f;
cannam@50 269 <a name="l00197"></a>00197 }
cannam@50 270 <a name="l00198"></a>00198
cannam@50 271 <a name="l00199"></a>00199 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a>
cannam@50 272 <a name="l00200"></a><a class="code" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd">00200</a> <a class="code" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">AmplitudeFollower::process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,
cannam@50 273 <a name="l00201"></a>00201 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">Vamp::RealTime</a> timestamp)
cannam@50 274 <a name="l00202"></a>00202 {
cannam@50 275 <a name="l00203"></a>00203 <span class="keywordflow">if</span> (<a class="code" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">m_stepSize</a> == 0) {
cannam@50 276 <a name="l00204"></a>00204 cerr &lt;&lt; <span class="stringliteral">&quot;ERROR: AmplitudeFollower::process: &quot;</span>
cannam@50 277 <a name="l00205"></a>00205 &lt;&lt; <span class="stringliteral">&quot;AmplitudeFollower has not been initialised&quot;</span>
cannam@50 278 <a name="l00206"></a>00206 &lt;&lt; endl;
cannam@50 279 <a name="l00207"></a>00207 <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>();
cannam@50 280 <a name="l00208"></a>00208 }
cannam@50 281 <a name="l00209"></a>00209
cannam@50 282 <a name="l00210"></a>00210 <span class="keywordtype">float</span> previn = <a class="code" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">m_previn</a>;
cannam@50 283 <a name="l00211"></a>00211
cannam@50 284 <a name="l00212"></a>00212 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> returnFeatures;
cannam@50 285 <a name="l00213"></a>00213
cannam@50 286 <a name="l00214"></a>00214 <span class="keywordtype">float</span> val;
cannam@50 287 <a name="l00215"></a>00215 <span class="keywordtype">float</span> peak = 0.0f;
cannam@50 288 <a name="l00216"></a>00216
cannam@50 289 <a name="l00217"></a>00217 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; <a class="code" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">m_stepSize</a>; ++i) {
cannam@50 290 <a name="l00218"></a>00218
cannam@50 291 <a name="l00219"></a>00219 val = fabs(inputBuffers[0][i]);
cannam@50 292 <a name="l00220"></a>00220
cannam@50 293 <a name="l00221"></a>00221 <span class="keywordflow">if</span> (val &lt; previn) {
cannam@50 294 <a name="l00222"></a>00222 val = val + (previn - val) * <a class="code" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a>;
cannam@50 295 <a name="l00223"></a>00223 } <span class="keywordflow">else</span> {
cannam@50 296 <a name="l00224"></a>00224 val = val + (previn - val) * <a class="code" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a>;
cannam@50 297 <a name="l00225"></a>00225 }
cannam@50 298 <a name="l00226"></a>00226
cannam@50 299 <a name="l00227"></a>00227 <span class="keywordflow">if</span> (val &gt; peak) peak = val;
cannam@50 300 <a name="l00228"></a>00228 previn = val;
cannam@50 301 <a name="l00229"></a>00229 }
cannam@50 302 <a name="l00230"></a>00230
cannam@50 303 <a name="l00231"></a>00231 <a class="code" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">m_previn</a> = previn;
cannam@50 304 <a name="l00232"></a>00232
cannam@50 305 <a name="l00233"></a>00233 <span class="comment">// Now store the &quot;feature&quot; (peak amp) for this sample</span>
cannam@50 306 <a name="l00234"></a>00234 <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> feature;
cannam@50 307 <a name="l00235"></a>00235 feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b" title="True if an output feature has its own timestamp.">hasTimestamp</a> = <span class="keyword">false</span>;
cannam@50 308 <a name="l00236"></a>00236 feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71" title="Results for a single sample of this feature.">values</a>.push_back(peak);
cannam@50 309 <a name="l00237"></a>00237 returnFeatures[0].push_back(feature);
cannam@50 310 <a name="l00238"></a>00238
cannam@50 311 <a name="l00239"></a>00239 <span class="keywordflow">return</span> returnFeatures;
cannam@50 312 <a name="l00240"></a>00240 }
cannam@50 313 <a name="l00241"></a>00241
cannam@50 314 <a name="l00242"></a>00242 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a>
cannam@50 315 <a name="l00243"></a><a class="code" href="classAmplitudeFollower.html#a368606f643b88e0df0823d85e36f030c">00243</a> <a class="code" href="classAmplitudeFollower.html#a368606f643b88e0df0823d85e36f030c" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">AmplitudeFollower::getRemainingFeatures</a>()
cannam@50 316 <a name="l00244"></a>00244 {
cannam@50 317 <a name="l00245"></a>00245 <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>();
cannam@50 318 <a name="l00246"></a>00246 }
cannam@50 319 <a name="l00247"></a>00247
cannam@50 320 </pre></div></div>
cannam@50 321 </div>
cannam@50 322 <div id="nav-path" class="navpath">
cannam@50 323 <ul>
cannam@50 324 <li class="navelem"><a class="el" href="AmplitudeFollower_8cpp.html">AmplitudeFollower.cpp</a> </li>
cannam@50 325
cannam@50 326 <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
cannam@50 327 <a href="http://www.doxygen.org/index.html">
cannam@50 328 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
cannam@50 329 </ul>
cannam@50 330 </div>
cannam@50 331
cannam@50 332
cannam@50 333 </body>
cannam@50 334 </html>