Mercurial > hg > vamp-website

annotate code-doc/PercussionOnsetDetector_8h-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: PercussionOnsetDetector.h 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>PercussionOnsetDetector.h</h1><a href="PercussionOnsetDetector_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>
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"> Copyright 2006 Chris Cannam.</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">#ifndef _PERCUSSION_ONSET_DETECTOR_PLUGIN_H_</span>
cannam@0 65 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _PERCUSSION_ONSET_DETECTOR_PLUGIN_H_</span>
cannam@0 66 <a name="l00039"></a>00039 <span class="preprocessor"></span>
cannam@21 67 <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a>"</span>
cannam@0 68 <a name="l00041"></a>00041
cannam@0 69 <a name="l00046"></a><a class="code" href="classPercussionOnsetDetector.html">00046</a> <span class="keyword">class </span><a class="code" href="classPercussionOnsetDetector.html" title="Example plugin that detects percussive events.">PercussionOnsetDetector</a> : <span class="keyword">public</span> Vamp::<a class="code" href="classVamp_1_1Plugin.html#1b78c4f46c72ef345ed27f0b9bf20ac9">Plugin</a>
cannam@0 70 <a name="l00047"></a>00047 {
cannam@0 71 <a name="l00048"></a>00048 <span class="keyword">public</span>:
cannam@0 72 <a name="l00049"></a>00049 <a class="code" href="classPercussionOnsetDetector.html#9f700579805ee5105758d847baab3511">PercussionOnsetDetector</a>(<span class="keywordtype">float</span> inputSampleRate);
cannam@0 73 <a name="l00050"></a>00050 <span class="keyword">virtual</span> <a class="code" href="classPercussionOnsetDetector.html#99f833667cf8185e879d735216c7642b">~PercussionOnsetDetector</a>();
cannam@0 74 <a name="l00051"></a>00051
cannam@0 75 <a name="l00052"></a>00052 <span class="keywordtype">bool</span> <a class="code" href="classPercussionOnsetDetector.html#349c528260622308f3850bcda8a448ab" 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);
cannam@0 76 <a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="classPercussionOnsetDetector.html#9b1075e992cd9599764ef3881fb91d1a" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>();
cannam@0 77 <a name="l00054"></a>00054
cannam@0 78 <a name="l00055"></a><a class="code" href="classPercussionOnsetDetector.html#4f6954267696ee5bfa7dd1c4a6cfa92a">00055</a> <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classPercussionOnsetDetector.html#4f6954267696ee5bfa7dd1c4a6cfa92a" 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#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>; }
cannam@0 79 <a name="l00056"></a>00056
cannam@0 80 <a name="l00057"></a>00057 std::string <a class="code" href="classPercussionOnsetDetector.html#267c83a7533146c127e2c3be310e0154" title="Get the computer-usable name of the plugin.">getIdentifier</a>() <span class="keyword">const</span>;
cannam@0 81 <a name="l00058"></a>00058 std::string <a class="code" href="classPercussionOnsetDetector.html#a98f1ad061a11af98c054011a8844e6f" title="Get a human-readable name or title of the plugin.">getName</a>() <span class="keyword">const</span>;
cannam@0 82 <a name="l00059"></a>00059 std::string <a class="code" href="classPercussionOnsetDetector.html#9061d189705802a48973a7ccab6360db" title="Get a human-readable description for the plugin, typically a line of text that may...">getDescription</a>() <span class="keyword">const</span>;
cannam@0 83 <a name="l00060"></a>00060 std::string <a class="code" href="classPercussionOnsetDetector.html#63d63f2cb7ea8d8b09d58cc13b541375" title="Get the name of the author or vendor of the plugin in human-readable form.">getMaker</a>() <span class="keyword">const</span>;
cannam@0 84 <a name="l00061"></a>00061 <span class="keywordtype">int</span> <a class="code" href="classPercussionOnsetDetector.html#d6b818dbd81867ce7be71c99cae861be" title="Get the version number of the plugin.">getPluginVersion</a>() <span class="keyword">const</span>;
cannam@0 85 <a name="l00062"></a>00062 std::string <a class="code" href="classPercussionOnsetDetector.html#1a22ece271330c94cc08798a77416351" title="Get the copyright statement or licensing summary for the plugin.">getCopyright</a>() <span class="keyword">const</span>;
cannam@0 86 <a name="l00063"></a>00063
cannam@0 87 <a name="l00064"></a>00064 <span class="keywordtype">size_t</span> <a class="code" href="classPercussionOnsetDetector.html#733824891e11c306a7a678534b89b968" title="Get the preferred step size (window increment -- the distance in sample frames between...">getPreferredStepSize</a>() <span class="keyword">const</span>;
cannam@0 88 <a name="l00065"></a>00065 <span class="keywordtype">size_t</span> <a class="code" href="classPercussionOnsetDetector.html#410c0b47c6c849d7ed9b726b84402ad0" title="Get the preferred block size (window size -- the number of sample frames passed in...">getPreferredBlockSize</a>() <span class="keyword">const</span>;
cannam@0 89 <a name="l00066"></a>00066
cannam@0 90 <a name="l00067"></a>00067 <a class="code" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="code" href="classPercussionOnsetDetector.html#bceae88cc9762b0ea310d7aad71de815" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>() <span class="keyword">const</span>;
cannam@0 91 <a name="l00068"></a>00068 <span class="keywordtype">float</span> <a class="code" href="classPercussionOnsetDetector.html#9b28da8315fcde46ce7644d6592ba527" title="Get the value of a named parameter.">getParameter</a>(std::string <span class="keywordtype">id</span>) <span class="keyword">const</span>;
cannam@0 92 <a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="classPercussionOnsetDetector.html#a097d72488e1211f05fc661ff5c6dc01" title="Set a named parameter.">setParameter</a>(std::string <span class="keywordtype">id</span>, <span class="keywordtype">float</span> value);
cannam@0 93 <a name="l00070"></a>00070
cannam@0 94 <a name="l00071"></a>00071 <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classPercussionOnsetDetector.html#a4537aa0eb58a67d6e824d46924cf782" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span>;
cannam@0 95 <a name="l00072"></a>00072
cannam@0 96 <a name="l00073"></a>00073 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classPercussionOnsetDetector.html#dfd989812b3e0cb8f4b498f56a5a9614" 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,
cannam@0 97 <a name="l00074"></a>00074 <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 98 <a name="l00075"></a>00075
cannam@0 99 <a name="l00076"></a>00076 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classPercussionOnsetDetector.html#d3d6767ed137783e84f842b4d4732ffa" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures</a>();
cannam@0 100 <a name="l00077"></a>00077
cannam@0 101 <a name="l00078"></a>00078 <span class="keyword">protected</span>:
cannam@0 102 <a name="l00079"></a><a class="code" href="classPercussionOnsetDetector.html#abac0cf7e961482b075777e5f0686e6c">00079</a> <span class="keywordtype">size_t</span> <a class="code" href="classPercussionOnsetDetector.html#abac0cf7e961482b075777e5f0686e6c">m_stepSize</a>;
cannam@0 103 <a name="l00080"></a><a class="code" href="classPercussionOnsetDetector.html#920de543dbcf70a2edd80b5b31313285">00080</a> <span class="keywordtype">size_t</span> <a class="code" href="classPercussionOnsetDetector.html#920de543dbcf70a2edd80b5b31313285">m_blockSize</a>;
cannam@0 104 <a name="l00081"></a>00081
cannam@0 105 <a name="l00082"></a><a class="code" href="classPercussionOnsetDetector.html#b04119adad56d87f2e633de289aab507">00082</a> <span class="keywordtype">float</span> <a class="code" href="classPercussionOnsetDetector.html#b04119adad56d87f2e633de289aab507">m_threshold</a>;
cannam@0 106 <a name="l00083"></a><a class="code" href="classPercussionOnsetDetector.html#4e9770f246ba3bc75e7fc2cb8f9010af">00083</a> <span class="keywordtype">float</span> <a class="code" href="classPercussionOnsetDetector.html#4e9770f246ba3bc75e7fc2cb8f9010af">m_sensitivity</a>;
cannam@0 107 <a name="l00084"></a><a class="code" href="classPercussionOnsetDetector.html#30daa717267251a9d49afe57c328e989">00084</a> <span class="keywordtype">float</span> *<a class="code" href="classPercussionOnsetDetector.html#30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a>;
cannam@0 108 <a name="l00085"></a><a class="code" href="classPercussionOnsetDetector.html#cd80162c65212be7fa91251263fb9c3d">00085</a> <span class="keywordtype">float</span> <a class="code" href="classPercussionOnsetDetector.html#cd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a>;
cannam@0 109 <a name="l00086"></a><a class="code" href="classPercussionOnsetDetector.html#6ad7d8353cc681ff42a63b127cca5779">00086</a> <span class="keywordtype">float</span> <a class="code" href="classPercussionOnsetDetector.html#6ad7d8353cc681ff42a63b127cca5779">m_dfMinus2</a>;
cannam@0 110 <a name="l00087"></a>00087 };
cannam@0 111 <a name="l00088"></a>00088
cannam@0 112 <a name="l00089"></a>00089
cannam@0 113 <a name="l00090"></a>00090 <span class="preprocessor">#endif</span>
cannam@0 114 </pre></div></div>
cannam@35 115 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
cannam@0 116 <a href="http://www.doxygen.org/index.html">
cannam@35 117 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 118 </body>
cannam@0 119 </html>