view code-doc/PercussionOnsetDetector_8cpp_source.html @ 50:8260c0f4e05b website

Update code docs for 2.3
author cannam
date Tue, 04 Oct 2011 13:47:23 +0000
parents
children
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>VampPluginSDK: PercussionOnsetDetector.cpp Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">VampPluginSDK
   &#160;<span id="projectnumber">2.1</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('PercussionOnsetDetector_8cpp.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">PercussionOnsetDetector.cpp</div>  </div>
</div>
<div class="contents">
<a href="PercussionOnsetDetector_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>
<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">    Copyright 2006 Chris Cannam.</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 &quot;Software&quot;), 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 &quot;AS IS&quot;, 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">#include &quot;<a class="code" href="PercussionOnsetDetector_8h.html">PercussionOnsetDetector.h</a>&quot;</span>
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="keyword">using</span> std::string;
<a name="l00040"></a>00040 <span class="keyword">using</span> std::vector;
<a name="l00041"></a>00041 <span class="keyword">using</span> std::cerr;
<a name="l00042"></a>00042 <span class="keyword">using</span> std::endl;
<a name="l00043"></a>00043 
<a name="l00044"></a>00044 <span class="preprocessor">#include &lt;cmath&gt;</span>
<a name="l00045"></a>00045 
<a name="l00046"></a>00046 
<a name="l00047"></a><a class="code" href="classPercussionOnsetDetector.html#a9f700579805ee5105758d847baab3511">00047</a> <a class="code" href="classPercussionOnsetDetector.html#a9f700579805ee5105758d847baab3511">PercussionOnsetDetector::PercussionOnsetDetector</a>(<span class="keywordtype">float</span> inputSampleRate) :
<a name="l00048"></a>00048     Plugin(inputSampleRate),
<a name="l00049"></a>00049     m_stepSize(0),
<a name="l00050"></a>00050     m_blockSize(0),
<a name="l00051"></a>00051     m_threshold(3),
<a name="l00052"></a>00052     m_sensitivity(40),
<a name="l00053"></a>00053     m_priorMagnitudes(0),
<a name="l00054"></a>00054     m_dfMinus1(0),
<a name="l00055"></a>00055     m_dfMinus2(0)
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058 
<a name="l00059"></a><a class="code" href="classPercussionOnsetDetector.html#a99f833667cf8185e879d735216c7642b">00059</a> <a class="code" href="classPercussionOnsetDetector.html#a99f833667cf8185e879d735216c7642b">PercussionOnsetDetector::~PercussionOnsetDetector</a>()
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061     <span class="keyword">delete</span>[] <a class="code" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a>;
<a name="l00062"></a>00062 }
<a name="l00063"></a>00063 
<a name="l00064"></a>00064 <span class="keywordtype">string</span>
<a name="l00065"></a><a class="code" href="classPercussionOnsetDetector.html#a267c83a7533146c127e2c3be310e0154">00065</a> <a class="code" href="classPercussionOnsetDetector.html#a267c83a7533146c127e2c3be310e0154" title="Get the computer-usable name of the plugin.">PercussionOnsetDetector::getIdentifier</a>()<span class="keyword"> const</span>
<a name="l00066"></a>00066 <span class="keyword"></span>{
<a name="l00067"></a>00067     <span class="keywordflow">return</span> <span class="stringliteral">&quot;percussiononsets&quot;</span>;
<a name="l00068"></a>00068 }
<a name="l00069"></a>00069 
<a name="l00070"></a>00070 <span class="keywordtype">string</span>
<a name="l00071"></a><a class="code" href="classPercussionOnsetDetector.html#aa98f1ad061a11af98c054011a8844e6f">00071</a> <a class="code" href="classPercussionOnsetDetector.html#aa98f1ad061a11af98c054011a8844e6f" title="Get a human-readable name or title of the plugin.">PercussionOnsetDetector::getName</a>()<span class="keyword"> const</span>
<a name="l00072"></a>00072 <span class="keyword"></span>{
<a name="l00073"></a>00073     <span class="keywordflow">return</span> <span class="stringliteral">&quot;Simple Percussion Onset Detector&quot;</span>;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="keywordtype">string</span>
<a name="l00077"></a><a class="code" href="classPercussionOnsetDetector.html#a9061d189705802a48973a7ccab6360db">00077</a> <a class="code" href="classPercussionOnsetDetector.html#a9061d189705802a48973a7ccab6360db" title="Get a human-readable description for the plugin, typically a line of text that may optionally be disp...">PercussionOnsetDetector::getDescription</a>()<span class="keyword"> const</span>
<a name="l00078"></a>00078 <span class="keyword"></span>{
<a name="l00079"></a>00079     <span class="keywordflow">return</span> <span class="stringliteral">&quot;Detect percussive note onsets by identifying broadband energy rises&quot;</span>;
<a name="l00080"></a>00080 }
<a name="l00081"></a>00081 
<a name="l00082"></a>00082 <span class="keywordtype">string</span>
<a name="l00083"></a><a class="code" href="classPercussionOnsetDetector.html#a63d63f2cb7ea8d8b09d58cc13b541375">00083</a> <a class="code" href="classPercussionOnsetDetector.html#a63d63f2cb7ea8d8b09d58cc13b541375" title="Get the name of the author or vendor of the plugin in human-readable form.">PercussionOnsetDetector::getMaker</a>()<span class="keyword"> const</span>
<a name="l00084"></a>00084 <span class="keyword"></span>{
<a name="l00085"></a>00085     <span class="keywordflow">return</span> <span class="stringliteral">&quot;Vamp SDK Example Plugins&quot;</span>;
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 <span class="keywordtype">int</span>
<a name="l00089"></a><a class="code" href="classPercussionOnsetDetector.html#ad6b818dbd81867ce7be71c99cae861be">00089</a> <a class="code" href="classPercussionOnsetDetector.html#ad6b818dbd81867ce7be71c99cae861be" title="Get the version number of the plugin.">PercussionOnsetDetector::getPluginVersion</a>()<span class="keyword"> const</span>
<a name="l00090"></a>00090 <span class="keyword"></span>{
<a name="l00091"></a>00091     <span class="keywordflow">return</span> 2;
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093 
<a name="l00094"></a>00094 <span class="keywordtype">string</span>
<a name="l00095"></a><a class="code" href="classPercussionOnsetDetector.html#a1a22ece271330c94cc08798a77416351">00095</a> <a class="code" href="classPercussionOnsetDetector.html#a1a22ece271330c94cc08798a77416351" title="Get the copyright statement or licensing summary for the plugin.">PercussionOnsetDetector::getCopyright</a>()<span class="keyword"> const</span>
<a name="l00096"></a>00096 <span class="keyword"></span>{
<a name="l00097"></a>00097     <span class="keywordflow">return</span> <span class="stringliteral">&quot;Code copyright 2006 Queen Mary, University of London, after Dan Barry et al 2005.  Freely redistributable (BSD license)&quot;</span>;
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099 
<a name="l00100"></a>00100 <span class="keywordtype">size_t</span>
<a name="l00101"></a><a class="code" href="classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968">00101</a> <a class="code" href="classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968" title="Get the preferred step size (window increment -- the distance in sample frames between the start fram...">PercussionOnsetDetector::getPreferredStepSize</a>()<span class="keyword"> const</span>
<a name="l00102"></a>00102 <span class="keyword"></span>{
<a name="l00103"></a>00103     <span class="keywordflow">return</span> 0;
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105 
<a name="l00106"></a>00106 <span class="keywordtype">size_t</span>
<a name="l00107"></a><a class="code" href="classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0">00107</a> <a class="code" href="classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0" title="Get the preferred block size (window size -- the number of sample frames passed in each block to the ...">PercussionOnsetDetector::getPreferredBlockSize</a>()<span class="keyword"> const</span>
<a name="l00108"></a>00108 <span class="keyword"></span>{
<a name="l00109"></a>00109     <span class="keywordflow">return</span> 1024;
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 
<a name="l00112"></a>00112 <span class="keywordtype">bool</span>
<a name="l00113"></a><a class="code" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab">00113</a> <a class="code" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab" 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).">PercussionOnsetDetector::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="l00114"></a>00114 {
<a name="l00115"></a>00115     <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>() ||
<a name="l00116"></a>00116         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>;
<a name="l00117"></a>00117 
<a name="l00118"></a>00118     <a class="code" href="classPercussionOnsetDetector.html#aabac0cf7e961482b075777e5f0686e6c">m_stepSize</a> = stepSize;
<a name="l00119"></a>00119     <a class="code" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">m_blockSize</a> = blockSize;
<a name="l00120"></a>00120 
<a name="l00121"></a>00121     <a class="code" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a> = <span class="keyword">new</span> <span class="keywordtype">float</span>[<a class="code" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">m_blockSize</a>/2];
<a name="l00122"></a>00122 
<a name="l00123"></a>00123     <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; <a class="code" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">m_blockSize</a>/2; ++i) {
<a name="l00124"></a>00124         <a class="code" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a>[i] = 0.f;
<a name="l00125"></a>00125     }
<a name="l00126"></a>00126 
<a name="l00127"></a>00127     <a class="code" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a> = 0.f;
<a name="l00128"></a>00128     <a class="code" href="classPercussionOnsetDetector.html#a6ad7d8353cc681ff42a63b127cca5779">m_dfMinus2</a> = 0.f;
<a name="l00129"></a>00129 
<a name="l00130"></a>00130     <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 <span class="keywordtype">void</span>
<a name="l00134"></a><a class="code" href="classPercussionOnsetDetector.html#a9b1075e992cd9599764ef3881fb91d1a">00134</a> <a class="code" href="classPercussionOnsetDetector.html#a9b1075e992cd9599764ef3881fb91d1a" title="Reset the plugin after use, to prepare it for another clean run.">PercussionOnsetDetector::reset</a>()
<a name="l00135"></a>00135 {
<a name="l00136"></a>00136     <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; <a class="code" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">m_blockSize</a>/2; ++i) {
<a name="l00137"></a>00137         <a class="code" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a>[i] = 0.f;
<a name="l00138"></a>00138     }
<a name="l00139"></a>00139 
<a name="l00140"></a>00140     <a class="code" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a> = 0.f;
<a name="l00141"></a>00141     <a class="code" href="classPercussionOnsetDetector.html#a6ad7d8353cc681ff42a63b127cca5779">m_dfMinus2</a> = 0.f;
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143 
<a name="l00144"></a>00144 <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">PercussionOnsetDetector::ParameterList</a>
<a name="l00145"></a><a class="code" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815">00145</a> <a class="code" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815" title="Get the controllable parameters of this plugin.">PercussionOnsetDetector::getParameterDescriptors</a>()<span class="keyword"> const</span>
<a name="l00146"></a>00146 <span class="keyword"></span>{
<a name="l00147"></a>00147     <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> list;
<a name="l00148"></a>00148 
<a name="l00149"></a>00149     <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> d;
<a name="l00150"></a>00150     d.<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;threshold&quot;</span>;
<a name="l00151"></a>00151     d.<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;Energy rise threshold&quot;</span>;
<a name="l00152"></a>00152     d.<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;Energy rise within a frequency bin necessary to count toward broadband total&quot;</span>;
<a name="l00153"></a>00153     d.<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;dB&quot;</span>;
<a name="l00154"></a>00154     d.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8" title="The minimum value of the parameter.">minValue</a> = 0;
<a name="l00155"></a>00155     d.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4" title="The maximum value of the parameter.">maxValue</a> = 20;
<a name="l00156"></a>00156     d.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc" title="The default value of the parameter.">defaultValue</a> = 3;
<a name="l00157"></a>00157     d.<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>;
<a name="l00158"></a>00158     list.push_back(d);
<a name="l00159"></a>00159 
<a name="l00160"></a>00160     d.<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;sensitivity&quot;</span>;
<a name="l00161"></a>00161     d.<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;Sensitivity&quot;</span>;
<a name="l00162"></a>00162     d.<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;Sensitivity of peak detector applied to broadband detection function&quot;</span>;
<a name="l00163"></a>00163     d.<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;%&quot;</span>;
<a name="l00164"></a>00164     d.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8" title="The minimum value of the parameter.">minValue</a> = 0;
<a name="l00165"></a>00165     d.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4" title="The maximum value of the parameter.">maxValue</a> = 100;
<a name="l00166"></a>00166     d.<a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc" title="The default value of the parameter.">defaultValue</a> = 40;
<a name="l00167"></a>00167     d.<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>;
<a name="l00168"></a>00168     list.push_back(d);
<a name="l00169"></a>00169 
<a name="l00170"></a>00170     <span class="keywordflow">return</span> list;
<a name="l00171"></a>00171 }
<a name="l00172"></a>00172 
<a name="l00173"></a>00173 <span class="keywordtype">float</span>
<a name="l00174"></a><a class="code" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527">00174</a> <a class="code" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527" title="Get the value of a named parameter.">PercussionOnsetDetector::getParameter</a>(std::string <span class="keywordtype">id</span>)<span class="keyword"> const</span>
<a name="l00175"></a>00175 <span class="keyword"></span>{
<a name="l00176"></a>00176     <span class="keywordflow">if</span> (<span class="keywordtype">id</span> == <span class="stringliteral">&quot;threshold&quot;</span>) <span class="keywordflow">return</span> <a class="code" href="classPercussionOnsetDetector.html#ab04119adad56d87f2e633de289aab507">m_threshold</a>;
<a name="l00177"></a>00177     <span class="keywordflow">if</span> (<span class="keywordtype">id</span> == <span class="stringliteral">&quot;sensitivity&quot;</span>) <span class="keywordflow">return</span> <a class="code" href="classPercussionOnsetDetector.html#a4e9770f246ba3bc75e7fc2cb8f9010af">m_sensitivity</a>;
<a name="l00178"></a>00178     <span class="keywordflow">return</span> 0.f;
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180 
<a name="l00181"></a>00181 <span class="keywordtype">void</span>
<a name="l00182"></a><a class="code" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">00182</a> <a class="code" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01" title="Set a named parameter.">PercussionOnsetDetector::setParameter</a>(std::string <span class="keywordtype">id</span>, <span class="keywordtype">float</span> value)
<a name="l00183"></a>00183 {
<a name="l00184"></a>00184     <span class="keywordflow">if</span> (<span class="keywordtype">id</span> == <span class="stringliteral">&quot;threshold&quot;</span>) {
<a name="l00185"></a>00185         <span class="keywordflow">if</span> (value &lt; 0) value = 0;
<a name="l00186"></a>00186         <span class="keywordflow">if</span> (value &gt; 20) value = 20;
<a name="l00187"></a>00187         <a class="code" href="classPercussionOnsetDetector.html#ab04119adad56d87f2e633de289aab507">m_threshold</a> = value;
<a name="l00188"></a>00188     } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<span class="keywordtype">id</span> == <span class="stringliteral">&quot;sensitivity&quot;</span>) {
<a name="l00189"></a>00189         <span class="keywordflow">if</span> (value &lt; 0) value = 0;
<a name="l00190"></a>00190         <span class="keywordflow">if</span> (value &gt; 100) value = 100;
<a name="l00191"></a>00191         <a class="code" href="classPercussionOnsetDetector.html#a4e9770f246ba3bc75e7fc2cb8f9010af">m_sensitivity</a> = value;
<a name="l00192"></a>00192     }
<a name="l00193"></a>00193 }
<a name="l00194"></a>00194 
<a name="l00195"></a>00195 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">PercussionOnsetDetector::OutputList</a>
<a name="l00196"></a><a class="code" href="classPercussionOnsetDetector.html#aa4537aa0eb58a67d6e824d46924cf782">00196</a> <a class="code" href="classPercussionOnsetDetector.html#aa4537aa0eb58a67d6e824d46924cf782" title="Get the outputs of this plugin.">PercussionOnsetDetector::getOutputDescriptors</a>()<span class="keyword"> const</span>
<a name="l00197"></a>00197 <span class="keyword"></span>{
<a name="l00198"></a>00198     <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> list;
<a name="l00199"></a>00199 
<a name="l00200"></a>00200     <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> d;
<a name="l00201"></a>00201     d.<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;onsets&quot;</span>;
<a name="l00202"></a>00202     d.<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;Onsets&quot;</span>;
<a name="l00203"></a>00203     d.<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;Percussive note onset locations&quot;</span>;
<a name="l00204"></a>00204     d.<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;&quot;</span>;
<a name="l00205"></a>00205     d.<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>;
<a name="l00206"></a>00206     d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = 0;
<a name="l00207"></a>00207     d.<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>;
<a name="l00208"></a>00208     d.<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>;
<a name="l00209"></a>00209     d.<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#abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e" title="Results are unevenly spaced and have individual timestamps.">OutputDescriptor::VariableSampleRate</a>;
<a name="l00210"></a>00210     d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af" title="Sample rate of the output results, as samples per second.">sampleRate</a> = <a class="code" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>;
<a name="l00211"></a>00211     list.push_back(d);
<a name="l00212"></a>00212 
<a name="l00213"></a>00213     d.<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;detectionfunction&quot;</span>;
<a name="l00214"></a>00214     d.<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;Detection Function&quot;</span>;
<a name="l00215"></a>00215     d.<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;Broadband energy rise detection function&quot;</span>;
<a name="l00216"></a>00216     d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = 1;
<a name="l00217"></a>00217     d.<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">true</span>;
<a name="l00218"></a>00218     d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b" title="Quantization resolution of the output values (e.g.">quantizeStep</a> = 1.0;
<a name="l00219"></a>00219     d.<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>;
<a name="l00220"></a>00220     list.push_back(d);
<a name="l00221"></a>00221 
<a name="l00222"></a>00222     <span class="keywordflow">return</span> list;
<a name="l00223"></a>00223 }
<a name="l00224"></a>00224 
<a name="l00225"></a>00225 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a>
<a name="l00226"></a><a class="code" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614">00226</a> <a class="code" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data.">PercussionOnsetDetector::process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,
<a name="l00227"></a>00227                                  <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> ts)
<a name="l00228"></a>00228 {
<a name="l00229"></a>00229     <span class="keywordflow">if</span> (<a class="code" href="classPercussionOnsetDetector.html#aabac0cf7e961482b075777e5f0686e6c">m_stepSize</a> == 0) {
<a name="l00230"></a>00230         cerr &lt;&lt; <span class="stringliteral">&quot;ERROR: PercussionOnsetDetector::process: &quot;</span>
<a name="l00231"></a>00231              &lt;&lt; <span class="stringliteral">&quot;PercussionOnsetDetector has not been initialised&quot;</span>
<a name="l00232"></a>00232              &lt;&lt; endl;
<a name="l00233"></a>00233         <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>();
<a name="l00234"></a>00234     }
<a name="l00235"></a>00235 
<a name="l00236"></a>00236     <span class="keywordtype">int</span> count = 0;
<a name="l00237"></a>00237 
<a name="l00238"></a>00238     <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 1; i &lt; <a class="code" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">m_blockSize</a>/2; ++i) {
<a name="l00239"></a>00239 
<a name="l00240"></a>00240         <span class="keywordtype">float</span> real = inputBuffers[0][i*2];
<a name="l00241"></a>00241         <span class="keywordtype">float</span> imag = inputBuffers[0][i*2 + 1];
<a name="l00242"></a>00242 
<a name="l00243"></a>00243         <span class="keywordtype">float</span> sqrmag = real * real + imag * imag;
<a name="l00244"></a>00244 
<a name="l00245"></a>00245         <span class="keywordflow">if</span> (<a class="code" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a>[i] &gt; 0.f) {
<a name="l00246"></a>00246             <span class="keywordtype">float</span> diff = 10.f * log10f(sqrmag / <a class="code" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a>[i]);
<a name="l00247"></a>00247 
<a name="l00248"></a>00248 <span class="comment">//        std::cout &lt;&lt; &quot;i=&quot; &lt;&lt; i &lt;&lt; &quot;, sqrmag=&quot; &lt;&lt; sqrmag &lt;&lt; &quot;, prior=&quot; &lt;&lt; m_priorMagnitudes[i] &lt;&lt; &quot;, diff=&quot; &lt;&lt; diff &lt;&lt; &quot;, threshold=&quot; &lt;&lt; m_threshold &lt;&lt; &quot; &quot; &lt;&lt; (diff &gt;= m_threshold ? &quot;[*]&quot; : &quot;&quot;) &lt;&lt; std::endl;</span>
<a name="l00249"></a>00249 
<a name="l00250"></a>00250             <span class="keywordflow">if</span> (diff &gt;= <a class="code" href="classPercussionOnsetDetector.html#ab04119adad56d87f2e633de289aab507">m_threshold</a>) ++count;
<a name="l00251"></a>00251         }
<a name="l00252"></a>00252 
<a name="l00253"></a>00253         <a class="code" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a>[i] = sqrmag;
<a name="l00254"></a>00254     }
<a name="l00255"></a>00255 
<a name="l00256"></a>00256     <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> returnFeatures;
<a name="l00257"></a>00257 
<a name="l00258"></a>00258     <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> detectionFunction;
<a name="l00259"></a>00259     detectionFunction.<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>;
<a name="l00260"></a>00260     detectionFunction.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71" title="Results for a single sample of this feature.">values</a>.push_back(count);
<a name="l00261"></a>00261     returnFeatures[1].push_back(detectionFunction);
<a name="l00262"></a>00262 
<a name="l00263"></a>00263     <span class="keywordflow">if</span> (<a class="code" href="classPercussionOnsetDetector.html#a6ad7d8353cc681ff42a63b127cca5779">m_dfMinus2</a> &lt; <a class="code" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a> &amp;&amp;
<a name="l00264"></a>00264         <a class="code" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a> &gt;= count &amp;&amp;
<a name="l00265"></a>00265         <a class="code" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a> &gt; ((100 - <a class="code" href="classPercussionOnsetDetector.html#a4e9770f246ba3bc75e7fc2cb8f9010af">m_sensitivity</a>) * <a class="code" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">m_blockSize</a>) / 200) {
<a name="l00266"></a>00266 
<a name="l00267"></a>00267 <span class="comment">//std::cout &lt;&lt; &quot;result at &quot; &lt;&lt; ts &lt;&lt; &quot;! (count == &quot; &lt;&lt; count &lt;&lt; &quot;, prev == &quot; &lt;&lt; m_dfMinus1 &lt;&lt; &quot;)&quot; &lt;&lt; std::endl;</span>
<a name="l00268"></a>00268 
<a name="l00269"></a>00269         <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> onset;
<a name="l00270"></a>00270         onset.<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">true</span>;
<a name="l00271"></a>00271         onset.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7" title="Timestamp of the output feature.">timestamp</a> = ts - <a class="code" href="structVamp_1_1RealTime.html#a939b4b1d1ca190db69a418883f16ce8a" title="Convert a sample frame at the given sample rate into a RealTime.">Vamp::RealTime::frame2RealTime</a>
<a name="l00272"></a>00272             (<a class="code" href="classPercussionOnsetDetector.html#aabac0cf7e961482b075777e5f0686e6c">m_stepSize</a>, <span class="keywordtype">int</span>(<a class="code" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a> + 0.5));
<a name="l00273"></a>00273         returnFeatures[0].push_back(onset);
<a name="l00274"></a>00274     }
<a name="l00275"></a>00275 
<a name="l00276"></a>00276     <a class="code" href="classPercussionOnsetDetector.html#a6ad7d8353cc681ff42a63b127cca5779">m_dfMinus2</a> = <a class="code" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a>;
<a name="l00277"></a>00277     <a class="code" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a> = count;
<a name="l00278"></a>00278 
<a name="l00279"></a>00279     <span class="keywordflow">return</span> returnFeatures;
<a name="l00280"></a>00280 }
<a name="l00281"></a>00281 
<a name="l00282"></a>00282 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a>
<a name="l00283"></a><a class="code" href="classPercussionOnsetDetector.html#ad3d6767ed137783e84f842b4d4732ffa">00283</a> <a class="code" href="classPercussionOnsetDetector.html#ad3d6767ed137783e84f842b4d4732ffa" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">PercussionOnsetDetector::getRemainingFeatures</a>()
<a name="l00284"></a>00284 {
<a name="l00285"></a>00285     <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>();
<a name="l00286"></a>00286 }
<a name="l00287"></a>00287 
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="PercussionOnsetDetector_8cpp.html">PercussionOnsetDetector.cpp</a>      </li>

    <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>