Mercurial > hg > vamp-website

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

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