Mercurial > hg > vamp-docs

annotate code-docs/classPercussionOnsetDetector.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@1 8 <title>VampPluginSDK: PercussionOnsetDetector Class Reference</title>
Chris@1 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@1 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@1 15 <script type="text/javascript" src="navtree.js"></script>
Chris@1 16 <script type="text/javascript">
Chris@1 17 $(document).ready(initResizable);
Chris@1 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 20 </head>
Chris@1 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@1 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@1 30 </div>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </tbody>
Chris@1 34 </table>
Chris@1 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@1 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 48 <div id="nav-tree">
Chris@1 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@1 51 </div>
Chris@1 52 </div>
Chris@1 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 54 class="ui-resizable-handle">
Chris@1 55 </div>
Chris@1 56 </div>
Chris@1 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('classPercussionOnsetDetector.html','');});
Chris@1 59 </script>
Chris@1 60 <div id="doc-content">
Chris@1 61 <div class="header">
Chris@1 62 <div class="summary">
Chris@1 63 <a href="#pub-types">Public Types</a> &#124;
Chris@1 64 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@6 65 <a href="#pro-attribs">Protected Attributes</a> &#124;
Chris@6 66 <a href="classPercussionOnsetDetector-members.html">List of all members</a> </div>
Chris@1 67 <div class="headertitle">
Chris@1 68 <div class="title">PercussionOnsetDetector Class Reference</div> </div>
Chris@3 69 </div><!--header-->
Chris@1 70 <div class="contents">
Chris@3 71
Chris@1 72 <p>Example plugin that detects percussive events.
Chris@1 73 <a href="classPercussionOnsetDetector.html#details">More...</a></p>
Chris@1 74
Chris@1 75 <p><code>#include &lt;<a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>&gt;</code></p>
Chris@1 76 <div class="dynheader">
Chris@1 77 Inheritance diagram for PercussionOnsetDetector:</div>
Chris@1 78 <div class="dyncontent">
Chris@1 79 <div class="center"><img src="classPercussionOnsetDetector__inherit__graph.png" border="0" usemap="#PercussionOnsetDetector_inherit__map" alt="Inheritance graph"/></div>
Chris@1 80 <map name="PercussionOnsetDetector_inherit__map" id="PercussionOnsetDetector_inherit__map">
Chris@6 81 <area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="39,79,134,104"/>
Chris@6 82 <area shape="rect" id="node3" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. " alt="" coords="25,5,148,31"/>
Chris@6 83 </map>
Chris@1 84 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
Chris@1 85 <table class="memberdecls">
Chris@6 86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Chris@1 87 Public Types</h2></td></tr>
Chris@3 88 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
Chris@1 89 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
Chris@1 90 }</td></tr>
Chris@6 91 <tr class="separator:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 92 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
Chris@6 93 <tr class="separator:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 94 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
Chris@6 95 <tr class="separator:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 96 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
Chris@6 97 <tr class="separator:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 98 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
Chris@6 99 <tr class="separator:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 100 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
Chris@6 101 <tr class="separator:a7f66f00437b21e5f694fe02356b12f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 102 </table><table class="memberdecls">
Chris@6 103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Chris@1 104 Public Member Functions</h2></td></tr>
Chris@3 105 <tr class="memitem:a9f700579805ee5105758d847baab3511"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a9f700579805ee5105758d847baab3511">PercussionOnsetDetector</a> (float inputSampleRate)</td></tr>
Chris@6 106 <tr class="separator:a9f700579805ee5105758d847baab3511"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 107 <tr class="memitem:a99f833667cf8185e879d735216c7642b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a99f833667cf8185e879d735216c7642b">~PercussionOnsetDetector</a> ()</td></tr>
Chris@6 108 <tr class="separator:a99f833667cf8185e879d735216c7642b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 109 <tr class="memitem:a349c528260622308f3850bcda8a448ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
Chris@6 110 <tr class="memdesc:a349c528260622308f3850bcda8a448ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">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). <a href="#a349c528260622308f3850bcda8a448ab">More...</a><br /></td></tr>
Chris@6 111 <tr class="separator:a349c528260622308f3850bcda8a448ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 112 <tr class="memitem:a9b1075e992cd9599764ef3881fb91d1a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a9b1075e992cd9599764ef3881fb91d1a">reset</a> ()</td></tr>
Chris@6 113 <tr class="memdesc:a9b1075e992cd9599764ef3881fb91d1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a9b1075e992cd9599764ef3881fb91d1a">More...</a><br /></td></tr>
Chris@6 114 <tr class="separator:a9b1075e992cd9599764ef3881fb91d1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 115 <tr class="memitem:a8c980a67814934d57e0c5de3e58a4ca2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a8c980a67814934d57e0c5de3e58a4ca2">getInputDomain</a> () const</td></tr>
Chris@6 116 <tr class="memdesc:a8c980a67814934d57e0c5de3e58a4ca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a8c980a67814934d57e0c5de3e58a4ca2">More...</a><br /></td></tr>
Chris@6 117 <tr class="separator:a8c980a67814934d57e0c5de3e58a4ca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 118 <tr class="memitem:ac1bb968a3632083e55e4d236310b9cdb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#ac1bb968a3632083e55e4d236310b9cdb">getIdentifier</a> () const</td></tr>
Chris@6 119 <tr class="memdesc:ac1bb968a3632083e55e4d236310b9cdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ac1bb968a3632083e55e4d236310b9cdb">More...</a><br /></td></tr>
Chris@6 120 <tr class="separator:ac1bb968a3632083e55e4d236310b9cdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 121 <tr class="memitem:a9b8532bfd1a6053682db3ce15b1890da"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a9b8532bfd1a6053682db3ce15b1890da">getName</a> () const</td></tr>
Chris@6 122 <tr class="memdesc:a9b8532bfd1a6053682db3ce15b1890da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a9b8532bfd1a6053682db3ce15b1890da">More...</a><br /></td></tr>
Chris@6 123 <tr class="separator:a9b8532bfd1a6053682db3ce15b1890da"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 124 <tr class="memitem:a4ea74f76e302c53ced7508bc8388487b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a4ea74f76e302c53ced7508bc8388487b">getDescription</a> () const</td></tr>
Chris@6 125 <tr class="memdesc:a4ea74f76e302c53ced7508bc8388487b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#a4ea74f76e302c53ced7508bc8388487b">More...</a><br /></td></tr>
Chris@6 126 <tr class="separator:a4ea74f76e302c53ced7508bc8388487b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 127 <tr class="memitem:a1ef108aac025c3f2c3201fd9f43b6a6b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a1ef108aac025c3f2c3201fd9f43b6a6b">getMaker</a> () const</td></tr>
Chris@6 128 <tr class="memdesc:a1ef108aac025c3f2c3201fd9f43b6a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a1ef108aac025c3f2c3201fd9f43b6a6b">More...</a><br /></td></tr>
Chris@6 129 <tr class="separator:a1ef108aac025c3f2c3201fd9f43b6a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 130 <tr class="memitem:ad4f4a732e9e0ae0cb0151e2e10862299"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#ad4f4a732e9e0ae0cb0151e2e10862299">getPluginVersion</a> () const</td></tr>
Chris@6 131 <tr class="memdesc:ad4f4a732e9e0ae0cb0151e2e10862299"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#ad4f4a732e9e0ae0cb0151e2e10862299">More...</a><br /></td></tr>
Chris@6 132 <tr class="separator:ad4f4a732e9e0ae0cb0151e2e10862299"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 133 <tr class="memitem:acf9ac12b8f313aa6fad58ad2fed663da"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#acf9ac12b8f313aa6fad58ad2fed663da">getCopyright</a> () const</td></tr>
Chris@6 134 <tr class="memdesc:acf9ac12b8f313aa6fad58ad2fed663da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#acf9ac12b8f313aa6fad58ad2fed663da">More...</a><br /></td></tr>
Chris@6 135 <tr class="separator:acf9ac12b8f313aa6fad58ad2fed663da"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 136 <tr class="memitem:a0ad851545302fc87e8226104584667a0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a0ad851545302fc87e8226104584667a0">getPreferredStepSize</a> () const</td></tr>
Chris@6 137 <tr class="memdesc:a0ad851545302fc87e8226104584667a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment &ndash; the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data. ">process()</a> function) for the plugin. <a href="#a0ad851545302fc87e8226104584667a0">More...</a><br /></td></tr>
Chris@6 138 <tr class="separator:a0ad851545302fc87e8226104584667a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 139 <tr class="memitem:abacdc27486aab9b37d1a51e35e6a9444"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#abacdc27486aab9b37d1a51e35e6a9444">getPreferredBlockSize</a> () const</td></tr>
Chris@6 140 <tr class="memdesc:abacdc27486aab9b37d1a51e35e6a9444"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data. ">process()</a> function). <a href="#abacdc27486aab9b37d1a51e35e6a9444">More...</a><br /></td></tr>
Chris@6 141 <tr class="separator:abacdc27486aab9b37d1a51e35e6a9444"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 142 <tr class="memitem:ae1cc81d82aaac8db5cf8a1067494f3d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#ae1cc81d82aaac8db5cf8a1067494f3d8">getParameterDescriptors</a> () const</td></tr>
Chris@6 143 <tr class="memdesc:ae1cc81d82aaac8db5cf8a1067494f3d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#ae1cc81d82aaac8db5cf8a1067494f3d8">More...</a><br /></td></tr>
Chris@6 144 <tr class="separator:ae1cc81d82aaac8db5cf8a1067494f3d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 145 <tr class="memitem:accce70a87d6b30d4696d40a3e09b8f17"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#accce70a87d6b30d4696d40a3e09b8f17">getParameter</a> (std::string id) const</td></tr>
Chris@6 146 <tr class="memdesc:accce70a87d6b30d4696d40a3e09b8f17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#accce70a87d6b30d4696d40a3e09b8f17">More...</a><br /></td></tr>
Chris@6 147 <tr class="separator:accce70a87d6b30d4696d40a3e09b8f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 148 <tr class="memitem:aa097d72488e1211f05fc661ff5c6dc01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">setParameter</a> (std::string id, float value)</td></tr>
Chris@6 149 <tr class="memdesc:aa097d72488e1211f05fc661ff5c6dc01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#aa097d72488e1211f05fc661ff5c6dc01">More...</a><br /></td></tr>
Chris@6 150 <tr class="separator:aa097d72488e1211f05fc661ff5c6dc01"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 151 <tr class="memitem:a9518f60b3b0bf6c31c51c0aaffc599c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a9518f60b3b0bf6c31c51c0aaffc599c9">getOutputDescriptors</a> () const</td></tr>
Chris@6 152 <tr class="memdesc:a9518f60b3b0bf6c31c51c0aaffc599c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a9518f60b3b0bf6c31c51c0aaffc599c9">More...</a><br /></td></tr>
Chris@6 153 <tr class="separator:a9518f60b3b0bf6c31c51c0aaffc599c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 154 <tr class="memitem:adfd989812b3e0cb8f4b498f56a5a9614"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
Chris@6 155 <tr class="memdesc:adfd989812b3e0cb8f4b498f56a5a9614"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#adfd989812b3e0cb8f4b498f56a5a9614">More...</a><br /></td></tr>
Chris@6 156 <tr class="separator:adfd989812b3e0cb8f4b498f56a5a9614"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 157 <tr class="memitem:ad3d6767ed137783e84f842b4d4732ffa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#ad3d6767ed137783e84f842b4d4732ffa">getRemainingFeatures</a> ()</td></tr>
Chris@6 158 <tr class="memdesc:ad3d6767ed137783e84f842b4d4732ffa"><td class="mdescLeft">&#160;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#ad3d6767ed137783e84f842b4d4732ffa">More...</a><br /></td></tr>
Chris@6 159 <tr class="separator:ad3d6767ed137783e84f842b4d4732ffa"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 160 <tr class="memitem:ab74f7634c6ac6e3da115667808a79c30"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30">getMinChannelCount</a> () const</td></tr>
Chris@6 161 <tr class="memdesc:ab74f7634c6ac6e3da115667808a79c30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#ab74f7634c6ac6e3da115667808a79c30">More...</a><br /></td></tr>
Chris@6 162 <tr class="separator:ab74f7634c6ac6e3da115667808a79c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 163 <tr class="memitem:a0bff9464bc8c117470136c396b2405dd"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd">getMaxChannelCount</a> () const</td></tr>
Chris@6 164 <tr class="memdesc:a0bff9464bc8c117470136c396b2405dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a0bff9464bc8c117470136c396b2405dd">More...</a><br /></td></tr>
Chris@6 165 <tr class="separator:a0bff9464bc8c117470136c396b2405dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 166 <tr class="memitem:a530123068767a8728c568ffccfe3e4e5"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a530123068767a8728c568ffccfe3e4e5">getType</a> () const</td></tr>
Chris@6 167 <tr class="memdesc:a530123068767a8728c568ffccfe3e4e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. ">PluginBase</a>. <a href="#a530123068767a8728c568ffccfe3e4e5">More...</a><br /></td></tr>
Chris@6 168 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 169 <tr class="memitem:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ab4aa9c3e6f6dd9addbc095463c9fb772">getVampApiVersion</a> () const</td></tr>
Chris@6 170 <tr class="memdesc:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">More...</a><br /></td></tr>
Chris@6 171 <tr class="separator:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 172 <tr class="memitem:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aaf6febff0ab4daf4a5089c98a67f4df8">getPrograms</a> () const</td></tr>
Chris@6 173 <tr class="memdesc:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#aaf6febff0ab4daf4a5089c98a67f4df8">More...</a><br /></td></tr>
Chris@6 174 <tr class="separator:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 175 <tr class="memitem:aac38c5dc6e87208616122897518ca3d5"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aac38c5dc6e87208616122897518ca3d5">getCurrentProgram</a> () const</td></tr>
Chris@6 176 <tr class="memdesc:aac38c5dc6e87208616122897518ca3d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#aac38c5dc6e87208616122897518ca3d5">More...</a><br /></td></tr>
Chris@6 177 <tr class="separator:aac38c5dc6e87208616122897518ca3d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 178 <tr class="memitem:aadd3a547ef140bae200473a9518e3353"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
Chris@6 179 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353">More...</a><br /></td></tr>
Chris@6 180 <tr class="separator:aadd3a547ef140bae200473a9518e3353"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 181 </table><table class="memberdecls">
Chris@6 182 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Chris@1 183 Protected Attributes</h2></td></tr>
Chris@3 184 <tr class="memitem:aabac0cf7e961482b075777e5f0686e6c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#aabac0cf7e961482b075777e5f0686e6c">m_stepSize</a></td></tr>
Chris@6 185 <tr class="separator:aabac0cf7e961482b075777e5f0686e6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 186 <tr class="memitem:a920de543dbcf70a2edd80b5b31313285"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285">m_blockSize</a></td></tr>
Chris@6 187 <tr class="separator:a920de543dbcf70a2edd80b5b31313285"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 188 <tr class="memitem:ab04119adad56d87f2e633de289aab507"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#ab04119adad56d87f2e633de289aab507">m_threshold</a></td></tr>
Chris@6 189 <tr class="separator:ab04119adad56d87f2e633de289aab507"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 190 <tr class="memitem:a4e9770f246ba3bc75e7fc2cb8f9010af"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a4e9770f246ba3bc75e7fc2cb8f9010af">m_sensitivity</a></td></tr>
Chris@6 191 <tr class="separator:a4e9770f246ba3bc75e7fc2cb8f9010af"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 192 <tr class="memitem:a30daa717267251a9d49afe57c328e989"><td class="memItemLeft" align="right" valign="top">float *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989">m_priorMagnitudes</a></td></tr>
Chris@6 193 <tr class="separator:a30daa717267251a9d49afe57c328e989"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 194 <tr class="memitem:acd80162c65212be7fa91251263fb9c3d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d">m_dfMinus1</a></td></tr>
Chris@6 195 <tr class="separator:acd80162c65212be7fa91251263fb9c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 196 <tr class="memitem:a6ad7d8353cc681ff42a63b127cca5779"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPercussionOnsetDetector.html#a6ad7d8353cc681ff42a63b127cca5779">m_dfMinus2</a></td></tr>
Chris@6 197 <tr class="separator:a6ad7d8353cc681ff42a63b127cca5779"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 198 <tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
Chris@6 199 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 200 </table>
Chris@6 201 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Chris@1 202 <div class="textblock"><p>Example plugin that detects percussive events. </p>
Chris@1 203
Chris@6 204 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00046">46</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@6 205 </div><h2 class="groupheader">Member Typedef Documentation</h2>
Chris@6 206 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
Chris@6 207 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
Chris@6 208
Chris@6 209 <div class="memitem">
Chris@6 210 <div class="memproto">
Chris@6 211 <table class="mlabels">
Chris@6 212 <tr>
Chris@6 213 <td class="mlabels-left">
Chris@6 214 <table class="memname">
Chris@6 215 <tr>
Chris@6 216 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a></td>
Chris@6 217 </tr>
Chris@6 218 </table>
Chris@6 219 </td>
Chris@6 220 <td class="mlabels-right">
Chris@6 221 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 222 </tr>
Chris@6 223 </table>
Chris@6 224 </div><div class="memdoc">
Chris@6 225
Chris@6 226 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00335">335</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 227
Chris@6 228 </div>
Chris@6 229 </div>
Chris@6 230 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
Chris@6 231 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
Chris@6 232
Chris@6 233 <div class="memitem">
Chris@6 234 <div class="memproto">
Chris@6 235 <table class="mlabels">
Chris@6 236 <tr>
Chris@6 237 <td class="mlabels-left">
Chris@6 238 <table class="memname">
Chris@6 239 <tr>
Chris@6 240 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a></td>
Chris@6 241 </tr>
Chris@6 242 </table>
Chris@6 243 </td>
Chris@6 244 <td class="mlabels-right">
Chris@6 245 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 246 </tr>
Chris@6 247 </table>
Chris@6 248 </div><div class="memdoc">
Chris@6 249
Chris@6 250 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00393">393</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 251
Chris@6 252 </div>
Chris@6 253 </div>
Chris@6 254 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
Chris@6 255 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
Chris@6 256
Chris@6 257 <div class="memitem">
Chris@6 258 <div class="memproto">
Chris@6 259 <table class="mlabels">
Chris@6 260 <tr>
Chris@6 261 <td class="mlabels-left">
Chris@6 262 <table class="memname">
Chris@6 263 <tr>
Chris@6 264 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a></td>
Chris@6 265 </tr>
Chris@6 266 </table>
Chris@6 267 </td>
Chris@6 268 <td class="mlabels-right">
Chris@6 269 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 270 </tr>
Chris@6 271 </table>
Chris@6 272 </div><div class="memdoc">
Chris@6 273
Chris@6 274 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00395">395</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 275
Chris@6 276 </div>
Chris@6 277 </div>
Chris@6 278 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
Chris@6 279 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
Chris@6 280
Chris@6 281 <div class="memitem">
Chris@6 282 <div class="memproto">
Chris@6 283 <table class="mlabels">
Chris@6 284 <tr>
Chris@6 285 <td class="mlabels-left">
Chris@6 286 <table class="memname">
Chris@6 287 <tr>
Chris@6 288 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a></td>
Chris@6 289 </tr>
Chris@6 290 </table>
Chris@6 291 </td>
Chris@6 292 <td class="mlabels-right">
Chris@6 293 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 294 </tr>
Chris@6 295 </table>
Chris@6 296 </div><div class="memdoc">
Chris@6 297
Chris@6 298 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@6 299
Chris@6 300 </div>
Chris@6 301 </div>
Chris@6 302 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
Chris@6 303 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
Chris@6 304
Chris@6 305 <div class="memitem">
Chris@6 306 <div class="memproto">
Chris@6 307 <table class="mlabels">
Chris@6 308 <tr>
Chris@6 309 <td class="mlabels-left">
Chris@6 310 <table class="memname">
Chris@6 311 <tr>
Chris@6 312 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
Chris@6 313 </tr>
Chris@6 314 </table>
Chris@6 315 </td>
Chris@6 316 <td class="mlabels-right">
Chris@6 317 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 318 </tr>
Chris@6 319 </table>
Chris@6 320 </div><div class="memdoc">
Chris@6 321
Chris@6 322 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@6 323
Chris@6 324 </div>
Chris@6 325 </div>
Chris@6 326 <h2 class="groupheader">Member Enumeration Documentation</h2>
Chris@6 327 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
Chris@6 328 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
Chris@6 329
Chris@6 330 <div class="memitem">
Chris@6 331 <div class="memproto">
Chris@6 332 <table class="mlabels">
Chris@6 333 <tr>
Chris@6 334 <td class="mlabels-left">
Chris@6 335 <table class="memname">
Chris@6 336 <tr>
Chris@6 337 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
Chris@6 338 </tr>
Chris@6 339 </table>
Chris@6 340 </td>
Chris@6 341 <td class="mlabels-right">
Chris@6 342 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 343 </tr>
Chris@6 344 </table>
Chris@6 345 </div><div class="memdoc">
Chris@6 346 <table class="fieldtable">
Chris@6 347 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain&#160;</td><td class="fielddoc"></td></tr>
Chris@6 348 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
Chris@6 349 </table>
Chris@6 350
Chris@6 351 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 352
Chris@6 353 </div>
Chris@6 354 </div>
Chris@6 355 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
Chris@6 356 <a id="a9f700579805ee5105758d847baab3511"></a>
Chris@6 357 <h2 class="memtitle"><span class="permalink"><a href="#a9f700579805ee5105758d847baab3511">&#9670;&nbsp;</a></span>PercussionOnsetDetector()</h2>
Chris@6 358
Chris@1 359 <div class="memitem">
Chris@1 360 <div class="memproto">
Chris@1 361 <table class="memname">
Chris@1 362 <tr>
Chris@6 363 <td class="memname">PercussionOnsetDetector::PercussionOnsetDetector </td>
Chris@1 364 <td>(</td>
Chris@1 365 <td class="paramtype">float&#160;</td>
Chris@1 366 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
Chris@1 367 <td></td>
Chris@1 368 </tr>
Chris@1 369 </table>
Chris@6 370 </div><div class="memdoc">
Chris@1 371
Chris@6 372 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00047">47</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 373
Chris@1 374 </div>
Chris@1 375 </div>
Chris@6 376 <a id="a99f833667cf8185e879d735216c7642b"></a>
Chris@6 377 <h2 class="memtitle"><span class="permalink"><a href="#a99f833667cf8185e879d735216c7642b">&#9670;&nbsp;</a></span>~PercussionOnsetDetector()</h2>
Chris@6 378
Chris@1 379 <div class="memitem">
Chris@1 380 <div class="memproto">
Chris@6 381 <table class="mlabels">
Chris@6 382 <tr>
Chris@6 383 <td class="mlabels-left">
Chris@1 384 <table class="memname">
Chris@1 385 <tr>
Chris@6 386 <td class="memname">PercussionOnsetDetector::~PercussionOnsetDetector </td>
Chris@1 387 <td>(</td>
Chris@1 388 <td class="paramname"></td><td>)</td>
Chris@6 389 <td></td>
Chris@1 390 </tr>
Chris@1 391 </table>
Chris@6 392 </td>
Chris@6 393 <td class="mlabels-right">
Chris@6 394 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 395 </tr>
Chris@6 396 </table>
Chris@6 397 </div><div class="memdoc">
Chris@1 398
Chris@6 399 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00059">59</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 400
Chris@6 401 <p class="reference">References <a class="el" href="PercussionOnsetDetector_8h_source.html#l00084">m_priorMagnitudes</a>.</p>
Chris@1 402
Chris@1 403 </div>
Chris@1 404 </div>
Chris@6 405 <h2 class="groupheader">Member Function Documentation</h2>
Chris@6 406 <a id="a349c528260622308f3850bcda8a448ab"></a>
Chris@6 407 <h2 class="memtitle"><span class="permalink"><a href="#a349c528260622308f3850bcda8a448ab">&#9670;&nbsp;</a></span>initialise()</h2>
Chris@6 408
Chris@1 409 <div class="memitem">
Chris@1 410 <div class="memproto">
Chris@6 411 <table class="mlabels">
Chris@6 412 <tr>
Chris@6 413 <td class="mlabels-left">
Chris@1 414 <table class="memname">
Chris@1 415 <tr>
Chris@6 416 <td class="memname">bool PercussionOnsetDetector::initialise </td>
Chris@1 417 <td>(</td>
Chris@1 418 <td class="paramtype">size_t&#160;</td>
Chris@1 419 <td class="paramname"><em>inputChannels</em>, </td>
Chris@1 420 </tr>
Chris@1 421 <tr>
Chris@1 422 <td class="paramkey"></td>
Chris@1 423 <td></td>
Chris@1 424 <td class="paramtype">size_t&#160;</td>
Chris@1 425 <td class="paramname"><em>stepSize</em>, </td>
Chris@1 426 </tr>
Chris@1 427 <tr>
Chris@1 428 <td class="paramkey"></td>
Chris@1 429 <td></td>
Chris@1 430 <td class="paramtype">size_t&#160;</td>
Chris@1 431 <td class="paramname"><em>blockSize</em>&#160;</td>
Chris@1 432 </tr>
Chris@1 433 <tr>
Chris@1 434 <td></td>
Chris@1 435 <td>)</td>
Chris@6 436 <td></td><td></td>
Chris@1 437 </tr>
Chris@1 438 </table>
Chris@6 439 </td>
Chris@6 440 <td class="mlabels-right">
Chris@6 441 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 442 </tr>
Chris@6 443 </table>
Chris@6 444 </div><div class="memdoc">
Chris@1 445
Chris@1 446 <p>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). </p>
Chris@1 447 <p>The input sample rate should have been already specified at construction time.</p>
Chris@1 448 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
Chris@1 449
Chris@1 450 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
Chris@1 451
Chris@6 452 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">113</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 453
Chris@6 454 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00086">m_dfMinus2</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00084">m_priorMagnitudes</a>, and <a class="el" href="PercussionOnsetDetector_8h_source.html#l00079">m_stepSize</a>.</p>
Chris@1 455
Chris@1 456 </div>
Chris@1 457 </div>
Chris@6 458 <a id="a9b1075e992cd9599764ef3881fb91d1a"></a>
Chris@6 459 <h2 class="memtitle"><span class="permalink"><a href="#a9b1075e992cd9599764ef3881fb91d1a">&#9670;&nbsp;</a></span>reset()</h2>
Chris@6 460
Chris@1 461 <div class="memitem">
Chris@1 462 <div class="memproto">
Chris@6 463 <table class="mlabels">
Chris@6 464 <tr>
Chris@6 465 <td class="mlabels-left">
Chris@1 466 <table class="memname">
Chris@1 467 <tr>
Chris@6 468 <td class="memname">void PercussionOnsetDetector::reset </td>
Chris@1 469 <td>(</td>
Chris@1 470 <td class="paramname"></td><td>)</td>
Chris@6 471 <td></td>
Chris@1 472 </tr>
Chris@1 473 </table>
Chris@6 474 </td>
Chris@6 475 <td class="mlabels-right">
Chris@6 476 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 477 </tr>
Chris@6 478 </table>
Chris@6 479 </div><div class="memdoc">
Chris@1 480
Chris@1 481 <p>Reset the plugin after use, to prepare it for another clean run. </p>
Chris@1 482 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
Chris@1 483
Chris@1 484 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
Chris@1 485
Chris@6 486 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">134</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 487
Chris@6 488 <p class="reference">References <a class="el" href="PercussionOnsetDetector_8h_source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00086">m_dfMinus2</a>, and <a class="el" href="PercussionOnsetDetector_8h_source.html#l00084">m_priorMagnitudes</a>.</p>
Chris@1 489
Chris@1 490 </div>
Chris@1 491 </div>
Chris@6 492 <a id="a8c980a67814934d57e0c5de3e58a4ca2"></a>
Chris@6 493 <h2 class="memtitle"><span class="permalink"><a href="#a8c980a67814934d57e0c5de3e58a4ca2">&#9670;&nbsp;</a></span>getInputDomain()</h2>
Chris@6 494
Chris@1 495 <div class="memitem">
Chris@1 496 <div class="memproto">
Chris@6 497 <table class="mlabels">
Chris@6 498 <tr>
Chris@6 499 <td class="mlabels-left">
Chris@1 500 <table class="memname">
Chris@1 501 <tr>
Chris@6 502 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> PercussionOnsetDetector::getInputDomain </td>
Chris@1 503 <td>(</td>
Chris@1 504 <td class="paramname"></td><td>)</td>
Chris@6 505 <td> const</td>
Chris@1 506 </tr>
Chris@1 507 </table>
Chris@6 508 </td>
Chris@6 509 <td class="mlabels-right">
Chris@6 510 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
Chris@6 511 </tr>
Chris@6 512 </table>
Chris@6 513 </div><div class="memdoc">
Chris@1 514
Chris@1 515 <p>Get the plugin's required input domain. </p>
Chris@6 516 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data. ">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin.</p>
Chris@6 517 <p>If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data. ">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type &ndash; the host will either let the user do so, or will use a Hanning window. </p>
Chris@1 518
Chris@1 519 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
Chris@1 520
Chris@6 521 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">55</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 522
Chris@6 523 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::FrequencyDomain</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00095">getCopyright()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00077">getDescription()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00065">getIdentifier()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00083">getMaker()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00071">getName()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00174">getParameter()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00089">getPluginVersion()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00107">getPreferredBlockSize()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00101">getPreferredStepSize()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00283">getRemainingFeatures()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00182">setParameter()</a>.</p>
Chris@1 524
Chris@1 525 </div>
Chris@1 526 </div>
Chris@6 527 <a id="ac1bb968a3632083e55e4d236310b9cdb"></a>
Chris@6 528 <h2 class="memtitle"><span class="permalink"><a href="#ac1bb968a3632083e55e4d236310b9cdb">&#9670;&nbsp;</a></span>getIdentifier()</h2>
Chris@6 529
Chris@1 530 <div class="memitem">
Chris@1 531 <div class="memproto">
Chris@6 532 <table class="mlabels">
Chris@6 533 <tr>
Chris@6 534 <td class="mlabels-left">
Chris@1 535 <table class="memname">
Chris@1 536 <tr>
Chris@6 537 <td class="memname">string PercussionOnsetDetector::getIdentifier </td>
Chris@1 538 <td>(</td>
Chris@1 539 <td class="paramname"></td><td>)</td>
Chris@6 540 <td> const</td>
Chris@1 541 </tr>
Chris@1 542 </table>
Chris@6 543 </td>
Chris@6 544 <td class="mlabels-right">
Chris@6 545 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 546 </tr>
Chris@6 547 </table>
Chris@6 548 </div><div class="memdoc">
Chris@1 549
Chris@1 550 <p>Get the computer-usable name of the plugin. </p>
Chris@1 551 <p>This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.</p>
Chris@1 552 <p>This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).</p>
Chris@1 553 <p>Example: "zero_crossings" </p>
Chris@1 554
Chris@1 555 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
Chris@1 556
Chris@6 557 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00065">65</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 558
Chris@6 559 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 560
Chris@1 561 </div>
Chris@1 562 </div>
Chris@6 563 <a id="a9b8532bfd1a6053682db3ce15b1890da"></a>
Chris@6 564 <h2 class="memtitle"><span class="permalink"><a href="#a9b8532bfd1a6053682db3ce15b1890da">&#9670;&nbsp;</a></span>getName()</h2>
Chris@6 565
Chris@1 566 <div class="memitem">
Chris@1 567 <div class="memproto">
Chris@6 568 <table class="mlabels">
Chris@6 569 <tr>
Chris@6 570 <td class="mlabels-left">
Chris@1 571 <table class="memname">
Chris@1 572 <tr>
Chris@6 573 <td class="memname">string PercussionOnsetDetector::getName </td>
Chris@1 574 <td>(</td>
Chris@1 575 <td class="paramname"></td><td>)</td>
Chris@6 576 <td> const</td>
Chris@1 577 </tr>
Chris@1 578 </table>
Chris@6 579 </td>
Chris@6 580 <td class="mlabels-right">
Chris@6 581 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 582 </tr>
Chris@6 583 </table>
Chris@6 584 </div><div class="memdoc">
Chris@1 585
Chris@1 586 <p>Get a human-readable name or title of the plugin. </p>
Chris@1 587 <p>This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").</p>
Chris@1 588 <p>Example: "Zero Crossings" </p>
Chris@1 589
Chris@1 590 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
Chris@1 591
Chris@6 592 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00071">71</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 593
Chris@6 594 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 595
Chris@1 596 </div>
Chris@1 597 </div>
Chris@6 598 <a id="a4ea74f76e302c53ced7508bc8388487b"></a>
Chris@6 599 <h2 class="memtitle"><span class="permalink"><a href="#a4ea74f76e302c53ced7508bc8388487b">&#9670;&nbsp;</a></span>getDescription()</h2>
Chris@6 600
Chris@1 601 <div class="memitem">
Chris@1 602 <div class="memproto">
Chris@6 603 <table class="mlabels">
Chris@6 604 <tr>
Chris@6 605 <td class="mlabels-left">
Chris@1 606 <table class="memname">
Chris@1 607 <tr>
Chris@6 608 <td class="memname">string PercussionOnsetDetector::getDescription </td>
Chris@1 609 <td>(</td>
Chris@1 610 <td class="paramname"></td><td>)</td>
Chris@6 611 <td> const</td>
Chris@1 612 </tr>
Chris@1 613 </table>
Chris@6 614 </td>
Chris@6 615 <td class="mlabels-right">
Chris@6 616 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 617 </tr>
Chris@6 618 </table>
Chris@6 619 </div><div class="memdoc">
Chris@1 620
Chris@1 621 <p>Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p>
Chris@1 622 <p>May be empty if the name has said it all already.</p>
Chris@1 623 <p>Example: "Detect and count zero crossing points" </p>
Chris@1 624
Chris@1 625 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
Chris@1 626
Chris@6 627 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00077">77</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 628
Chris@6 629 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 630
Chris@1 631 </div>
Chris@1 632 </div>
Chris@6 633 <a id="a1ef108aac025c3f2c3201fd9f43b6a6b"></a>
Chris@6 634 <h2 class="memtitle"><span class="permalink"><a href="#a1ef108aac025c3f2c3201fd9f43b6a6b">&#9670;&nbsp;</a></span>getMaker()</h2>
Chris@6 635
Chris@1 636 <div class="memitem">
Chris@1 637 <div class="memproto">
Chris@6 638 <table class="mlabels">
Chris@6 639 <tr>
Chris@6 640 <td class="mlabels-left">
Chris@1 641 <table class="memname">
Chris@1 642 <tr>
Chris@6 643 <td class="memname">string PercussionOnsetDetector::getMaker </td>
Chris@1 644 <td>(</td>
Chris@1 645 <td class="paramname"></td><td>)</td>
Chris@6 646 <td> const</td>
Chris@1 647 </tr>
Chris@1 648 </table>
Chris@6 649 </td>
Chris@6 650 <td class="mlabels-right">
Chris@6 651 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 652 </tr>
Chris@6 653 </table>
Chris@6 654 </div><div class="memdoc">
Chris@1 655
Chris@1 656 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
Chris@1 657 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
Chris@1 658
Chris@1 659 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
Chris@1 660
Chris@6 661 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00083">83</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 662
Chris@6 663 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 664
Chris@1 665 </div>
Chris@1 666 </div>
Chris@6 667 <a id="ad4f4a732e9e0ae0cb0151e2e10862299"></a>
Chris@6 668 <h2 class="memtitle"><span class="permalink"><a href="#ad4f4a732e9e0ae0cb0151e2e10862299">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
Chris@6 669
Chris@1 670 <div class="memitem">
Chris@1 671 <div class="memproto">
Chris@6 672 <table class="mlabels">
Chris@6 673 <tr>
Chris@6 674 <td class="mlabels-left">
Chris@1 675 <table class="memname">
Chris@1 676 <tr>
Chris@6 677 <td class="memname">int PercussionOnsetDetector::getPluginVersion </td>
Chris@1 678 <td>(</td>
Chris@1 679 <td class="paramname"></td><td>)</td>
Chris@6 680 <td> const</td>
Chris@1 681 </tr>
Chris@1 682 </table>
Chris@6 683 </td>
Chris@6 684 <td class="mlabels-right">
Chris@6 685 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 686 </tr>
Chris@6 687 </table>
Chris@6 688 </div><div class="memdoc">
Chris@1 689
Chris@1 690 <p>Get the version number of the plugin. </p>
Chris@1 691
Chris@1 692 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
Chris@1 693
Chris@6 694 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00089">89</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 695
Chris@6 696 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 697
Chris@1 698 </div>
Chris@1 699 </div>
Chris@6 700 <a id="acf9ac12b8f313aa6fad58ad2fed663da"></a>
Chris@6 701 <h2 class="memtitle"><span class="permalink"><a href="#acf9ac12b8f313aa6fad58ad2fed663da">&#9670;&nbsp;</a></span>getCopyright()</h2>
Chris@6 702
Chris@1 703 <div class="memitem">
Chris@1 704 <div class="memproto">
Chris@6 705 <table class="mlabels">
Chris@6 706 <tr>
Chris@6 707 <td class="mlabels-left">
Chris@1 708 <table class="memname">
Chris@1 709 <tr>
Chris@6 710 <td class="memname">string PercussionOnsetDetector::getCopyright </td>
Chris@1 711 <td>(</td>
Chris@1 712 <td class="paramname"></td><td>)</td>
Chris@6 713 <td> const</td>
Chris@1 714 </tr>
Chris@1 715 </table>
Chris@6 716 </td>
Chris@6 717 <td class="mlabels-right">
Chris@6 718 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 719 </tr>
Chris@6 720 </table>
Chris@6 721 </div><div class="memdoc">
Chris@1 722
Chris@1 723 <p>Get the copyright statement or licensing summary for the plugin. </p>
Chris@1 724 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
Chris@1 725
Chris@1 726 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
Chris@1 727
Chris@6 728 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00095">95</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 729
Chris@6 730 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 731
Chris@1 732 </div>
Chris@1 733 </div>
Chris@6 734 <a id="a0ad851545302fc87e8226104584667a0"></a>
Chris@6 735 <h2 class="memtitle"><span class="permalink"><a href="#a0ad851545302fc87e8226104584667a0">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
Chris@6 736
Chris@1 737 <div class="memitem">
Chris@1 738 <div class="memproto">
Chris@6 739 <table class="mlabels">
Chris@6 740 <tr>
Chris@6 741 <td class="mlabels-left">
Chris@1 742 <table class="memname">
Chris@1 743 <tr>
Chris@6 744 <td class="memname">size_t PercussionOnsetDetector::getPreferredStepSize </td>
Chris@1 745 <td>(</td>
Chris@1 746 <td class="paramname"></td><td>)</td>
Chris@6 747 <td> const</td>
Chris@1 748 </tr>
Chris@1 749 </table>
Chris@6 750 </td>
Chris@6 751 <td class="mlabels-right">
Chris@6 752 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 753 </tr>
Chris@6 754 </table>
Chris@6 755 </div><div class="memdoc">
Chris@1 756
Chris@6 757 <p>Get the preferred step size (window increment &ndash; the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
Chris@6 758 <p>This should be called before <a class="el" 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). ">initialise()</a>.</p>
Chris@6 759 <p>A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" 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). ">initialise()</a> call. </p>
Chris@1 760
Chris@6 761 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2">Vamp::Plugin</a>.</p>
Chris@1 762
Chris@6 763 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00101">101</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 764
Chris@6 765 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 766
Chris@1 767 </div>
Chris@1 768 </div>
Chris@6 769 <a id="abacdc27486aab9b37d1a51e35e6a9444"></a>
Chris@6 770 <h2 class="memtitle"><span class="permalink"><a href="#abacdc27486aab9b37d1a51e35e6a9444">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
Chris@6 771
Chris@1 772 <div class="memitem">
Chris@1 773 <div class="memproto">
Chris@6 774 <table class="mlabels">
Chris@6 775 <tr>
Chris@6 776 <td class="mlabels-left">
Chris@1 777 <table class="memname">
Chris@1 778 <tr>
Chris@6 779 <td class="memname">size_t PercussionOnsetDetector::getPreferredBlockSize </td>
Chris@1 780 <td>(</td>
Chris@1 781 <td class="paramname"></td><td>)</td>
Chris@6 782 <td> const</td>
Chris@1 783 </tr>
Chris@1 784 </table>
Chris@6 785 </td>
Chris@6 786 <td class="mlabels-right">
Chris@6 787 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 788 </tr>
Chris@6 789 </table>
Chris@6 790 </div><div class="memdoc">
Chris@1 791
Chris@6 792 <p>Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data. ">process()</a> function). </p>
Chris@6 793 <p>This should be called before <a class="el" 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). ">initialise()</a>.</p>
Chris@6 794 <p>A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" 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). ">initialise()</a> call. </p>
Chris@1 795
Chris@6 796 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d">Vamp::Plugin</a>.</p>
Chris@1 797
Chris@6 798 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00107">107</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 799
Chris@6 800 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 801
Chris@1 802 </div>
Chris@1 803 </div>
Chris@6 804 <a id="ae1cc81d82aaac8db5cf8a1067494f3d8"></a>
Chris@6 805 <h2 class="memtitle"><span class="permalink"><a href="#ae1cc81d82aaac8db5cf8a1067494f3d8">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
Chris@6 806
Chris@1 807 <div class="memitem">
Chris@1 808 <div class="memproto">
Chris@6 809 <table class="mlabels">
Chris@6 810 <tr>
Chris@6 811 <td class="mlabels-left">
Chris@1 812 <table class="memname">
Chris@1 813 <tr>
Chris@6 814 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">PercussionOnsetDetector::ParameterList</a> PercussionOnsetDetector::getParameterDescriptors </td>
Chris@1 815 <td>(</td>
Chris@1 816 <td class="paramname"></td><td>)</td>
Chris@6 817 <td> const</td>
Chris@1 818 </tr>
Chris@1 819 </table>
Chris@6 820 </td>
Chris@6 821 <td class="mlabels-right">
Chris@6 822 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 823 </tr>
Chris@6 824 </table>
Chris@6 825 </div><div class="memdoc">
Chris@1 826
Chris@1 827 <p>Get the controllable parameters of this plugin. </p>
Chris@1 828
Chris@6 829 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">Vamp::PluginBase</a>.</p>
Chris@1 830
Chris@6 831 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">145</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 832
Chris@6 833 <p class="reference">References <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00167">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00144">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00133">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00173">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00159">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00154">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00138">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00149">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p>
Chris@6 834
Chris@6 835 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 836
Chris@1 837 </div>
Chris@1 838 </div>
Chris@6 839 <a id="accce70a87d6b30d4696d40a3e09b8f17"></a>
Chris@6 840 <h2 class="memtitle"><span class="permalink"><a href="#accce70a87d6b30d4696d40a3e09b8f17">&#9670;&nbsp;</a></span>getParameter()</h2>
Chris@6 841
Chris@1 842 <div class="memitem">
Chris@1 843 <div class="memproto">
Chris@6 844 <table class="mlabels">
Chris@6 845 <tr>
Chris@6 846 <td class="mlabels-left">
Chris@1 847 <table class="memname">
Chris@1 848 <tr>
Chris@6 849 <td class="memname">float PercussionOnsetDetector::getParameter </td>
Chris@1 850 <td>(</td>
Chris@1 851 <td class="paramtype">std::string&#160;</td>
Chris@1 852 <td class="paramname"></td><td>)</td>
Chris@6 853 <td> const</td>
Chris@1 854 </tr>
Chris@1 855 </table>
Chris@6 856 </td>
Chris@6 857 <td class="mlabels-right">
Chris@6 858 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 859 </tr>
Chris@6 860 </table>
Chris@6 861 </div><div class="memdoc">
Chris@1 862
Chris@1 863 <p>Get the value of a named parameter. </p>
Chris@1 864 <p>The argument is the identifier field from that parameter's descriptor. </p>
Chris@1 865
Chris@6 866 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">Vamp::PluginBase</a>.</p>
Chris@1 867
Chris@6 868 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00174">174</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 869
Chris@6 870 <p class="reference">References <a class="el" href="PercussionOnsetDetector_8h_source.html#l00083">m_sensitivity</a>, and <a class="el" href="PercussionOnsetDetector_8h_source.html#l00082">m_threshold</a>.</p>
Chris@6 871
Chris@6 872 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 873
Chris@1 874 </div>
Chris@1 875 </div>
Chris@6 876 <a id="aa097d72488e1211f05fc661ff5c6dc01"></a>
Chris@6 877 <h2 class="memtitle"><span class="permalink"><a href="#aa097d72488e1211f05fc661ff5c6dc01">&#9670;&nbsp;</a></span>setParameter()</h2>
Chris@6 878
Chris@1 879 <div class="memitem">
Chris@1 880 <div class="memproto">
Chris@6 881 <table class="mlabels">
Chris@6 882 <tr>
Chris@6 883 <td class="mlabels-left">
Chris@1 884 <table class="memname">
Chris@1 885 <tr>
Chris@6 886 <td class="memname">void PercussionOnsetDetector::setParameter </td>
Chris@1 887 <td>(</td>
Chris@1 888 <td class="paramtype">std::string&#160;</td>
Chris@1 889 <td class="paramname">, </td>
Chris@1 890 </tr>
Chris@1 891 <tr>
Chris@1 892 <td class="paramkey"></td>
Chris@1 893 <td></td>
Chris@1 894 <td class="paramtype">float&#160;</td>
Chris@1 895 <td class="paramname">&#160;</td>
Chris@1 896 </tr>
Chris@1 897 <tr>
Chris@1 898 <td></td>
Chris@1 899 <td>)</td>
Chris@6 900 <td></td><td></td>
Chris@1 901 </tr>
Chris@1 902 </table>
Chris@6 903 </td>
Chris@6 904 <td class="mlabels-right">
Chris@6 905 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 906 </tr>
Chris@6 907 </table>
Chris@6 908 </div><div class="memdoc">
Chris@1 909
Chris@1 910 <p>Set a named parameter. </p>
Chris@1 911 <p>The first argument is the identifier field from that parameter's descriptor. </p>
Chris@1 912
Chris@1 913 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
Chris@1 914
Chris@6 915 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00182">182</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 916
Chris@6 917 <p class="reference">References <a class="el" href="PercussionOnsetDetector_8h_source.html#l00083">m_sensitivity</a>, and <a class="el" href="PercussionOnsetDetector_8h_source.html#l00082">m_threshold</a>.</p>
Chris@6 918
Chris@6 919 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 920
Chris@1 921 </div>
Chris@1 922 </div>
Chris@6 923 <a id="a9518f60b3b0bf6c31c51c0aaffc599c9"></a>
Chris@6 924 <h2 class="memtitle"><span class="permalink"><a href="#a9518f60b3b0bf6c31c51c0aaffc599c9">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
Chris@6 925
Chris@1 926 <div class="memitem">
Chris@1 927 <div class="memproto">
Chris@6 928 <table class="mlabels">
Chris@6 929 <tr>
Chris@6 930 <td class="mlabels-left">
Chris@1 931 <table class="memname">
Chris@1 932 <tr>
Chris@6 933 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">PercussionOnsetDetector::OutputList</a> PercussionOnsetDetector::getOutputDescriptors </td>
Chris@1 934 <td>(</td>
Chris@1 935 <td class="paramname"></td><td>)</td>
Chris@6 936 <td> const</td>
Chris@1 937 </tr>
Chris@1 938 </table>
Chris@6 939 </td>
Chris@6 940 <td class="mlabels-right">
Chris@6 941 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 942 </tr>
Chris@6 943 </table>
Chris@6 944 </div><div class="memdoc">
Chris@1 945
Chris@1 946 <p>Get the outputs of this plugin. </p>
Chris@6 947 <p>An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614" title="Process a single block of input data. ">process()</a> call. </p>
Chris@1 948
Chris@1 949 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
Chris@1 950
Chris@6 951 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">196</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 952
Chris@6 953 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00247">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00227">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00239">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00260">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00214">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00278">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00220">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00290">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00285">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00314">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">Vamp::Plugin::OutputDescriptor::unit</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00296">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p>
Chris@6 954
Chris@6 955 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 956
Chris@1 957 </div>
Chris@1 958 </div>
Chris@6 959 <a id="adfd989812b3e0cb8f4b498f56a5a9614"></a>
Chris@6 960 <h2 class="memtitle"><span class="permalink"><a href="#adfd989812b3e0cb8f4b498f56a5a9614">&#9670;&nbsp;</a></span>process()</h2>
Chris@6 961
Chris@1 962 <div class="memitem">
Chris@1 963 <div class="memproto">
Chris@6 964 <table class="mlabels">
Chris@6 965 <tr>
Chris@6 966 <td class="mlabels-left">
Chris@1 967 <table class="memname">
Chris@1 968 <tr>
Chris@6 969 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a> PercussionOnsetDetector::process </td>
Chris@1 970 <td>(</td>
Chris@1 971 <td class="paramtype">const float *const *&#160;</td>
Chris@1 972 <td class="paramname"><em>inputBuffers</em>, </td>
Chris@1 973 </tr>
Chris@1 974 <tr>
Chris@1 975 <td class="paramkey"></td>
Chris@1 976 <td></td>
Chris@1 977 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
Chris@1 978 <td class="paramname"><em>timestamp</em>&#160;</td>
Chris@1 979 </tr>
Chris@1 980 <tr>
Chris@1 981 <td></td>
Chris@1 982 <td>)</td>
Chris@6 983 <td></td><td></td>
Chris@1 984 </tr>
Chris@1 985 </table>
Chris@6 986 </td>
Chris@6 987 <td class="mlabels-right">
Chris@6 988 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 989 </tr>
Chris@6 990 </table>
Chris@6 991 </div><div class="memdoc">
Chris@1 992
Chris@1 993 <p>Process a single block of input data. </p>
Chris@1 994 <p>If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp in this case will be the real time in seconds of the start of the supplied block of samples.</p>
Chris@1 995 <p>If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p>
Chris@1 996 <p>Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.) </p>
Chris@1 997
Chris@1 998 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
Chris@1 999
Chris@6 1000 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">226</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@1 1001
Chris@6 1002 <p class="reference">References <a class="el" href="structVamp_1_1RealTime.html#a939b4b1d1ca190db69a418883f16ce8a">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00352">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00080">m_blockSize</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00085">m_dfMinus1</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00086">m_dfMinus2</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00084">m_priorMagnitudes</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00083">m_sensitivity</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00079">m_stepSize</a>, <a class="el" href="PercussionOnsetDetector_8h_source.html#l00082">m_threshold</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00360">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00382">Vamp::Plugin::Feature::values</a>.</p>
Chris@6 1003
Chris@6 1004 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 1005
Chris@1 1006 </div>
Chris@1 1007 </div>
Chris@6 1008 <a id="ad3d6767ed137783e84f842b4d4732ffa"></a>
Chris@6 1009 <h2 class="memtitle"><span class="permalink"><a href="#ad3d6767ed137783e84f842b4d4732ffa">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
Chris@6 1010
Chris@1 1011 <div class="memitem">
Chris@1 1012 <div class="memproto">
Chris@6 1013 <table class="mlabels">
Chris@6 1014 <tr>
Chris@6 1015 <td class="mlabels-left">
Chris@1 1016 <table class="memname">
Chris@1 1017 <tr>
Chris@6 1018 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">PercussionOnsetDetector::FeatureSet</a> PercussionOnsetDetector::getRemainingFeatures </td>
Chris@1 1019 <td>(</td>
Chris@1 1020 <td class="paramname"></td><td>)</td>
Chris@6 1021 <td></td>
Chris@1 1022 </tr>
Chris@1 1023 </table>
Chris@6 1024 </td>
Chris@6 1025 <td class="mlabels-right">
Chris@6 1026 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 1027 </tr>
Chris@6 1028 </table>
Chris@6 1029 </div><div class="memdoc">
Chris@1 1030
Chris@1 1031 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
Chris@1 1032
Chris@1 1033 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
Chris@1 1034
Chris@6 1035 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00283">283</a> of file <a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a>.</p>
Chris@6 1036
Chris@6 1037 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8h_source.html#l00055">getInputDomain()</a>.</p>
Chris@1 1038
Chris@1 1039 </div>
Chris@1 1040 </div>
Chris@6 1041 <a id="ab74f7634c6ac6e3da115667808a79c30"></a>
Chris@6 1042 <h2 class="memtitle"><span class="permalink"><a href="#ab74f7634c6ac6e3da115667808a79c30">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
Chris@6 1043
Chris@1 1044 <div class="memitem">
Chris@1 1045 <div class="memproto">
Chris@6 1046 <table class="mlabels">
Chris@6 1047 <tr>
Chris@6 1048 <td class="mlabels-left">
Chris@1 1049 <table class="memname">
Chris@1 1050 <tr>
Chris@6 1051 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
Chris@1 1052 <td>(</td>
Chris@1 1053 <td class="paramname"></td><td>)</td>
Chris@6 1054 <td> const</td>
Chris@1 1055 </tr>
Chris@1 1056 </table>
Chris@6 1057 </td>
Chris@6 1058 <td class="mlabels-right">
Chris@6 1059 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1060 </tr>
Chris@6 1061 </table>
Chris@6 1062 </div><div class="memdoc">
Chris@1 1063
Chris@1 1064 <p>Get the minimum supported number of input channels. </p>
Chris@1 1065
Chris@6 1066 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8e7f62e03adea0321080839f6ef6c77b">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#abc0a4e6ce0ae9de39c40725de1f30d2f">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1067
Chris@6 1068 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1069
Chris@6 1070 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
Chris@1 1071
Chris@1 1072 </div>
Chris@1 1073 </div>
Chris@6 1074 <a id="a0bff9464bc8c117470136c396b2405dd"></a>
Chris@6 1075 <h2 class="memtitle"><span class="permalink"><a href="#a0bff9464bc8c117470136c396b2405dd">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
Chris@6 1076
Chris@1 1077 <div class="memitem">
Chris@1 1078 <div class="memproto">
Chris@6 1079 <table class="mlabels">
Chris@6 1080 <tr>
Chris@6 1081 <td class="mlabels-left">
Chris@1 1082 <table class="memname">
Chris@1 1083 <tr>
Chris@6 1084 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
Chris@1 1085 <td>(</td>
Chris@1 1086 <td class="paramname"></td><td>)</td>
Chris@6 1087 <td> const</td>
Chris@1 1088 </tr>
Chris@1 1089 </table>
Chris@6 1090 </td>
Chris@6 1091 <td class="mlabels-right">
Chris@6 1092 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1093 </tr>
Chris@6 1094 </table>
Chris@6 1095 </div><div class="memdoc">
Chris@1 1096
Chris@1 1097 <p>Get the maximum supported number of input channels. </p>
Chris@1 1098
Chris@6 1099 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a626ad6e35eb0f4ed93bc3c6d976cdca4">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#acfed040cd91e797ee89d077db22b4a97">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1100
Chris@6 1101 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1102
Chris@6 1103 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
Chris@1 1104
Chris@1 1105 </div>
Chris@1 1106 </div>
Chris@6 1107 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
Chris@6 1108 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
Chris@6 1109
Chris@1 1110 <div class="memitem">
Chris@1 1111 <div class="memproto">
Chris@6 1112 <table class="mlabels">
Chris@6 1113 <tr>
Chris@6 1114 <td class="mlabels-left">
Chris@1 1115 <table class="memname">
Chris@1 1116 <tr>
Chris@6 1117 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
Chris@1 1118 <td>(</td>
Chris@1 1119 <td class="paramname"></td><td>)</td>
Chris@6 1120 <td> const</td>
Chris@1 1121 </tr>
Chris@1 1122 </table>
Chris@6 1123 </td>
Chris@6 1124 <td class="mlabels-right">
Chris@6 1125 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1126 </tr>
Chris@6 1127 </table>
Chris@6 1128 </div><div class="memdoc">
Chris@1 1129
Chris@6 1130 <p>Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> and other potential sibling subclasses of PluginBase. </p>
Chris@1 1131 <p>Do not reimplement this function in your subclass. </p>
Chris@1 1132
Chris@1 1133 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
Chris@1 1134
Chris@6 1135 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00438">438</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1136
Chris@1 1137 </div>
Chris@1 1138 </div>
Chris@6 1139 <a id="ab4aa9c3e6f6dd9addbc095463c9fb772"></a>
Chris@6 1140 <h2 class="memtitle"><span class="permalink"><a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
Chris@6 1141
Chris@1 1142 <div class="memitem">
Chris@1 1143 <div class="memproto">
Chris@6 1144 <table class="mlabels">
Chris@6 1145 <tr>
Chris@6 1146 <td class="mlabels-left">
Chris@1 1147 <table class="memname">
Chris@1 1148 <tr>
Chris@6 1149 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
Chris@1 1150 <td>(</td>
Chris@1 1151 <td class="paramname"></td><td>)</td>
Chris@6 1152 <td> const</td>
Chris@1 1153 </tr>
Chris@1 1154 </table>
Chris@6 1155 </td>
Chris@6 1156 <td class="mlabels-right">
Chris@6 1157 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1158 </tr>
Chris@6 1159 </table>
Chris@6 1160 </div><div class="memdoc">
Chris@1 1161
Chris@1 1162 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
Chris@1 1163
Chris@6 1164 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#adc708325d057516bd92d5ea1c0808dbc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#afa79272f991fb720ddd09784be1b3cb8">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1165
Chris@6 1166 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 1167
Chris@6 1168 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
Chris@1 1169
Chris@1 1170 </div>
Chris@1 1171 </div>
Chris@6 1172 <a id="aaf6febff0ab4daf4a5089c98a67f4df8"></a>
Chris@6 1173 <h2 class="memtitle"><span class="permalink"><a href="#aaf6febff0ab4daf4a5089c98a67f4df8">&#9670;&nbsp;</a></span>getPrograms()</h2>
Chris@6 1174
Chris@1 1175 <div class="memitem">
Chris@1 1176 <div class="memproto">
Chris@6 1177 <table class="mlabels">
Chris@6 1178 <tr>
Chris@6 1179 <td class="mlabels-left">
Chris@1 1180 <table class="memname">
Chris@1 1181 <tr>
Chris@6 1182 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
Chris@1 1183 <td>(</td>
Chris@1 1184 <td class="paramname"></td><td>)</td>
Chris@6 1185 <td> const</td>
Chris@1 1186 </tr>
Chris@1 1187 </table>
Chris@6 1188 </td>
Chris@6 1189 <td class="mlabels-right">
Chris@6 1190 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1191 </tr>
Chris@6 1192 </table>
Chris@6 1193 </div><div class="memdoc">
Chris@1 1194
Chris@1 1195 <p>Get the program settings available in this plugin. </p>
Chris@1 1196 <p>A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.</p>
Chris@1 1197 <p>The programs must have unique names. </p>
Chris@1 1198
Chris@6 1199 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a1e3c40e9b9d8dc876d2e732976950c4b">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa0b72ea17766266d20539f293ccae7c8">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1200
Chris@6 1201 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00237">237</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 1202
Chris@1 1203 </div>
Chris@1 1204 </div>
Chris@6 1205 <a id="aac38c5dc6e87208616122897518ca3d5"></a>
Chris@6 1206 <h2 class="memtitle"><span class="permalink"><a href="#aac38c5dc6e87208616122897518ca3d5">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
Chris@6 1207
Chris@1 1208 <div class="memitem">
Chris@1 1209 <div class="memproto">
Chris@6 1210 <table class="mlabels">
Chris@6 1211 <tr>
Chris@6 1212 <td class="mlabels-left">
Chris@1 1213 <table class="memname">
Chris@1 1214 <tr>
Chris@6 1215 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
Chris@1 1216 <td>(</td>
Chris@1 1217 <td class="paramname"></td><td>)</td>
Chris@6 1218 <td> const</td>
Chris@1 1219 </tr>
Chris@1 1220 </table>
Chris@6 1221 </td>
Chris@6 1222 <td class="mlabels-right">
Chris@6 1223 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1224 </tr>
Chris@6 1225 </table>
Chris@6 1226 </div><div class="memdoc">
Chris@1 1227
Chris@1 1228 <p>Get the current program. </p>
Chris@1 1229
Chris@6 1230 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#abf984c347c4dac9e4b01123498bfe68f">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a3936fe2c4b3c960dd244849a7c3320ad">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1231
Chris@6 1232 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00242">242</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 1233
Chris@1 1234 </div>
Chris@1 1235 </div>
Chris@6 1236 <a id="aadd3a547ef140bae200473a9518e3353"></a>
Chris@6 1237 <h2 class="memtitle"><span class="permalink"><a href="#aadd3a547ef140bae200473a9518e3353">&#9670;&nbsp;</a></span>selectProgram()</h2>
Chris@6 1238
Chris@1 1239 <div class="memitem">
Chris@1 1240 <div class="memproto">
Chris@6 1241 <table class="mlabels">
Chris@6 1242 <tr>
Chris@6 1243 <td class="mlabels-left">
Chris@1 1244 <table class="memname">
Chris@1 1245 <tr>
Chris@6 1246 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
Chris@1 1247 <td>(</td>
Chris@1 1248 <td class="paramtype">std::string&#160;</td>
Chris@1 1249 <td class="paramname"></td><td>)</td>
Chris@6 1250 <td></td>
Chris@1 1251 </tr>
Chris@1 1252 </table>
Chris@6 1253 </td>
Chris@6 1254 <td class="mlabels-right">
Chris@6 1255 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1256 </tr>
Chris@6 1257 </table>
Chris@6 1258 </div><div class="memdoc">
Chris@1 1259
Chris@1 1260 <p>Select a program. </p>
Chris@1 1261 <p>(If the given program name is not one of the available programs, do nothing.) </p>
Chris@1 1262
Chris@1 1263 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
Chris@1 1264
Chris@6 1265 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00248">248</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@6 1266
Chris@6 1267 <p class="reference">References <a class="el" href="plugguard_8h_source.html#l00080">_VAMP_SDK_PLUGSPACE_END</a>.</p>
Chris@1 1268
Chris@1 1269 </div>
Chris@1 1270 </div>
Chris@6 1271 <h2 class="groupheader">Member Data Documentation</h2>
Chris@6 1272 <a id="aabac0cf7e961482b075777e5f0686e6c"></a>
Chris@6 1273 <h2 class="memtitle"><span class="permalink"><a href="#aabac0cf7e961482b075777e5f0686e6c">&#9670;&nbsp;</a></span>m_stepSize</h2>
Chris@6 1274
Chris@1 1275 <div class="memitem">
Chris@1 1276 <div class="memproto">
Chris@6 1277 <table class="mlabels">
Chris@6 1278 <tr>
Chris@6 1279 <td class="mlabels-left">
Chris@1 1280 <table class="memname">
Chris@1 1281 <tr>
Chris@6 1282 <td class="memname">size_t PercussionOnsetDetector::m_stepSize</td>
Chris@1 1283 </tr>
Chris@1 1284 </table>
Chris@6 1285 </td>
Chris@6 1286 <td class="mlabels-right">
Chris@6 1287 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1288 </tr>
Chris@6 1289 </table>
Chris@6 1290 </div><div class="memdoc">
Chris@1 1291
Chris@6 1292 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00079">79</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1293
Chris@6 1294 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>.</p>
Chris@1 1295
Chris@1 1296 </div>
Chris@1 1297 </div>
Chris@6 1298 <a id="a920de543dbcf70a2edd80b5b31313285"></a>
Chris@6 1299 <h2 class="memtitle"><span class="permalink"><a href="#a920de543dbcf70a2edd80b5b31313285">&#9670;&nbsp;</a></span>m_blockSize</h2>
Chris@6 1300
Chris@1 1301 <div class="memitem">
Chris@1 1302 <div class="memproto">
Chris@6 1303 <table class="mlabels">
Chris@6 1304 <tr>
Chris@6 1305 <td class="mlabels-left">
Chris@1 1306 <table class="memname">
Chris@1 1307 <tr>
Chris@6 1308 <td class="memname">size_t PercussionOnsetDetector::m_blockSize</td>
Chris@1 1309 </tr>
Chris@1 1310 </table>
Chris@6 1311 </td>
Chris@6 1312 <td class="mlabels-right">
Chris@6 1313 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1314 </tr>
Chris@6 1315 </table>
Chris@6 1316 </div><div class="memdoc">
Chris@1 1317
Chris@6 1318 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00080">80</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1319
Chris@6 1320 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">reset()</a>.</p>
Chris@1 1321
Chris@1 1322 </div>
Chris@1 1323 </div>
Chris@6 1324 <a id="ab04119adad56d87f2e633de289aab507"></a>
Chris@6 1325 <h2 class="memtitle"><span class="permalink"><a href="#ab04119adad56d87f2e633de289aab507">&#9670;&nbsp;</a></span>m_threshold</h2>
Chris@6 1326
Chris@1 1327 <div class="memitem">
Chris@1 1328 <div class="memproto">
Chris@6 1329 <table class="mlabels">
Chris@6 1330 <tr>
Chris@6 1331 <td class="mlabels-left">
Chris@1 1332 <table class="memname">
Chris@1 1333 <tr>
Chris@6 1334 <td class="memname">float PercussionOnsetDetector::m_threshold</td>
Chris@1 1335 </tr>
Chris@1 1336 </table>
Chris@6 1337 </td>
Chris@6 1338 <td class="mlabels-right">
Chris@6 1339 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1340 </tr>
Chris@6 1341 </table>
Chris@6 1342 </div><div class="memdoc">
Chris@1 1343
Chris@6 1344 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00082">82</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1345
Chris@6 1346 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00174">getParameter()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00182">setParameter()</a>.</p>
Chris@1 1347
Chris@1 1348 </div>
Chris@1 1349 </div>
Chris@6 1350 <a id="a4e9770f246ba3bc75e7fc2cb8f9010af"></a>
Chris@6 1351 <h2 class="memtitle"><span class="permalink"><a href="#a4e9770f246ba3bc75e7fc2cb8f9010af">&#9670;&nbsp;</a></span>m_sensitivity</h2>
Chris@6 1352
Chris@1 1353 <div class="memitem">
Chris@1 1354 <div class="memproto">
Chris@6 1355 <table class="mlabels">
Chris@6 1356 <tr>
Chris@6 1357 <td class="mlabels-left">
Chris@1 1358 <table class="memname">
Chris@1 1359 <tr>
Chris@6 1360 <td class="memname">float PercussionOnsetDetector::m_sensitivity</td>
Chris@1 1361 </tr>
Chris@1 1362 </table>
Chris@6 1363 </td>
Chris@6 1364 <td class="mlabels-right">
Chris@6 1365 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1366 </tr>
Chris@6 1367 </table>
Chris@6 1368 </div><div class="memdoc">
Chris@1 1369
Chris@6 1370 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00083">83</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1371
Chris@6 1372 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00174">getParameter()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00182">setParameter()</a>.</p>
Chris@1 1373
Chris@1 1374 </div>
Chris@1 1375 </div>
Chris@6 1376 <a id="a30daa717267251a9d49afe57c328e989"></a>
Chris@6 1377 <h2 class="memtitle"><span class="permalink"><a href="#a30daa717267251a9d49afe57c328e989">&#9670;&nbsp;</a></span>m_priorMagnitudes</h2>
Chris@6 1378
Chris@1 1379 <div class="memitem">
Chris@1 1380 <div class="memproto">
Chris@6 1381 <table class="mlabels">
Chris@6 1382 <tr>
Chris@6 1383 <td class="mlabels-left">
Chris@1 1384 <table class="memname">
Chris@1 1385 <tr>
Chris@6 1386 <td class="memname">float* PercussionOnsetDetector::m_priorMagnitudes</td>
Chris@1 1387 </tr>
Chris@1 1388 </table>
Chris@6 1389 </td>
Chris@6 1390 <td class="mlabels-right">
Chris@6 1391 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1392 </tr>
Chris@6 1393 </table>
Chris@6 1394 </div><div class="memdoc">
Chris@1 1395
Chris@6 1396 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00084">84</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1397
Chris@6 1398 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">reset()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00059">~PercussionOnsetDetector()</a>.</p>
Chris@1 1399
Chris@1 1400 </div>
Chris@1 1401 </div>
Chris@6 1402 <a id="acd80162c65212be7fa91251263fb9c3d"></a>
Chris@6 1403 <h2 class="memtitle"><span class="permalink"><a href="#acd80162c65212be7fa91251263fb9c3d">&#9670;&nbsp;</a></span>m_dfMinus1</h2>
Chris@6 1404
Chris@1 1405 <div class="memitem">
Chris@1 1406 <div class="memproto">
Chris@6 1407 <table class="mlabels">
Chris@6 1408 <tr>
Chris@6 1409 <td class="mlabels-left">
Chris@1 1410 <table class="memname">
Chris@1 1411 <tr>
Chris@6 1412 <td class="memname">float PercussionOnsetDetector::m_dfMinus1</td>
Chris@1 1413 </tr>
Chris@1 1414 </table>
Chris@6 1415 </td>
Chris@6 1416 <td class="mlabels-right">
Chris@6 1417 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1418 </tr>
Chris@6 1419 </table>
Chris@6 1420 </div><div class="memdoc">
Chris@1 1421
Chris@6 1422 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00085">85</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1423
Chris@6 1424 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">reset()</a>.</p>
Chris@1 1425
Chris@1 1426 </div>
Chris@1 1427 </div>
Chris@6 1428 <a id="a6ad7d8353cc681ff42a63b127cca5779"></a>
Chris@6 1429 <h2 class="memtitle"><span class="permalink"><a href="#a6ad7d8353cc681ff42a63b127cca5779">&#9670;&nbsp;</a></span>m_dfMinus2</h2>
Chris@6 1430
Chris@1 1431 <div class="memitem">
Chris@1 1432 <div class="memproto">
Chris@6 1433 <table class="mlabels">
Chris@6 1434 <tr>
Chris@6 1435 <td class="mlabels-left">
Chris@1 1436 <table class="memname">
Chris@1 1437 <tr>
Chris@6 1438 <td class="memname">float PercussionOnsetDetector::m_dfMinus2</td>
Chris@1 1439 </tr>
Chris@1 1440 </table>
Chris@6 1441 </td>
Chris@6 1442 <td class="mlabels-right">
Chris@6 1443 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1444 </tr>
Chris@6 1445 </table>
Chris@6 1446 </div><div class="memdoc">
Chris@1 1447
Chris@6 1448 <p class="definition">Definition at line <a class="el" href="PercussionOnsetDetector_8h_source.html#l00086">86</a> of file <a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>.</p>
Chris@1 1449
Chris@6 1450 <p class="reference">Referenced by <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00134">reset()</a>.</p>
Chris@1 1451
Chris@1 1452 </div>
Chris@1 1453 </div>
Chris@6 1454 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
Chris@6 1455 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
Chris@6 1456
Chris@1 1457 <div class="memitem">
Chris@1 1458 <div class="memproto">
Chris@6 1459 <table class="mlabels">
Chris@6 1460 <tr>
Chris@6 1461 <td class="mlabels-left">
Chris@1 1462 <table class="memname">
Chris@1 1463 <tr>
Chris@6 1464 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
Chris@1 1465 </tr>
Chris@1 1466 </table>
Chris@6 1467 </td>
Chris@6 1468 <td class="mlabels-right">
Chris@6 1469 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1470 </tr>
Chris@6 1471 </table>
Chris@6 1472 </div><div class="memdoc">
Chris@1 1473
Chris@6 1474 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">444</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 1475
Chris@6 1476 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">process()</a>.</p>
Chris@1 1477
Chris@1 1478 </div>
Chris@1 1479 </div>
Chris@1 1480 <hr/>The documentation for this class was generated from the following files:<ul>
Chris@1 1481 <li><a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a></li>
Chris@1 1482 <li><a class="el" href="PercussionOnsetDetector_8cpp_source.html">PercussionOnsetDetector.cpp</a></li>
Chris@1 1483 </ul>
Chris@3 1484 </div><!-- contents -->
Chris@6 1485 </div><!-- doc-content -->
Chris@6 1486 <!-- start footer part -->
Chris@6 1487 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 1488 <ul>
Chris@6 1489 <li class="navelem"><a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a></li>
Chris@6 1490 <li class="footer">Generated by
Chris@6 1491 <a href="http://www.doxygen.org/index.html">
Chris@6 1492 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 1493 </ul>
Chris@1 1494 </div>
Chris@1 1495 </body>
Chris@1 1496 </html>