Mercurial > hg > vamp-website

view code-doc/AmplitudeFollower_8h-source.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VampPluginSDK: AmplitudeFollower.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_35887283b966ca996e4ff77f459c38ce.html">examples</a>
  </div>
</div>
<div class="contents">
<h1>AmplitudeFollower.h</h1><a href="AmplitudeFollower_8h.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>
<a name="l00002"></a>00002 
<a name="l00003"></a>00003 <span class="comment">/*</span>
<a name="l00004"></a>00004 <span class="comment">    Vamp</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">    An API for audio analysis and feature extraction plugins.</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">    Centre for Digital Music, Queen Mary, University of London.</span>
<a name="l00009"></a>00009 <span class="comment">    This file copyright 2006 Dan Stowell.</span>
<a name="l00010"></a>00010 <span class="comment">  </span>
<a name="l00011"></a>00011 <span class="comment">    Permission is hereby granted, free of charge, to any person</span>
<a name="l00012"></a>00012 <span class="comment">    obtaining a copy of this software and associated documentation</span>
<a name="l00013"></a>00013 <span class="comment">    files (the "Software"), to deal in the Software without</span>
<a name="l00014"></a>00014 <span class="comment">    restriction, including without limitation the rights to use, copy,</span>
<a name="l00015"></a>00015 <span class="comment">    modify, merge, publish, distribute, sublicense, and/or sell copies</span>
<a name="l00016"></a>00016 <span class="comment">    of the Software, and to permit persons to whom the Software is</span>
<a name="l00017"></a>00017 <span class="comment">    furnished to do so, subject to the following conditions:</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment">    The above copyright notice and this permission notice shall be</span>
<a name="l00020"></a>00020 <span class="comment">    included in all copies or substantial portions of the Software.</span>
<a name="l00021"></a>00021 <span class="comment"></span>
<a name="l00022"></a>00022 <span class="comment">    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00023"></a>00023 <span class="comment">    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00024"></a>00024 <span class="comment">    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
<a name="l00025"></a>00025 <span class="comment">    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
<a name="l00026"></a>00026 <span class="comment">    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
<a name="l00027"></a>00027 <span class="comment">    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
<a name="l00028"></a>00028 <span class="comment">    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">    Except as contained in this notice, the names of the Centre for</span>
<a name="l00031"></a>00031 <span class="comment">    Digital Music; Queen Mary, University of London; and Chris Cannam</span>
<a name="l00032"></a>00032 <span class="comment">    shall not be used in advertising or otherwise to promote the sale,</span>
<a name="l00033"></a>00033 <span class="comment">    use or other dealings in this Software without prior written</span>
<a name="l00034"></a>00034 <span class="comment">    authorization.</span>
<a name="l00035"></a>00035 <span class="comment">*/</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef _AMPLITUDE_FOLLOWER_PLUGIN_H_</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _AMPLITUDE_FOLLOWER_PLUGIN_H_</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a>"</span>
<a name="l00041"></a>00041 
<a name="l00047"></a><a class="code" href="classAmplitudeFollower.html">00047</a> <span class="keyword">class </span><a class="code" href="classAmplitudeFollower.html" title="Example plugin implementing the SuperCollider amplitude follower function.">AmplitudeFollower</a> : <span class="keyword">public</span> Vamp::<a class="code" href="classVamp_1_1Plugin.html#1b78c4f46c72ef345ed27f0b9bf20ac9">Plugin</a>
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050     <a class="code" href="classAmplitudeFollower.html#29eaeffc353da2614ae508abcd0ab63f" title="An implementation of SuperCollider&amp;#39;s amplitude-follower algorithm as a simple...">AmplitudeFollower</a>(<span class="keywordtype">float</span> inputSampleRate);
<a name="l00051"></a>00051     <span class="keyword">virtual</span> <a class="code" href="classAmplitudeFollower.html#a78f98539ad3a1b08691a99b32035b2d">~AmplitudeFollower</a>();
<a name="l00052"></a>00052 
<a name="l00053"></a>00053     <span class="keywordtype">bool</span> <a class="code" href="classAmplitudeFollower.html#eb727e44ee8ad1aceb90964d20f8d90d" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize);
<a name="l00054"></a>00054     <span class="keywordtype">void</span> <a class="code" href="classAmplitudeFollower.html#cebd835e80e84669df078fbd7591d8f7" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>();
<a name="l00055"></a>00055 
<a name="l00056"></a><a class="code" href="classAmplitudeFollower.html#fc07a389b5f922b944b0350fd232d2eb">00056</a>     <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classAmplitudeFollower.html#fc07a389b5f922b944b0350fd232d2eb" title="Get the plugin&amp;#39;s required input domain.">getInputDomain</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>; }
<a name="l00057"></a>00057 
<a name="l00058"></a>00058     std::string <a class="code" href="classAmplitudeFollower.html#fe7576af95c8fcc7f5bad42eec9f9f29" title="Get the computer-usable name of the plugin.">getIdentifier</a>() <span class="keyword">const</span>;
<a name="l00059"></a>00059     std::string <a class="code" href="classAmplitudeFollower.html#7cfed00bc9d96ba6c709b69ab6a40594" title="Get a human-readable name or title of the plugin.">getName</a>() <span class="keyword">const</span>;
<a name="l00060"></a>00060     std::string <a class="code" href="classAmplitudeFollower.html#6f0f2fea1fdb4b51e688edfe859d5062" title="Get a human-readable description for the plugin, typically a line of text that may...">getDescription</a>() <span class="keyword">const</span>;
<a name="l00061"></a>00061     std::string <a class="code" href="classAmplitudeFollower.html#44fc43838f203f58bc2ce6e3cb2b03dd" title="Get the name of the author or vendor of the plugin in human-readable form.">getMaker</a>() <span class="keyword">const</span>;
<a name="l00062"></a>00062     <span class="keywordtype">int</span> <a class="code" href="classAmplitudeFollower.html#8a5d7a834eb996d517c51f84b2a72250" title="Get the version number of the plugin.">getPluginVersion</a>() <span class="keyword">const</span>;
<a name="l00063"></a>00063     std::string <a class="code" href="classAmplitudeFollower.html#0c197fc90f30d91cb4403115c83c9134" title="Get the copyright statement or licensing summary for the plugin.">getCopyright</a>() <span class="keyword">const</span>;
<a name="l00064"></a>00064         
<a name="l00065"></a>00065     <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classAmplitudeFollower.html#043e3c3db77d76267cd8069e1485bf26" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span>;
<a name="l00066"></a>00066         
<a name="l00067"></a>00067     <a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="code" href="classAmplitudeFollower.html#9df01323a09e117bc12354ebe9244edf" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>() <span class="keyword">const</span>;
<a name="l00068"></a>00068     <span class="keywordtype">float</span> <a class="code" href="classAmplitudeFollower.html#b278c4b6f2ca23248dc94ad775273f39" title="Get the value of a named parameter.">getParameter</a>(std::string paramid) <span class="keyword">const</span>;
<a name="l00069"></a>00069     <span class="keywordtype">void</span> <a class="code" href="classAmplitudeFollower.html#e1fc37ece4d20e40f3066a3361a99340" title="Set a named parameter.">setParameter</a>(std::string paramid, <span class="keywordtype">float</span> newval);
<a name="l00070"></a>00070 
<a name="l00071"></a>00071     <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classAmplitudeFollower.html#48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,
<a name="l00072"></a>00072                        <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">Vamp::RealTime</a> timestamp);
<a name="l00073"></a>00073 
<a name="l00074"></a>00074     <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classAmplitudeFollower.html#368606f643b88e0df0823d85e36f030c" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures</a>();
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="keyword">protected</span>:
<a name="l00077"></a><a class="code" href="classAmplitudeFollower.html#959c2647fd3c5feea2591e3618774027">00077</a>     <span class="keywordtype">size_t</span> <a class="code" href="classAmplitudeFollower.html#959c2647fd3c5feea2591e3618774027">m_stepSize</a>;
<a name="l00078"></a><a class="code" href="classAmplitudeFollower.html#c95e8d2f334821c6c92c706bae29695a">00078</a>     <span class="keywordtype">float</span>  <a class="code" href="classAmplitudeFollower.html#c95e8d2f334821c6c92c706bae29695a">m_previn</a>;
<a name="l00079"></a><a class="code" href="classAmplitudeFollower.html#1cb205b08cfe2ce94a4af05b18f72876">00079</a>     <span class="keywordtype">float</span>  <a class="code" href="classAmplitudeFollower.html#1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a>;
<a name="l00080"></a><a class="code" href="classAmplitudeFollower.html#ceecd3b3879f32eb4a2e597c32c41cfc">00080</a>     <span class="keywordtype">float</span>  <a class="code" href="classAmplitudeFollower.html#ceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a>;
<a name="l00081"></a>00081 };
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 
<a name="l00084"></a>00084 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>