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

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: ZeroCrossing 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('classZeroCrossing.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="classZeroCrossing-members.html">List of all members</a> </div>
Chris@1 67 <div class="headertitle">
Chris@1 68 <div class="title">ZeroCrossing 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 calculates the positions and density of zero-crossing points in an audio waveform.
Chris@1 73 <a href="classZeroCrossing.html#details">More...</a></p>
Chris@1 74
Chris@1 75 <p><code>#include &lt;<a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>&gt;</code></p>
Chris@1 76 <div class="dynheader">
Chris@1 77 Inheritance diagram for ZeroCrossing:</div>
Chris@1 78 <div class="dyncontent">
Chris@1 79 <div class="center"><img src="classZeroCrossing__inherit__graph.png" border="0" usemap="#ZeroCrossing_inherit__map" alt="Inheritance graph"/></div>
Chris@1 80 <map name="ZeroCrossing_inherit__map" id="ZeroCrossing_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="19,79,114,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="5,5,128,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:a9855153a54bdc9ba75cc1a705a149473"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a9855153a54bdc9ba75cc1a705a149473">ZeroCrossing</a> (float inputSampleRate)</td></tr>
Chris@6 106 <tr class="separator:a9855153a54bdc9ba75cc1a705a149473"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 107 <tr class="memitem:af1de0da862e6e2443581e4e16044675b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af1de0da862e6e2443581e4e16044675b">~ZeroCrossing</a> ()</td></tr>
Chris@6 108 <tr class="separator:af1de0da862e6e2443581e4e16044675b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 109 <tr class="memitem:af21bbcc87a6eb7875dfab7d86222dccc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
Chris@6 110 <tr class="memdesc:af21bbcc87a6eb7875dfab7d86222dccc"><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="#af21bbcc87a6eb7875dfab7d86222dccc">More...</a><br /></td></tr>
Chris@6 111 <tr class="separator:af21bbcc87a6eb7875dfab7d86222dccc"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 112 <tr class="memitem:a9ae6c4a31ea027dceb1e97ead807e228"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a9ae6c4a31ea027dceb1e97ead807e228">reset</a> ()</td></tr>
Chris@6 113 <tr class="memdesc:a9ae6c4a31ea027dceb1e97ead807e228"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a9ae6c4a31ea027dceb1e97ead807e228">More...</a><br /></td></tr>
Chris@6 114 <tr class="separator:a9ae6c4a31ea027dceb1e97ead807e228"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 115 <tr class="memitem:a2fd2cefbd1564e4d30ccabd64d6555e7"><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="classZeroCrossing.html#a2fd2cefbd1564e4d30ccabd64d6555e7">getInputDomain</a> () const</td></tr>
Chris@6 116 <tr class="memdesc:a2fd2cefbd1564e4d30ccabd64d6555e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a2fd2cefbd1564e4d30ccabd64d6555e7">More...</a><br /></td></tr>
Chris@6 117 <tr class="separator:a2fd2cefbd1564e4d30ccabd64d6555e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 118 <tr class="memitem:af5049a01a3f003f17a45c61b599c6543"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af5049a01a3f003f17a45c61b599c6543">getIdentifier</a> () const</td></tr>
Chris@6 119 <tr class="memdesc:af5049a01a3f003f17a45c61b599c6543"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#af5049a01a3f003f17a45c61b599c6543">More...</a><br /></td></tr>
Chris@6 120 <tr class="separator:af5049a01a3f003f17a45c61b599c6543"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 121 <tr class="memitem:a191365f793e6488d02d57029eb14deb2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a191365f793e6488d02d57029eb14deb2">getName</a> () const</td></tr>
Chris@6 122 <tr class="memdesc:a191365f793e6488d02d57029eb14deb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a191365f793e6488d02d57029eb14deb2">More...</a><br /></td></tr>
Chris@6 123 <tr class="separator:a191365f793e6488d02d57029eb14deb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 124 <tr class="memitem:a7ba1cfd102a427f8333ddfa2fe234d58"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a7ba1cfd102a427f8333ddfa2fe234d58">getDescription</a> () const</td></tr>
Chris@6 125 <tr class="memdesc:a7ba1cfd102a427f8333ddfa2fe234d58"><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="#a7ba1cfd102a427f8333ddfa2fe234d58">More...</a><br /></td></tr>
Chris@6 126 <tr class="separator:a7ba1cfd102a427f8333ddfa2fe234d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 127 <tr class="memitem:a9ddf295d977b6c64d8acd34b7e0ce1b0"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a9ddf295d977b6c64d8acd34b7e0ce1b0">getMaker</a> () const</td></tr>
Chris@6 128 <tr class="memdesc:a9ddf295d977b6c64d8acd34b7e0ce1b0"><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="#a9ddf295d977b6c64d8acd34b7e0ce1b0">More...</a><br /></td></tr>
Chris@6 129 <tr class="separator:a9ddf295d977b6c64d8acd34b7e0ce1b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 130 <tr class="memitem:a4199350192d84a4ec5f379805cd3e7cf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a4199350192d84a4ec5f379805cd3e7cf">getPluginVersion</a> () const</td></tr>
Chris@6 131 <tr class="memdesc:a4199350192d84a4ec5f379805cd3e7cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a4199350192d84a4ec5f379805cd3e7cf">More...</a><br /></td></tr>
Chris@6 132 <tr class="separator:a4199350192d84a4ec5f379805cd3e7cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 133 <tr class="memitem:af955fb85b26a5497690aecbd288975f2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af955fb85b26a5497690aecbd288975f2">getCopyright</a> () const</td></tr>
Chris@6 134 <tr class="memdesc:af955fb85b26a5497690aecbd288975f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#af955fb85b26a5497690aecbd288975f2">More...</a><br /></td></tr>
Chris@6 135 <tr class="separator:af955fb85b26a5497690aecbd288975f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 136 <tr class="memitem:ab83cfab3f9674920e295c2f3571bb24e"><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="classZeroCrossing.html#ab83cfab3f9674920e295c2f3571bb24e">getOutputDescriptors</a> () const</td></tr>
Chris@6 137 <tr class="memdesc:ab83cfab3f9674920e295c2f3571bb24e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#ab83cfab3f9674920e295c2f3571bb24e">More...</a><br /></td></tr>
Chris@6 138 <tr class="separator:ab83cfab3f9674920e295c2f3571bb24e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 139 <tr class="memitem:abf4aaa6fd8cc03de63f4e1e8942633da"><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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
Chris@6 140 <tr class="memdesc:abf4aaa6fd8cc03de63f4e1e8942633da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#abf4aaa6fd8cc03de63f4e1e8942633da">More...</a><br /></td></tr>
Chris@6 141 <tr class="separator:abf4aaa6fd8cc03de63f4e1e8942633da"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 142 <tr class="memitem:a70996d1b7166e303903daf92a9a37ad8"><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="classZeroCrossing.html#a70996d1b7166e303903daf92a9a37ad8">getRemainingFeatures</a> ()</td></tr>
Chris@6 143 <tr class="memdesc:a70996d1b7166e303903daf92a9a37ad8"><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="#a70996d1b7166e303903daf92a9a37ad8">More...</a><br /></td></tr>
Chris@6 144 <tr class="separator:a70996d1b7166e303903daf92a9a37ad8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 145 <tr class="memitem:ae3b9c32b12796ece152388babad7cc7d"><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#ae3b9c32b12796ece152388babad7cc7d">getPreferredBlockSize</a> () const</td></tr>
Chris@6 146 <tr class="memdesc:ae3b9c32b12796ece152388babad7cc7d"><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="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data. ">process()</a> function). <a href="#ae3b9c32b12796ece152388babad7cc7d">More...</a><br /></td></tr>
Chris@6 147 <tr class="separator:ae3b9c32b12796ece152388babad7cc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 148 <tr class="memitem:a33eaf9a265bc3a055e156452112456c2"><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#a33eaf9a265bc3a055e156452112456c2">getPreferredStepSize</a> () const</td></tr>
Chris@6 149 <tr class="memdesc:a33eaf9a265bc3a055e156452112456c2"><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="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data. ">process()</a> function) for the plugin. <a href="#a33eaf9a265bc3a055e156452112456c2">More...</a><br /></td></tr>
Chris@6 150 <tr class="separator:a33eaf9a265bc3a055e156452112456c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 151 <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 152 <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 153 <tr class="separator:ab74f7634c6ac6e3da115667808a79c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 154 <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 155 <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 156 <tr class="separator:a0bff9464bc8c117470136c396b2405dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 157 <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 158 <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 159 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 160 <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 161 <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 162 <tr class="separator:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 163 <tr class="memitem:a0c24ff6a43c681198dc9497287a26e3a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">getParameterDescriptors</a> () const</td></tr>
Chris@6 164 <tr class="memdesc:a0c24ff6a43c681198dc9497287a26e3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a0c24ff6a43c681198dc9497287a26e3a">More...</a><br /></td></tr>
Chris@6 165 <tr class="separator:a0c24ff6a43c681198dc9497287a26e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 166 <tr class="memitem:aa813d61077080ec95487d2a0227cc51b"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">getParameter</a> (std::string) const</td></tr>
Chris@6 167 <tr class="memdesc:aa813d61077080ec95487d2a0227cc51b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#aa813d61077080ec95487d2a0227cc51b">More...</a><br /></td></tr>
Chris@6 168 <tr class="separator:aa813d61077080ec95487d2a0227cc51b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 169 <tr class="memitem:a6c718ce822f7b73b98940d59dcaa9366"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr>
Chris@6 170 <tr class="memdesc:a6c718ce822f7b73b98940d59dcaa9366"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366">More...</a><br /></td></tr>
Chris@6 171 <tr class="separator:a6c718ce822f7b73b98940d59dcaa9366"><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:a584f100b87c78f9af9da040d79567d52"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">m_stepSize</a></td></tr>
Chris@6 185 <tr class="separator:a584f100b87c78f9af9da040d79567d52"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 186 <tr class="memitem:a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a></td></tr>
Chris@6 187 <tr class="separator:a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 188 <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 189 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 190 </table>
Chris@6 191 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Chris@1 192 <div class="textblock"><p>Example plugin that calculates the positions and density of zero-crossing points in an audio waveform. </p>
Chris@1 193
Chris@6 194 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00047">47</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p>
Chris@6 195 </div><h2 class="groupheader">Member Typedef Documentation</h2>
Chris@6 196 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
Chris@6 197 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
Chris@6 198
Chris@6 199 <div class="memitem">
Chris@6 200 <div class="memproto">
Chris@6 201 <table class="mlabels">
Chris@6 202 <tr>
Chris@6 203 <td class="mlabels-left">
Chris@6 204 <table class="memname">
Chris@6 205 <tr>
Chris@6 206 <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 207 </tr>
Chris@6 208 </table>
Chris@6 209 </td>
Chris@6 210 <td class="mlabels-right">
Chris@6 211 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 212 </tr>
Chris@6 213 </table>
Chris@6 214 </div><div class="memdoc">
Chris@6 215
Chris@6 216 <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 217
Chris@6 218 </div>
Chris@6 219 </div>
Chris@6 220 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
Chris@6 221 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
Chris@6 222
Chris@6 223 <div class="memitem">
Chris@6 224 <div class="memproto">
Chris@6 225 <table class="mlabels">
Chris@6 226 <tr>
Chris@6 227 <td class="mlabels-left">
Chris@6 228 <table class="memname">
Chris@6 229 <tr>
Chris@6 230 <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 231 </tr>
Chris@6 232 </table>
Chris@6 233 </td>
Chris@6 234 <td class="mlabels-right">
Chris@6 235 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 236 </tr>
Chris@6 237 </table>
Chris@6 238 </div><div class="memdoc">
Chris@6 239
Chris@6 240 <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 241
Chris@6 242 </div>
Chris@6 243 </div>
Chris@6 244 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
Chris@6 245 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
Chris@6 246
Chris@6 247 <div class="memitem">
Chris@6 248 <div class="memproto">
Chris@6 249 <table class="mlabels">
Chris@6 250 <tr>
Chris@6 251 <td class="mlabels-left">
Chris@6 252 <table class="memname">
Chris@6 253 <tr>
Chris@6 254 <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 255 </tr>
Chris@6 256 </table>
Chris@6 257 </td>
Chris@6 258 <td class="mlabels-right">
Chris@6 259 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 260 </tr>
Chris@6 261 </table>
Chris@6 262 </div><div class="memdoc">
Chris@6 263
Chris@6 264 <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 265
Chris@6 266 </div>
Chris@6 267 </div>
Chris@6 268 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
Chris@6 269 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
Chris@6 270
Chris@6 271 <div class="memitem">
Chris@6 272 <div class="memproto">
Chris@6 273 <table class="mlabels">
Chris@6 274 <tr>
Chris@6 275 <td class="mlabels-left">
Chris@6 276 <table class="memname">
Chris@6 277 <tr>
Chris@6 278 <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 279 </tr>
Chris@6 280 </table>
Chris@6 281 </td>
Chris@6 282 <td class="mlabels-right">
Chris@6 283 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 284 </tr>
Chris@6 285 </table>
Chris@6 286 </div><div class="memdoc">
Chris@6 287
Chris@6 288 <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 289
Chris@6 290 </div>
Chris@6 291 </div>
Chris@6 292 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
Chris@6 293 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
Chris@6 294
Chris@6 295 <div class="memitem">
Chris@6 296 <div class="memproto">
Chris@6 297 <table class="mlabels">
Chris@6 298 <tr>
Chris@6 299 <td class="mlabels-left">
Chris@6 300 <table class="memname">
Chris@6 301 <tr>
Chris@6 302 <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 303 </tr>
Chris@6 304 </table>
Chris@6 305 </td>
Chris@6 306 <td class="mlabels-right">
Chris@6 307 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 308 </tr>
Chris@6 309 </table>
Chris@6 310 </div><div class="memdoc">
Chris@6 311
Chris@6 312 <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 313
Chris@6 314 </div>
Chris@6 315 </div>
Chris@6 316 <h2 class="groupheader">Member Enumeration Documentation</h2>
Chris@6 317 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
Chris@6 318 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
Chris@6 319
Chris@6 320 <div class="memitem">
Chris@6 321 <div class="memproto">
Chris@6 322 <table class="mlabels">
Chris@6 323 <tr>
Chris@6 324 <td class="mlabels-left">
Chris@6 325 <table class="memname">
Chris@6 326 <tr>
Chris@6 327 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
Chris@6 328 </tr>
Chris@6 329 </table>
Chris@6 330 </td>
Chris@6 331 <td class="mlabels-right">
Chris@6 332 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 333 </tr>
Chris@6 334 </table>
Chris@6 335 </div><div class="memdoc">
Chris@6 336 <table class="fieldtable">
Chris@6 337 <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 338 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
Chris@6 339 </table>
Chris@6 340
Chris@6 341 <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 342
Chris@6 343 </div>
Chris@6 344 </div>
Chris@6 345 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
Chris@6 346 <a id="a9855153a54bdc9ba75cc1a705a149473"></a>
Chris@6 347 <h2 class="memtitle"><span class="permalink"><a href="#a9855153a54bdc9ba75cc1a705a149473">&#9670;&nbsp;</a></span>ZeroCrossing()</h2>
Chris@6 348
Chris@1 349 <div class="memitem">
Chris@1 350 <div class="memproto">
Chris@1 351 <table class="memname">
Chris@1 352 <tr>
Chris@6 353 <td class="memname">ZeroCrossing::ZeroCrossing </td>
Chris@1 354 <td>(</td>
Chris@1 355 <td class="paramtype">float&#160;</td>
Chris@1 356 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
Chris@1 357 <td></td>
Chris@1 358 </tr>
Chris@1 359 </table>
Chris@6 360 </div><div class="memdoc">
Chris@1 361
Chris@6 362 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00047">47</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@1 363
Chris@1 364 </div>
Chris@1 365 </div>
Chris@6 366 <a id="af1de0da862e6e2443581e4e16044675b"></a>
Chris@6 367 <h2 class="memtitle"><span class="permalink"><a href="#af1de0da862e6e2443581e4e16044675b">&#9670;&nbsp;</a></span>~ZeroCrossing()</h2>
Chris@6 368
Chris@1 369 <div class="memitem">
Chris@1 370 <div class="memproto">
Chris@6 371 <table class="mlabels">
Chris@6 372 <tr>
Chris@6 373 <td class="mlabels-left">
Chris@1 374 <table class="memname">
Chris@1 375 <tr>
Chris@6 376 <td class="memname">ZeroCrossing::~ZeroCrossing </td>
Chris@1 377 <td>(</td>
Chris@1 378 <td class="paramname"></td><td>)</td>
Chris@6 379 <td></td>
Chris@1 380 </tr>
Chris@1 381 </table>
Chris@6 382 </td>
Chris@6 383 <td class="mlabels-right">
Chris@6 384 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 385 </tr>
Chris@6 386 </table>
Chris@6 387 </div><div class="memdoc">
Chris@1 388
Chris@6 389 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00054">54</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@1 390
Chris@1 391 </div>
Chris@1 392 </div>
Chris@6 393 <h2 class="groupheader">Member Function Documentation</h2>
Chris@6 394 <a id="af21bbcc87a6eb7875dfab7d86222dccc"></a>
Chris@6 395 <h2 class="memtitle"><span class="permalink"><a href="#af21bbcc87a6eb7875dfab7d86222dccc">&#9670;&nbsp;</a></span>initialise()</h2>
Chris@6 396
Chris@1 397 <div class="memitem">
Chris@1 398 <div class="memproto">
Chris@6 399 <table class="mlabels">
Chris@6 400 <tr>
Chris@6 401 <td class="mlabels-left">
Chris@1 402 <table class="memname">
Chris@1 403 <tr>
Chris@6 404 <td class="memname">bool ZeroCrossing::initialise </td>
Chris@1 405 <td>(</td>
Chris@1 406 <td class="paramtype">size_t&#160;</td>
Chris@1 407 <td class="paramname"><em>inputChannels</em>, </td>
Chris@1 408 </tr>
Chris@1 409 <tr>
Chris@1 410 <td class="paramkey"></td>
Chris@1 411 <td></td>
Chris@1 412 <td class="paramtype">size_t&#160;</td>
Chris@1 413 <td class="paramname"><em>stepSize</em>, </td>
Chris@1 414 </tr>
Chris@1 415 <tr>
Chris@1 416 <td class="paramkey"></td>
Chris@1 417 <td></td>
Chris@1 418 <td class="paramtype">size_t&#160;</td>
Chris@1 419 <td class="paramname"><em>blockSize</em>&#160;</td>
Chris@1 420 </tr>
Chris@1 421 <tr>
Chris@1 422 <td></td>
Chris@1 423 <td>)</td>
Chris@6 424 <td></td><td></td>
Chris@1 425 </tr>
Chris@1 426 </table>
Chris@6 427 </td>
Chris@6 428 <td class="mlabels-right">
Chris@6 429 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 430 </tr>
Chris@6 431 </table>
Chris@6 432 </div><div class="memdoc">
Chris@1 433
Chris@1 434 <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 435 <p>The input sample rate should have been already specified at construction time.</p>
Chris@1 436 <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 437
Chris@1 438 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
Chris@1 439
Chris@6 440 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">95</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@1 441
Chris@6 442 <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>, and <a class="el" href="ZeroCrossing_8h_source.html#l00073">m_stepSize</a>.</p>
Chris@1 443
Chris@1 444 </div>
Chris@1 445 </div>
Chris@6 446 <a id="a9ae6c4a31ea027dceb1e97ead807e228"></a>
Chris@6 447 <h2 class="memtitle"><span class="permalink"><a href="#a9ae6c4a31ea027dceb1e97ead807e228">&#9670;&nbsp;</a></span>reset()</h2>
Chris@6 448
Chris@1 449 <div class="memitem">
Chris@1 450 <div class="memproto">
Chris@6 451 <table class="mlabels">
Chris@6 452 <tr>
Chris@6 453 <td class="mlabels-left">
Chris@1 454 <table class="memname">
Chris@1 455 <tr>
Chris@6 456 <td class="memname">void ZeroCrossing::reset </td>
Chris@1 457 <td>(</td>
Chris@1 458 <td class="paramname"></td><td>)</td>
Chris@6 459 <td></td>
Chris@1 460 </tr>
Chris@1 461 </table>
Chris@6 462 </td>
Chris@6 463 <td class="mlabels-right">
Chris@6 464 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 465 </tr>
Chris@6 466 </table>
Chris@6 467 </div><div class="memdoc">
Chris@1 468
Chris@1 469 <p>Reset the plugin after use, to prepare it for another clean run. </p>
Chris@1 470 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
Chris@1 471
Chris@1 472 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
Chris@1 473
Chris@6 474 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00106">106</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@1 475
Chris@6 476 <p class="reference">References <a class="el" href="ZeroCrossing_8h_source.html#l00074">m_previousSample</a>.</p>
Chris@1 477
Chris@1 478 </div>
Chris@1 479 </div>
Chris@6 480 <a id="a2fd2cefbd1564e4d30ccabd64d6555e7"></a>
Chris@6 481 <h2 class="memtitle"><span class="permalink"><a href="#a2fd2cefbd1564e4d30ccabd64d6555e7">&#9670;&nbsp;</a></span>getInputDomain()</h2>
Chris@6 482
Chris@1 483 <div class="memitem">
Chris@1 484 <div class="memproto">
Chris@6 485 <table class="mlabels">
Chris@6 486 <tr>
Chris@6 487 <td class="mlabels-left">
Chris@1 488 <table class="memname">
Chris@1 489 <tr>
Chris@6 490 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> ZeroCrossing::getInputDomain </td>
Chris@1 491 <td>(</td>
Chris@1 492 <td class="paramname"></td><td>)</td>
Chris@6 493 <td> const</td>
Chris@1 494 </tr>
Chris@1 495 </table>
Chris@6 496 </td>
Chris@6 497 <td class="mlabels-right">
Chris@6 498 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
Chris@6 499 </tr>
Chris@6 500 </table>
Chris@6 501 </div><div class="memdoc">
Chris@1 502
Chris@1 503 <p>Get the plugin's required input domain. </p>
Chris@6 504 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" 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 505 <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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" 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 506
Chris@1 507 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
Chris@1 508
Chris@6 509 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00056">56</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p>
Chris@1 510
Chris@6 511 <p class="reference">References <a class="el" href="ZeroCrossing_8cpp_source.html#l00089">getCopyright()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00071">getDescription()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00059">getIdentifier()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00077">getMaker()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00065">getName()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00083">getPluginVersion()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00192">getRemainingFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">process()</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p>
Chris@1 512
Chris@1 513 </div>
Chris@1 514 </div>
Chris@6 515 <a id="af5049a01a3f003f17a45c61b599c6543"></a>
Chris@6 516 <h2 class="memtitle"><span class="permalink"><a href="#af5049a01a3f003f17a45c61b599c6543">&#9670;&nbsp;</a></span>getIdentifier()</h2>
Chris@6 517
Chris@1 518 <div class="memitem">
Chris@1 519 <div class="memproto">
Chris@6 520 <table class="mlabels">
Chris@6 521 <tr>
Chris@6 522 <td class="mlabels-left">
Chris@1 523 <table class="memname">
Chris@1 524 <tr>
Chris@6 525 <td class="memname">string ZeroCrossing::getIdentifier </td>
Chris@1 526 <td>(</td>
Chris@1 527 <td class="paramname"></td><td>)</td>
Chris@6 528 <td> const</td>
Chris@1 529 </tr>
Chris@1 530 </table>
Chris@6 531 </td>
Chris@6 532 <td class="mlabels-right">
Chris@6 533 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 534 </tr>
Chris@6 535 </table>
Chris@6 536 </div><div class="memdoc">
Chris@1 537
Chris@1 538 <p>Get the computer-usable name of the plugin. </p>
Chris@1 539 <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 540 <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 541 <p>Example: "zero_crossings" </p>
Chris@1 542
Chris@1 543 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
Chris@1 544
Chris@6 545 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00059">59</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@6 546
Chris@6 547 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 548
Chris@1 549 </div>
Chris@1 550 </div>
Chris@6 551 <a id="a191365f793e6488d02d57029eb14deb2"></a>
Chris@6 552 <h2 class="memtitle"><span class="permalink"><a href="#a191365f793e6488d02d57029eb14deb2">&#9670;&nbsp;</a></span>getName()</h2>
Chris@6 553
Chris@1 554 <div class="memitem">
Chris@1 555 <div class="memproto">
Chris@6 556 <table class="mlabels">
Chris@6 557 <tr>
Chris@6 558 <td class="mlabels-left">
Chris@1 559 <table class="memname">
Chris@1 560 <tr>
Chris@6 561 <td class="memname">string ZeroCrossing::getName </td>
Chris@1 562 <td>(</td>
Chris@1 563 <td class="paramname"></td><td>)</td>
Chris@6 564 <td> const</td>
Chris@1 565 </tr>
Chris@1 566 </table>
Chris@6 567 </td>
Chris@6 568 <td class="mlabels-right">
Chris@6 569 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 570 </tr>
Chris@6 571 </table>
Chris@6 572 </div><div class="memdoc">
Chris@1 573
Chris@1 574 <p>Get a human-readable name or title of the plugin. </p>
Chris@1 575 <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 576 <p>Example: "Zero Crossings" </p>
Chris@1 577
Chris@1 578 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
Chris@1 579
Chris@6 580 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00065">65</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@6 581
Chris@6 582 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 583
Chris@1 584 </div>
Chris@1 585 </div>
Chris@6 586 <a id="a7ba1cfd102a427f8333ddfa2fe234d58"></a>
Chris@6 587 <h2 class="memtitle"><span class="permalink"><a href="#a7ba1cfd102a427f8333ddfa2fe234d58">&#9670;&nbsp;</a></span>getDescription()</h2>
Chris@6 588
Chris@1 589 <div class="memitem">
Chris@1 590 <div class="memproto">
Chris@6 591 <table class="mlabels">
Chris@6 592 <tr>
Chris@6 593 <td class="mlabels-left">
Chris@1 594 <table class="memname">
Chris@1 595 <tr>
Chris@6 596 <td class="memname">string ZeroCrossing::getDescription </td>
Chris@1 597 <td>(</td>
Chris@1 598 <td class="paramname"></td><td>)</td>
Chris@6 599 <td> const</td>
Chris@1 600 </tr>
Chris@1 601 </table>
Chris@6 602 </td>
Chris@6 603 <td class="mlabels-right">
Chris@6 604 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 605 </tr>
Chris@6 606 </table>
Chris@6 607 </div><div class="memdoc">
Chris@1 608
Chris@1 609 <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 610 <p>May be empty if the name has said it all already.</p>
Chris@1 611 <p>Example: "Detect and count zero crossing points" </p>
Chris@1 612
Chris@1 613 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
Chris@1 614
Chris@6 615 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00071">71</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@6 616
Chris@6 617 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 618
Chris@1 619 </div>
Chris@1 620 </div>
Chris@6 621 <a id="a9ddf295d977b6c64d8acd34b7e0ce1b0"></a>
Chris@6 622 <h2 class="memtitle"><span class="permalink"><a href="#a9ddf295d977b6c64d8acd34b7e0ce1b0">&#9670;&nbsp;</a></span>getMaker()</h2>
Chris@6 623
Chris@1 624 <div class="memitem">
Chris@1 625 <div class="memproto">
Chris@6 626 <table class="mlabels">
Chris@6 627 <tr>
Chris@6 628 <td class="mlabels-left">
Chris@1 629 <table class="memname">
Chris@1 630 <tr>
Chris@6 631 <td class="memname">string ZeroCrossing::getMaker </td>
Chris@1 632 <td>(</td>
Chris@1 633 <td class="paramname"></td><td>)</td>
Chris@6 634 <td> const</td>
Chris@1 635 </tr>
Chris@1 636 </table>
Chris@6 637 </td>
Chris@6 638 <td class="mlabels-right">
Chris@6 639 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 640 </tr>
Chris@6 641 </table>
Chris@6 642 </div><div class="memdoc">
Chris@1 643
Chris@1 644 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
Chris@1 645 <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 646
Chris@1 647 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
Chris@1 648
Chris@6 649 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00077">77</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@6 650
Chris@6 651 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 652
Chris@1 653 </div>
Chris@1 654 </div>
Chris@6 655 <a id="a4199350192d84a4ec5f379805cd3e7cf"></a>
Chris@6 656 <h2 class="memtitle"><span class="permalink"><a href="#a4199350192d84a4ec5f379805cd3e7cf">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
Chris@6 657
Chris@1 658 <div class="memitem">
Chris@1 659 <div class="memproto">
Chris@6 660 <table class="mlabels">
Chris@6 661 <tr>
Chris@6 662 <td class="mlabels-left">
Chris@1 663 <table class="memname">
Chris@1 664 <tr>
Chris@6 665 <td class="memname">int ZeroCrossing::getPluginVersion </td>
Chris@1 666 <td>(</td>
Chris@1 667 <td class="paramname"></td><td>)</td>
Chris@6 668 <td> const</td>
Chris@1 669 </tr>
Chris@1 670 </table>
Chris@6 671 </td>
Chris@6 672 <td class="mlabels-right">
Chris@6 673 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 674 </tr>
Chris@6 675 </table>
Chris@6 676 </div><div class="memdoc">
Chris@1 677
Chris@1 678 <p>Get the version number of the plugin. </p>
Chris@1 679
Chris@1 680 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
Chris@1 681
Chris@6 682 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00083">83</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@6 683
Chris@6 684 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 685
Chris@1 686 </div>
Chris@1 687 </div>
Chris@6 688 <a id="af955fb85b26a5497690aecbd288975f2"></a>
Chris@6 689 <h2 class="memtitle"><span class="permalink"><a href="#af955fb85b26a5497690aecbd288975f2">&#9670;&nbsp;</a></span>getCopyright()</h2>
Chris@6 690
Chris@1 691 <div class="memitem">
Chris@1 692 <div class="memproto">
Chris@6 693 <table class="mlabels">
Chris@6 694 <tr>
Chris@6 695 <td class="mlabels-left">
Chris@1 696 <table class="memname">
Chris@1 697 <tr>
Chris@6 698 <td class="memname">string ZeroCrossing::getCopyright </td>
Chris@1 699 <td>(</td>
Chris@1 700 <td class="paramname"></td><td>)</td>
Chris@6 701 <td> const</td>
Chris@1 702 </tr>
Chris@1 703 </table>
Chris@6 704 </td>
Chris@6 705 <td class="mlabels-right">
Chris@6 706 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 707 </tr>
Chris@6 708 </table>
Chris@6 709 </div><div class="memdoc">
Chris@1 710
Chris@1 711 <p>Get the copyright statement or licensing summary for the plugin. </p>
Chris@1 712 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
Chris@1 713
Chris@1 714 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
Chris@1 715
Chris@6 716 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00089">89</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@6 717
Chris@6 718 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 719
Chris@1 720 </div>
Chris@1 721 </div>
Chris@6 722 <a id="ab83cfab3f9674920e295c2f3571bb24e"></a>
Chris@6 723 <h2 class="memtitle"><span class="permalink"><a href="#ab83cfab3f9674920e295c2f3571bb24e">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
Chris@6 724
Chris@1 725 <div class="memitem">
Chris@1 726 <div class="memproto">
Chris@6 727 <table class="mlabels">
Chris@6 728 <tr>
Chris@6 729 <td class="mlabels-left">
Chris@1 730 <table class="memname">
Chris@1 731 <tr>
Chris@6 732 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">ZeroCrossing::OutputList</a> ZeroCrossing::getOutputDescriptors </td>
Chris@1 733 <td>(</td>
Chris@1 734 <td class="paramname"></td><td>)</td>
Chris@6 735 <td> const</td>
Chris@1 736 </tr>
Chris@1 737 </table>
Chris@6 738 </td>
Chris@6 739 <td class="mlabels-right">
Chris@6 740 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 741 </tr>
Chris@6 742 </table>
Chris@6 743 </div><div class="memdoc">
Chris@1 744
Chris@1 745 <p>Get the outputs of this plugin. </p>
Chris@6 746 <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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data. ">process()</a> call. </p>
Chris@1 747
Chris@1 748 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
Chris@1 749
Chris@6 750 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">112</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@1 751
Chris@6 752 <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 753
Chris@6 754 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 755
Chris@1 756 </div>
Chris@1 757 </div>
Chris@6 758 <a id="abf4aaa6fd8cc03de63f4e1e8942633da"></a>
Chris@6 759 <h2 class="memtitle"><span class="permalink"><a href="#abf4aaa6fd8cc03de63f4e1e8942633da">&#9670;&nbsp;</a></span>process()</h2>
Chris@6 760
Chris@1 761 <div class="memitem">
Chris@1 762 <div class="memproto">
Chris@6 763 <table class="mlabels">
Chris@6 764 <tr>
Chris@6 765 <td class="mlabels-left">
Chris@1 766 <table class="memname">
Chris@1 767 <tr>
Chris@6 768 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> ZeroCrossing::process </td>
Chris@1 769 <td>(</td>
Chris@1 770 <td class="paramtype">const float *const *&#160;</td>
Chris@1 771 <td class="paramname"><em>inputBuffers</em>, </td>
Chris@1 772 </tr>
Chris@1 773 <tr>
Chris@1 774 <td class="paramkey"></td>
Chris@1 775 <td></td>
Chris@1 776 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
Chris@1 777 <td class="paramname"><em>timestamp</em>&#160;</td>
Chris@1 778 </tr>
Chris@1 779 <tr>
Chris@1 780 <td></td>
Chris@1 781 <td>)</td>
Chris@6 782 <td></td><td></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@1 792 <p>Process a single block of input data. </p>
Chris@1 793 <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 794 <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 795 <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 796
Chris@1 797 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
Chris@1 798
Chris@6 799 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">143</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@1 800
Chris@6 801 <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="vamp-sdk_2Plugin_8h_source.html#l00444">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="ZeroCrossing_8h_source.html#l00074">m_previousSample</a>, <a class="el" href="ZeroCrossing_8h_source.html#l00073">m_stepSize</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 802
Chris@6 803 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 804
Chris@1 805 </div>
Chris@1 806 </div>
Chris@6 807 <a id="a70996d1b7166e303903daf92a9a37ad8"></a>
Chris@6 808 <h2 class="memtitle"><span class="permalink"><a href="#a70996d1b7166e303903daf92a9a37ad8">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
Chris@6 809
Chris@1 810 <div class="memitem">
Chris@1 811 <div class="memproto">
Chris@6 812 <table class="mlabels">
Chris@6 813 <tr>
Chris@6 814 <td class="mlabels-left">
Chris@1 815 <table class="memname">
Chris@1 816 <tr>
Chris@6 817 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> ZeroCrossing::getRemainingFeatures </td>
Chris@1 818 <td>(</td>
Chris@1 819 <td class="paramname"></td><td>)</td>
Chris@6 820 <td></td>
Chris@1 821 </tr>
Chris@1 822 </table>
Chris@6 823 </td>
Chris@6 824 <td class="mlabels-right">
Chris@6 825 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
Chris@6 826 </tr>
Chris@6 827 </table>
Chris@6 828 </div><div class="memdoc">
Chris@1 829
Chris@1 830 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
Chris@1 831
Chris@1 832 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
Chris@1 833
Chris@6 834 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00192">192</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
Chris@6 835
Chris@6 836 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
Chris@1 837
Chris@1 838 </div>
Chris@1 839 </div>
Chris@6 840 <a id="ae3b9c32b12796ece152388babad7cc7d"></a>
Chris@6 841 <h2 class="memtitle"><span class="permalink"><a href="#ae3b9c32b12796ece152388babad7cc7d">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
Chris@6 842
Chris@1 843 <div class="memitem">
Chris@1 844 <div class="memproto">
Chris@6 845 <table class="mlabels">
Chris@6 846 <tr>
Chris@6 847 <td class="mlabels-left">
Chris@1 848 <table class="memname">
Chris@1 849 <tr>
Chris@6 850 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
Chris@1 851 <td>(</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">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 859 </tr>
Chris@6 860 </table>
Chris@6 861 </div><div class="memdoc">
Chris@1 862
Chris@6 863 <p>Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data. ">process()</a> function). </p>
Chris@6 864 <p>This should be called before <a class="el" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" 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 865 <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="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" 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 866
Chris@6 867 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a39dd1770dd0a737ff295d70082d86fd3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a030b94dc3af4228a518f860952148bdd">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a9ee8ecc8406f633c68e9aa1516700332">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a94f855a2cf674ccc2e7315484f706d68">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#a9a2706b057bb269531f5c2797c42ddf4">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#abacdc27486aab9b37d1a51e35e6a9444">PercussionOnsetDetector</a>.</p>
Chris@1 868
Chris@6 869 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00179">179</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 870
Chris@6 871 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
Chris@1 872
Chris@1 873 </div>
Chris@1 874 </div>
Chris@6 875 <a id="a33eaf9a265bc3a055e156452112456c2"></a>
Chris@6 876 <h2 class="memtitle"><span class="permalink"><a href="#a33eaf9a265bc3a055e156452112456c2">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
Chris@6 877
Chris@1 878 <div class="memitem">
Chris@1 879 <div class="memproto">
Chris@6 880 <table class="mlabels">
Chris@6 881 <tr>
Chris@6 882 <td class="mlabels-left">
Chris@1 883 <table class="memname">
Chris@1 884 <tr>
Chris@6 885 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
Chris@1 886 <td>(</td>
Chris@1 887 <td class="paramname"></td><td>)</td>
Chris@6 888 <td> const</td>
Chris@1 889 </tr>
Chris@1 890 </table>
Chris@6 891 </td>
Chris@6 892 <td class="mlabels-right">
Chris@6 893 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 894 </tr>
Chris@6 895 </table>
Chris@6 896 </div><div class="memdoc">
Chris@1 897
Chris@6 898 <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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
Chris@6 899 <p>This should be called before <a class="el" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" 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 900 <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="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" 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 901
Chris@6 902 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ac7b43a08f1b1f42ed871fd6962c570f4">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a344c85cc017c97bf4f0f144e7d6e0f42">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#acb6b82c61ebac4610a8b92f94cd50682">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#adf2ea98d6eeb0435c0c8d7cdc29fed7c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#ac7c25bbeeef013210f4ab808ad12b659">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a0ad851545302fc87e8226104584667a0">PercussionOnsetDetector</a>.</p>
Chris@1 903
Chris@6 904 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00194">194</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 905
Chris@6 906 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
Chris@1 907
Chris@1 908 </div>
Chris@1 909 </div>
Chris@6 910 <a id="ab74f7634c6ac6e3da115667808a79c30"></a>
Chris@6 911 <h2 class="memtitle"><span class="permalink"><a href="#ab74f7634c6ac6e3da115667808a79c30">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
Chris@6 912
Chris@1 913 <div class="memitem">
Chris@1 914 <div class="memproto">
Chris@6 915 <table class="mlabels">
Chris@6 916 <tr>
Chris@6 917 <td class="mlabels-left">
Chris@1 918 <table class="memname">
Chris@1 919 <tr>
Chris@6 920 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
Chris@1 921 <td>(</td>
Chris@1 922 <td class="paramname"></td><td>)</td>
Chris@6 923 <td> const</td>
Chris@1 924 </tr>
Chris@1 925 </table>
Chris@6 926 </td>
Chris@6 927 <td class="mlabels-right">
Chris@6 928 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 929 </tr>
Chris@6 930 </table>
Chris@6 931 </div><div class="memdoc">
Chris@1 932
Chris@1 933 <p>Get the minimum supported number of input channels. </p>
Chris@1 934
Chris@6 935 <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 936
Chris@6 937 <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 938
Chris@6 939 <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">PercussionOnsetDetector::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">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 940
Chris@1 941 </div>
Chris@1 942 </div>
Chris@6 943 <a id="a0bff9464bc8c117470136c396b2405dd"></a>
Chris@6 944 <h2 class="memtitle"><span class="permalink"><a href="#a0bff9464bc8c117470136c396b2405dd">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
Chris@6 945
Chris@1 946 <div class="memitem">
Chris@1 947 <div class="memproto">
Chris@6 948 <table class="mlabels">
Chris@6 949 <tr>
Chris@6 950 <td class="mlabels-left">
Chris@1 951 <table class="memname">
Chris@1 952 <tr>
Chris@6 953 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
Chris@1 954 <td>(</td>
Chris@1 955 <td class="paramname"></td><td>)</td>
Chris@6 956 <td> const</td>
Chris@1 957 </tr>
Chris@1 958 </table>
Chris@6 959 </td>
Chris@6 960 <td class="mlabels-right">
Chris@6 961 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 962 </tr>
Chris@6 963 </table>
Chris@6 964 </div><div class="memdoc">
Chris@1 965
Chris@1 966 <p>Get the maximum supported number of input channels. </p>
Chris@1 967
Chris@6 968 <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 969
Chris@6 970 <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 971
Chris@6 972 <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">PercussionOnsetDetector::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">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 973
Chris@1 974 </div>
Chris@1 975 </div>
Chris@6 976 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
Chris@6 977 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
Chris@6 978
Chris@1 979 <div class="memitem">
Chris@1 980 <div class="memproto">
Chris@6 981 <table class="mlabels">
Chris@6 982 <tr>
Chris@6 983 <td class="mlabels-left">
Chris@1 984 <table class="memname">
Chris@1 985 <tr>
Chris@6 986 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
Chris@1 987 <td>(</td>
Chris@1 988 <td class="paramname"></td><td>)</td>
Chris@6 989 <td> const</td>
Chris@1 990 </tr>
Chris@1 991 </table>
Chris@6 992 </td>
Chris@6 993 <td class="mlabels-right">
Chris@6 994 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 995 </tr>
Chris@6 996 </table>
Chris@6 997 </div><div class="memdoc">
Chris@1 998
Chris@6 999 <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 1000 <p>Do not reimplement this function in your subclass. </p>
Chris@1 1001
Chris@1 1002 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
Chris@1 1003
Chris@6 1004 <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 1005
Chris@1 1006 </div>
Chris@1 1007 </div>
Chris@6 1008 <a id="ab4aa9c3e6f6dd9addbc095463c9fb772"></a>
Chris@6 1009 <h2 class="memtitle"><span class="permalink"><a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">&#9670;&nbsp;</a></span>getVampApiVersion()</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">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
Chris@1 1019 <td>(</td>
Chris@1 1020 <td class="paramname"></td><td>)</td>
Chris@6 1021 <td> const</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">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</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>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
Chris@1 1032
Chris@6 1033 <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 1034
Chris@6 1035 <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 1036
Chris@6 1037 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
Chris@1 1038
Chris@1 1039 </div>
Chris@1 1040 </div>
Chris@6 1041 <a id="a0c24ff6a43c681198dc9497287a26e3a"></a>
Chris@6 1042 <h2 class="memtitle"><span class="permalink"><a href="#a0c24ff6a43c681198dc9497287a26e3a">&#9670;&nbsp;</a></span>getParameterDescriptors()</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 <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </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 controllable parameters of this plugin. </p>
Chris@1 1065
Chris@6 1066 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f2b1c45be01169414bc86b685f4508e">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab2b67205d86e921cb0a9bd1f819d2cf9">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a4a707648d17d03a66b110b73b99e821b">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a4d5edffcea6c8757e0c077913b098aea">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#ae1cc81d82aaac8db5cf8a1067494f3d8">PercussionOnsetDetector</a>.</p>
Chris@1 1067
Chris@6 1068 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00208">208</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.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>.</p>
Chris@1 1071
Chris@1 1072 </div>
Chris@1 1073 </div>
Chris@6 1074 <a id="aa813d61077080ec95487d2a0227cc51b"></a>
Chris@6 1075 <h2 class="memtitle"><span class="permalink"><a href="#aa813d61077080ec95487d2a0227cc51b">&#9670;&nbsp;</a></span>getParameter()</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 float Vamp::PluginBase::getParameter </td>
Chris@1 1085 <td>(</td>
Chris@1 1086 <td class="paramtype">std::string&#160;</td>
Chris@1 1087 <td class="paramname"></td><td>)</td>
Chris@6 1088 <td> const</td>
Chris@1 1089 </tr>
Chris@1 1090 </table>
Chris@6 1091 </td>
Chris@6 1092 <td class="mlabels-right">
Chris@6 1093 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1094 </tr>
Chris@6 1095 </table>
Chris@6 1096 </div><div class="memdoc">
Chris@1 1097
Chris@1 1098 <p>Get the value of a named parameter. </p>
Chris@1 1099 <p>The argument is the identifier field from that parameter's descriptor. </p>
Chris@1 1100
Chris@6 1101 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a97149b60fb9d7c4359262ba8f6ff9743">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5c0a4d72a25fded51829de21771de521">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a93f32b68462f46af5265327a69479c38">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#ae988b4015672a73914e83c1589952752">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#accce70a87d6b30d4696d40a3e09b8f17">PercussionOnsetDetector</a>.</p>
Chris@1 1102
Chris@6 1103 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00216">216</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 1104
Chris@1 1105 </div>
Chris@1 1106 </div>
Chris@6 1107 <a id="a6c718ce822f7b73b98940d59dcaa9366"></a>
Chris@6 1108 <h2 class="memtitle"><span class="permalink"><a href="#a6c718ce822f7b73b98940d59dcaa9366">&#9670;&nbsp;</a></span>setParameter()</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 void Vamp::PluginBase::setParameter </td>
Chris@1 1118 <td>(</td>
Chris@1 1119 <td class="paramtype">std::string&#160;</td>
Chris@1 1120 <td class="paramname">, </td>
Chris@1 1121 </tr>
Chris@1 1122 <tr>
Chris@1 1123 <td class="paramkey"></td>
Chris@1 1124 <td></td>
Chris@1 1125 <td class="paramtype">float&#160;</td>
Chris@1 1126 <td class="paramname">&#160;</td>
Chris@1 1127 </tr>
Chris@1 1128 <tr>
Chris@1 1129 <td></td>
Chris@1 1130 <td>)</td>
Chris@6 1131 <td></td><td></td>
Chris@1 1132 </tr>
Chris@1 1133 </table>
Chris@6 1134 </td>
Chris@6 1135 <td class="mlabels-right">
Chris@6 1136 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1137 </tr>
Chris@6 1138 </table>
Chris@6 1139 </div><div class="memdoc">
Chris@1 1140
Chris@1 1141 <p>Set a named parameter. </p>
Chris@1 1142 <p>The first argument is the identifier field from that parameter's descriptor. </p>
Chris@1 1143
Chris@1 1144 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p>
Chris@1 1145
Chris@6 1146 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00222">222</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 1147
Chris@1 1148 </div>
Chris@1 1149 </div>
Chris@6 1150 <a id="aaf6febff0ab4daf4a5089c98a67f4df8"></a>
Chris@6 1151 <h2 class="memtitle"><span class="permalink"><a href="#aaf6febff0ab4daf4a5089c98a67f4df8">&#9670;&nbsp;</a></span>getPrograms()</h2>
Chris@6 1152
Chris@1 1153 <div class="memitem">
Chris@1 1154 <div class="memproto">
Chris@6 1155 <table class="mlabels">
Chris@6 1156 <tr>
Chris@6 1157 <td class="mlabels-left">
Chris@1 1158 <table class="memname">
Chris@1 1159 <tr>
Chris@6 1160 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
Chris@1 1161 <td>(</td>
Chris@1 1162 <td class="paramname"></td><td>)</td>
Chris@6 1163 <td> const</td>
Chris@1 1164 </tr>
Chris@1 1165 </table>
Chris@6 1166 </td>
Chris@6 1167 <td class="mlabels-right">
Chris@6 1168 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1169 </tr>
Chris@6 1170 </table>
Chris@6 1171 </div><div class="memdoc">
Chris@1 1172
Chris@1 1173 <p>Get the program settings available in this plugin. </p>
Chris@1 1174 <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 1175 <p>The programs must have unique names. </p>
Chris@1 1176
Chris@6 1177 <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 1178
Chris@6 1179 <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 1180
Chris@1 1181 </div>
Chris@1 1182 </div>
Chris@6 1183 <a id="aac38c5dc6e87208616122897518ca3d5"></a>
Chris@6 1184 <h2 class="memtitle"><span class="permalink"><a href="#aac38c5dc6e87208616122897518ca3d5">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
Chris@6 1185
Chris@1 1186 <div class="memitem">
Chris@1 1187 <div class="memproto">
Chris@6 1188 <table class="mlabels">
Chris@6 1189 <tr>
Chris@6 1190 <td class="mlabels-left">
Chris@1 1191 <table class="memname">
Chris@1 1192 <tr>
Chris@6 1193 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
Chris@1 1194 <td>(</td>
Chris@1 1195 <td class="paramname"></td><td>)</td>
Chris@6 1196 <td> const</td>
Chris@1 1197 </tr>
Chris@1 1198 </table>
Chris@6 1199 </td>
Chris@6 1200 <td class="mlabels-right">
Chris@6 1201 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1202 </tr>
Chris@6 1203 </table>
Chris@6 1204 </div><div class="memdoc">
Chris@1 1205
Chris@1 1206 <p>Get the current program. </p>
Chris@1 1207
Chris@6 1208 <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 1209
Chris@6 1210 <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 1211
Chris@1 1212 </div>
Chris@1 1213 </div>
Chris@6 1214 <a id="aadd3a547ef140bae200473a9518e3353"></a>
Chris@6 1215 <h2 class="memtitle"><span class="permalink"><a href="#aadd3a547ef140bae200473a9518e3353">&#9670;&nbsp;</a></span>selectProgram()</h2>
Chris@6 1216
Chris@1 1217 <div class="memitem">
Chris@1 1218 <div class="memproto">
Chris@6 1219 <table class="mlabels">
Chris@6 1220 <tr>
Chris@6 1221 <td class="mlabels-left">
Chris@1 1222 <table class="memname">
Chris@1 1223 <tr>
Chris@6 1224 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
Chris@1 1225 <td>(</td>
Chris@1 1226 <td class="paramtype">std::string&#160;</td>
Chris@1 1227 <td class="paramname"></td><td>)</td>
Chris@6 1228 <td></td>
Chris@1 1229 </tr>
Chris@1 1230 </table>
Chris@6 1231 </td>
Chris@6 1232 <td class="mlabels-right">
Chris@6 1233 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1234 </tr>
Chris@6 1235 </table>
Chris@6 1236 </div><div class="memdoc">
Chris@1 1237
Chris@1 1238 <p>Select a program. </p>
Chris@1 1239 <p>(If the given program name is not one of the available programs, do nothing.) </p>
Chris@1 1240
Chris@1 1241 <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 1242
Chris@6 1243 <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 1244
Chris@6 1245 <p class="reference">References <a class="el" href="plugguard_8h_source.html#l00080">_VAMP_SDK_PLUGSPACE_END</a>.</p>
Chris@1 1246
Chris@1 1247 </div>
Chris@1 1248 </div>
Chris@6 1249 <h2 class="groupheader">Member Data Documentation</h2>
Chris@6 1250 <a id="a584f100b87c78f9af9da040d79567d52"></a>
Chris@6 1251 <h2 class="memtitle"><span class="permalink"><a href="#a584f100b87c78f9af9da040d79567d52">&#9670;&nbsp;</a></span>m_stepSize</h2>
Chris@6 1252
Chris@1 1253 <div class="memitem">
Chris@1 1254 <div class="memproto">
Chris@6 1255 <table class="mlabels">
Chris@6 1256 <tr>
Chris@6 1257 <td class="mlabels-left">
Chris@1 1258 <table class="memname">
Chris@1 1259 <tr>
Chris@6 1260 <td class="memname">size_t ZeroCrossing::m_stepSize</td>
Chris@1 1261 </tr>
Chris@1 1262 </table>
Chris@6 1263 </td>
Chris@6 1264 <td class="mlabels-right">
Chris@6 1265 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1266 </tr>
Chris@6 1267 </table>
Chris@6 1268 </div><div class="memdoc">
Chris@1 1269
Chris@6 1270 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00073">73</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p>
Chris@1 1271
Chris@6 1272 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">initialise()</a>, and <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">process()</a>.</p>
Chris@1 1273
Chris@1 1274 </div>
Chris@1 1275 </div>
Chris@6 1276 <a id="a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"></a>
Chris@6 1277 <h2 class="memtitle"><span class="permalink"><a href="#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">&#9670;&nbsp;</a></span>m_previousSample</h2>
Chris@6 1278
Chris@1 1279 <div class="memitem">
Chris@1 1280 <div class="memproto">
Chris@6 1281 <table class="mlabels">
Chris@6 1282 <tr>
Chris@6 1283 <td class="mlabels-left">
Chris@1 1284 <table class="memname">
Chris@1 1285 <tr>
Chris@6 1286 <td class="memname">float ZeroCrossing::m_previousSample</td>
Chris@1 1287 </tr>
Chris@1 1288 </table>
Chris@6 1289 </td>
Chris@6 1290 <td class="mlabels-right">
Chris@6 1291 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 1292 </tr>
Chris@6 1293 </table>
Chris@6 1294 </div><div class="memdoc">
Chris@1 1295
Chris@6 1296 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00074">74</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p>
Chris@1 1297
Chris@6 1298 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">process()</a>, and <a class="el" href="ZeroCrossing_8cpp_source.html#l00106">reset()</a>.</p>
Chris@1 1299
Chris@1 1300 </div>
Chris@1 1301 </div>
Chris@6 1302 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
Chris@6 1303 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
Chris@6 1304
Chris@1 1305 <div class="memitem">
Chris@1 1306 <div class="memproto">
Chris@6 1307 <table class="mlabels">
Chris@6 1308 <tr>
Chris@6 1309 <td class="mlabels-left">
Chris@1 1310 <table class="memname">
Chris@1 1311 <tr>
Chris@6 1312 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
Chris@1 1313 </tr>
Chris@1 1314 </table>
Chris@6 1315 </td>
Chris@6 1316 <td class="mlabels-right">
Chris@6 1317 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
Chris@6 1318 </tr>
Chris@6 1319 </table>
Chris@6 1320 </div><div class="memdoc">
Chris@1 1321
Chris@6 1322 <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 1323
Chris@6 1324 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::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">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
Chris@1 1325
Chris@1 1326 </div>
Chris@1 1327 </div>
Chris@1 1328 <hr/>The documentation for this class was generated from the following files:<ul>
Chris@1 1329 <li><a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a></li>
Chris@1 1330 <li><a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a></li>
Chris@1 1331 </ul>
Chris@3 1332 </div><!-- contents -->
Chris@6 1333 </div><!-- doc-content -->
Chris@6 1334 <!-- start footer part -->
Chris@6 1335 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 1336 <ul>
Chris@6 1337 <li class="navelem"><a class="el" href="classZeroCrossing.html">ZeroCrossing</a></li>
Chris@6 1338 <li class="footer">Generated by
Chris@6 1339 <a href="http://www.doxygen.org/index.html">
Chris@6 1340 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 1341 </ul>
Chris@1 1342 </div>
Chris@1 1343 </body>
Chris@1 1344 </html>