Mercurial > hg > vamp-docs

comparison code-docs/classZeroCrossing.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
comparison
equal deleted inserted replaced
0:895ae8fffdb7 1:3c430ef1ed66
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>VampPluginSDK: ZeroCrossing Class Reference</title>
6
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="resize.js"></script>
12 <script type="text/javascript" src="navtree.js"></script>
13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16
17
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div! -->
21
22
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27
28
29 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span>
32 </div>
33
34 </td>
35
36
37
38 </tr>
39 </tbody>
40 </table>
41 </div>
42
43 <!-- Generated by Doxygen 1.7.5.1 -->
44 <div id="navrow1" class="tabs">
45 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
49 <li><a href="files.html"><span>Files</span></a></li>
50 <li><a href="dirs.html"><span>Directories</span></a></li>
51 </ul>
52 </div>
53 <div id="navrow2" class="tabs2">
54 <ul class="tablist">
55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
58 </ul>
59 </div>
60 </div>
61 <div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree">
63 <div id="nav-tree-contents">
64 </div>
65 </div>
66 <div id="splitbar" style="-moz-user-select:none;"
67 class="ui-resizable-handle">
68 </div>
69 </div>
70 <script type="text/javascript">
71 initNavTree('classZeroCrossing.html','');
72 </script>
73 <div id="doc-content">
74 <div class="header">
75 <div class="summary">
76 <a href="#pub-types">Public Types</a> &#124;
77 <a href="#pub-methods">Public Member Functions</a> &#124;
78 <a href="#pro-attribs">Protected Attributes</a> </div>
79 <div class="headertitle">
80 <div class="title">ZeroCrossing Class Reference</div> </div>
81 </div>
82 <div class="contents">
83 <!-- doxytag: class="ZeroCrossing" --><!-- doxytag: inherits="Vamp::Plugin" -->
84 <p>Example plugin that calculates the positions and density of zero-crossing points in an audio waveform.
85 <a href="classZeroCrossing.html#details">More...</a></p>
86
87 <p><code>#include &lt;<a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>&gt;</code></p>
88 <div class="dynheader">
89 Inheritance diagram for ZeroCrossing:</div>
90 <div class="dyncontent">
91 <div class="center"><img src="classZeroCrossing__inherit__graph.png" border="0" usemap="#ZeroCrossing_inherit__map" alt="Inheritance graph"/></div>
92 <map name="ZeroCrossing_inherit__map" id="ZeroCrossing_inherit__map">
93 <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="18,81,109,106"/><area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="5,6,123,31"/></map>
94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
95
96 <p><a href="classZeroCrossing-members.html">List of all members.</a></p>
97 <table class="memberdecls">
98 <tr><td colspan="2"><h2><a name="pub-types"></a>
99 Public Types</h2></td></tr>
100 <tr><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>,
101 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
102 }</td></tr>
103 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
104 &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>
105 <tr><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>
106 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
107 <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>
108 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
109 &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>
110 <tr><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>
111 <tr><td colspan="2"><h2><a name="pub-methods"></a>
112 Public Member Functions</h2></td></tr>
113 <tr><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>
114 <tr><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>
115 <tr><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>
116 <tr><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"></a><br/></td></tr>
117 <tr><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>
118 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a9ae6c4a31ea027dceb1e97ead807e228"></a><br/></td></tr>
119 <tr><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#aafe2ce6ebd353a14c40db7e8e60f4051">getInputDomain</a> () const </td></tr>
120 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#aafe2ce6ebd353a14c40db7e8e60f4051"></a><br/></td></tr>
121 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af2baf9e19fcdd11cfe97ace56d4f5c1a">getIdentifier</a> () const </td></tr>
122 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#af2baf9e19fcdd11cfe97ace56d4f5c1a"></a><br/></td></tr>
123 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#afa96f7ce6e7d9f03768f48c6a9d88498">getName</a> () const </td></tr>
124 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#afa96f7ce6e7d9f03768f48c6a9d88498"></a><br/></td></tr>
125 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a710bb0b013157adaeef2a9e6867b4478">getDescription</a> () const </td></tr>
126 <tr><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="#a710bb0b013157adaeef2a9e6867b4478"></a><br/></td></tr>
127 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#ac68561634a3c329a029c2fd3deaeae2a">getMaker</a> () const </td></tr>
128 <tr><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="#ac68561634a3c329a029c2fd3deaeae2a"></a><br/></td></tr>
129 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#ad685f6c2f443f07a1634550c335571eb">getPluginVersion</a> () const </td></tr>
130 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#ad685f6c2f443f07a1634550c335571eb"></a><br/></td></tr>
131 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af9c41b92aa8ff8bddaebf75569ff789c">getCopyright</a> () const </td></tr>
132 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#af9c41b92aa8ff8bddaebf75569ff789c"></a><br/></td></tr>
133 <tr><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#ac9d590a6feb1fc9a37d7892aefe2b688">getOutputDescriptors</a> () const </td></tr>
134 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#ac9d590a6feb1fc9a37d7892aefe2b688"></a><br/></td></tr>
135 <tr><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>
136 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#abf4aaa6fd8cc03de63f4e1e8942633da"></a><br/></td></tr>
137 <tr><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>
138 <tr><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"></a><br/></td></tr>
139 <tr><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#aa529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr>
140 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size -- 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="#aa529adf83f87a603954eb31407602aac"></a><br/></td></tr>
141 <tr><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#a514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr>
142 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment -- 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="#a514c716c22f81c055f19b56c3f882567"></a><br/></td></tr>
143 <tr><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#a267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr>
144 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a267b42e866df3cf0d190893e8096f525"></a><br/></td></tr>
145 <tr><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#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr>
146 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br/></td></tr>
147 <tr><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#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
148 <tr><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="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr>
149 <tr><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#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr>
150 <tr><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="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr>
151 <tr><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#aac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr>
152 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#aac3e49b3b66cacfbb768dfdf07444f21"></a><br/></td></tr>
153 <tr><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr>
154 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a97ababcd45348ceec998d0f8e0f38bf7"></a><br/></td></tr>
155 <tr><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>
156 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366"></a><br/></td></tr>
157 <tr><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#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr>
158 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr>
159 <tr><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#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr>
160 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr>
161 <tr><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>
162 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr>
163 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
164 Protected Attributes</h2></td></tr>
165 <tr><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>
166 <tr><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>
167 <tr><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>
168 </table>
169 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
170 <div class="textblock"><p>Example plugin that calculates the positions and density of zero-crossing points in an audio waveform. </p>
171
172 <p>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>
173 </div><hr/><h2>Member Typedef Documentation</h2>
174 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="ZeroCrossing::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
175 <div class="memitem">
176 <div class="memproto">
177 <table class="memname">
178 <tr>
179 <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><code> [inherited]</code></td>
180 </tr>
181 </table>
182 </div>
183 <div class="memdoc">
184
185 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00327">327</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
186
187 </div>
188 </div>
189 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="ZeroCrossing::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
190 <div class="memitem">
191 <div class="memproto">
192 <table class="memname">
193 <tr>
194 <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><code> [inherited]</code></td>
195 </tr>
196 </table>
197 </div>
198 <div class="memdoc">
199
200 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00385">385</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
201
202 </div>
203 </div>
204 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="ZeroCrossing::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
205 <div class="memitem">
206 <div class="memproto">
207 <table class="memname">
208 <tr>
209 <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><code> [inherited]</code></td>
210 </tr>
211 </table>
212 </div>
213 <div class="memdoc">
214
215 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
216
217 </div>
218 </div>
219 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="ZeroCrossing::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
220 <div class="memitem">
221 <div class="memproto">
222 <table class="memname">
223 <tr>
224 <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><code> [inherited]</code></td>
225 </tr>
226 </table>
227 </div>
228 <div class="memdoc">
229
230 <p>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>
231
232 </div>
233 </div>
234 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="ZeroCrossing::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
235 <div class="memitem">
236 <div class="memproto">
237 <table class="memname">
238 <tr>
239 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code></td>
240 </tr>
241 </table>
242 </div>
243 <div class="memdoc">
244
245 <p>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>
246
247 </div>
248 </div>
249 <hr/><h2>Member Enumeration Documentation</h2>
250 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="ZeroCrossing::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
251 <div class="memitem">
252 <div class="memproto">
253 <table class="memname">
254 <tr>
255 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
256 </tr>
257 </table>
258 </div>
259 <div class="memdoc">
260 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
261 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
262 </td></tr>
263 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
264 </td></tr>
265 </table>
266 </dd>
267 </dl>
268
269 <p>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>
270
271 </div>
272 </div>
273 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
274 <a class="anchor" id="a9855153a54bdc9ba75cc1a705a149473"></a><!-- doxytag: member="ZeroCrossing::ZeroCrossing" ref="a9855153a54bdc9ba75cc1a705a149473" args="(float inputSampleRate)" -->
275 <div class="memitem">
276 <div class="memproto">
277 <table class="memname">
278 <tr>
279 <td class="memname">ZeroCrossing::ZeroCrossing </td>
280 <td>(</td>
281 <td class="paramtype">float&#160;</td>
282 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
283 <td></td>
284 </tr>
285 </table>
286 </div>
287 <div class="memdoc">
288
289 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00046">46</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
290
291 </div>
292 </div>
293 <a class="anchor" id="af1de0da862e6e2443581e4e16044675b"></a><!-- doxytag: member="ZeroCrossing::~ZeroCrossing" ref="af1de0da862e6e2443581e4e16044675b" args="()" -->
294 <div class="memitem">
295 <div class="memproto">
296 <table class="memname">
297 <tr>
298 <td class="memname">ZeroCrossing::~ZeroCrossing </td>
299 <td>(</td>
300 <td class="paramname"></td><td>)</td>
301 <td><code> [virtual]</code></td>
302 </tr>
303 </table>
304 </div>
305 <div class="memdoc">
306
307 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00053">53</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
308
309 </div>
310 </div>
311 <hr/><h2>Member Function Documentation</h2>
312 <a class="anchor" id="af21bbcc87a6eb7875dfab7d86222dccc"></a><!-- doxytag: member="ZeroCrossing::initialise" ref="af21bbcc87a6eb7875dfab7d86222dccc" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
313 <div class="memitem">
314 <div class="memproto">
315 <table class="memname">
316 <tr>
317 <td class="memname">bool ZeroCrossing::initialise </td>
318 <td>(</td>
319 <td class="paramtype">size_t&#160;</td>
320 <td class="paramname"><em>inputChannels</em>, </td>
321 </tr>
322 <tr>
323 <td class="paramkey"></td>
324 <td></td>
325 <td class="paramtype">size_t&#160;</td>
326 <td class="paramname"><em>stepSize</em>, </td>
327 </tr>
328 <tr>
329 <td class="paramkey"></td>
330 <td></td>
331 <td class="paramtype">size_t&#160;</td>
332 <td class="paramname"><em>blockSize</em>&#160;</td>
333 </tr>
334 <tr>
335 <td></td>
336 <td>)</td>
337 <td></td><td><code> [virtual]</code></td>
338 </tr>
339 </table>
340 </div>
341 <div class="memdoc">
342
343 <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>
344 <p>The input sample rate should have been already specified at construction time.</p>
345 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
346
347 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
348
349 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">94</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
350
351 <p>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>
352
353 </div>
354 </div>
355 <a class="anchor" id="a9ae6c4a31ea027dceb1e97ead807e228"></a><!-- doxytag: member="ZeroCrossing::reset" ref="a9ae6c4a31ea027dceb1e97ead807e228" args="()" -->
356 <div class="memitem">
357 <div class="memproto">
358 <table class="memname">
359 <tr>
360 <td class="memname">void ZeroCrossing::reset </td>
361 <td>(</td>
362 <td class="paramname"></td><td>)</td>
363 <td><code> [virtual]</code></td>
364 </tr>
365 </table>
366 </div>
367 <div class="memdoc">
368
369 <p>Reset the plugin after use, to prepare it for another clean run. </p>
370 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
371
372 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
373
374 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00105">105</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
375
376 <p>References <a class="el" href="ZeroCrossing_8h_source.html#l00074">m_previousSample</a>.</p>
377
378 </div>
379 </div>
380 <a class="anchor" id="aafe2ce6ebd353a14c40db7e8e60f4051"></a><!-- doxytag: member="ZeroCrossing::getInputDomain" ref="aafe2ce6ebd353a14c40db7e8e60f4051" args="() const " -->
381 <div class="memitem">
382 <div class="memproto">
383 <table class="memname">
384 <tr>
385 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> ZeroCrossing::getInputDomain </td>
386 <td>(</td>
387 <td class="paramname"></td><td>)</td>
388 <td> const<code> [inline, virtual]</code></td>
389 </tr>
390 </table>
391 </div>
392 <div class="memdoc">
393
394 <p>Get the plugin's required input domain. </p>
395 <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>
396 <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 -- the host will either let the user do so, or will use a Hanning window. </p>
397
398 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
399
400 <p>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>
401
402 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p>
403
404 </div>
405 </div>
406 <a class="anchor" id="af2baf9e19fcdd11cfe97ace56d4f5c1a"></a><!-- doxytag: member="ZeroCrossing::getIdentifier" ref="af2baf9e19fcdd11cfe97ace56d4f5c1a" args="() const " -->
407 <div class="memitem">
408 <div class="memproto">
409 <table class="memname">
410 <tr>
411 <td class="memname">string ZeroCrossing::getIdentifier </td>
412 <td>(</td>
413 <td class="paramname"></td><td>)</td>
414 <td> const<code> [virtual]</code></td>
415 </tr>
416 </table>
417 </div>
418 <div class="memdoc">
419
420 <p>Get the computer-usable name of the plugin. </p>
421 <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>
422 <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>
423 <p>Example: "zero_crossings" </p>
424
425 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
426
427 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00058">58</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
428
429 </div>
430 </div>
431 <a class="anchor" id="afa96f7ce6e7d9f03768f48c6a9d88498"></a><!-- doxytag: member="ZeroCrossing::getName" ref="afa96f7ce6e7d9f03768f48c6a9d88498" args="() const " -->
432 <div class="memitem">
433 <div class="memproto">
434 <table class="memname">
435 <tr>
436 <td class="memname">string ZeroCrossing::getName </td>
437 <td>(</td>
438 <td class="paramname"></td><td>)</td>
439 <td> const<code> [virtual]</code></td>
440 </tr>
441 </table>
442 </div>
443 <div class="memdoc">
444
445 <p>Get a human-readable name or title of the plugin. </p>
446 <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>
447 <p>Example: "Zero Crossings" </p>
448
449 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
450
451 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00064">64</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
452
453 </div>
454 </div>
455 <a class="anchor" id="a710bb0b013157adaeef2a9e6867b4478"></a><!-- doxytag: member="ZeroCrossing::getDescription" ref="a710bb0b013157adaeef2a9e6867b4478" args="() const " -->
456 <div class="memitem">
457 <div class="memproto">
458 <table class="memname">
459 <tr>
460 <td class="memname">string ZeroCrossing::getDescription </td>
461 <td>(</td>
462 <td class="paramname"></td><td>)</td>
463 <td> const<code> [virtual]</code></td>
464 </tr>
465 </table>
466 </div>
467 <div class="memdoc">
468
469 <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>
470 <p>May be empty if the name has said it all already.</p>
471 <p>Example: "Detect and count zero crossing points" </p>
472
473 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
474
475 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00070">70</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
476
477 </div>
478 </div>
479 <a class="anchor" id="ac68561634a3c329a029c2fd3deaeae2a"></a><!-- doxytag: member="ZeroCrossing::getMaker" ref="ac68561634a3c329a029c2fd3deaeae2a" args="() const " -->
480 <div class="memitem">
481 <div class="memproto">
482 <table class="memname">
483 <tr>
484 <td class="memname">string ZeroCrossing::getMaker </td>
485 <td>(</td>
486 <td class="paramname"></td><td>)</td>
487 <td> const<code> [virtual]</code></td>
488 </tr>
489 </table>
490 </div>
491 <div class="memdoc">
492
493 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
494 <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>
495
496 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
497
498 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00076">76</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
499
500 </div>
501 </div>
502 <a class="anchor" id="ad685f6c2f443f07a1634550c335571eb"></a><!-- doxytag: member="ZeroCrossing::getPluginVersion" ref="ad685f6c2f443f07a1634550c335571eb" args="() const " -->
503 <div class="memitem">
504 <div class="memproto">
505 <table class="memname">
506 <tr>
507 <td class="memname">int ZeroCrossing::getPluginVersion </td>
508 <td>(</td>
509 <td class="paramname"></td><td>)</td>
510 <td> const<code> [virtual]</code></td>
511 </tr>
512 </table>
513 </div>
514 <div class="memdoc">
515
516 <p>Get the version number of the plugin. </p>
517
518 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
519
520 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00082">82</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
521
522 </div>
523 </div>
524 <a class="anchor" id="af9c41b92aa8ff8bddaebf75569ff789c"></a><!-- doxytag: member="ZeroCrossing::getCopyright" ref="af9c41b92aa8ff8bddaebf75569ff789c" args="() const " -->
525 <div class="memitem">
526 <div class="memproto">
527 <table class="memname">
528 <tr>
529 <td class="memname">string ZeroCrossing::getCopyright </td>
530 <td>(</td>
531 <td class="paramname"></td><td>)</td>
532 <td> const<code> [virtual]</code></td>
533 </tr>
534 </table>
535 </div>
536 <div class="memdoc">
537
538 <p>Get the copyright statement or licensing summary for the plugin. </p>
539 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
540
541 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
542
543 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00088">88</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
544
545 </div>
546 </div>
547 <a class="anchor" id="ac9d590a6feb1fc9a37d7892aefe2b688"></a><!-- doxytag: member="ZeroCrossing::getOutputDescriptors" ref="ac9d590a6feb1fc9a37d7892aefe2b688" args="() const " -->
548 <div class="memitem">
549 <div class="memproto">
550 <table class="memname">
551 <tr>
552 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">ZeroCrossing::OutputList</a> ZeroCrossing::getOutputDescriptors </td>
553 <td>(</td>
554 <td class="paramname"></td><td>)</td>
555 <td> const<code> [virtual]</code></td>
556 </tr>
557 </table>
558 </div>
559 <div class="memdoc">
560
561 <p>Get the outputs of this plugin. </p>
562 <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>
563
564 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
565
566 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">111</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
567
568 <p>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#l00436">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>
569
570 </div>
571 </div>
572 <a class="anchor" id="abf4aaa6fd8cc03de63f4e1e8942633da"></a><!-- doxytag: member="ZeroCrossing::process" ref="abf4aaa6fd8cc03de63f4e1e8942633da" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
573 <div class="memitem">
574 <div class="memproto">
575 <table class="memname">
576 <tr>
577 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> ZeroCrossing::process </td>
578 <td>(</td>
579 <td class="paramtype">const float *const *&#160;</td>
580 <td class="paramname"><em>inputBuffers</em>, </td>
581 </tr>
582 <tr>
583 <td class="paramkey"></td>
584 <td></td>
585 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&#160;</td>
586 <td class="paramname"><em>timestamp</em>&#160;</td>
587 </tr>
588 <tr>
589 <td></td>
590 <td>)</td>
591 <td></td><td><code> [virtual]</code></td>
592 </tr>
593 </table>
594 </div>
595 <div class="memdoc">
596
597 <p>Process a single block of input data. </p>
598 <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>
599 <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>
600 <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>
601
602 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
603
604 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">142</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
605
606 <p>References <a class="el" href="structVamp_1_1RealTime.html#a939b4b1d1ca190db69a418883f16ce8a">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">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#l00352">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00374">Vamp::Plugin::Feature::values</a>.</p>
607
608 </div>
609 </div>
610 <a class="anchor" id="a70996d1b7166e303903daf92a9a37ad8"></a><!-- doxytag: member="ZeroCrossing::getRemainingFeatures" ref="a70996d1b7166e303903daf92a9a37ad8" args="()" -->
611 <div class="memitem">
612 <div class="memproto">
613 <table class="memname">
614 <tr>
615 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> ZeroCrossing::getRemainingFeatures </td>
616 <td>(</td>
617 <td class="paramname"></td><td>)</td>
618 <td><code> [virtual]</code></td>
619 </tr>
620 </table>
621 </div>
622 <div class="memdoc">
623
624 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
625
626 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
627
628 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00191">191</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
629
630 </div>
631 </div>
632 <a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="ZeroCrossing::getPreferredBlockSize" ref="aa529adf83f87a603954eb31407602aac" args="() const " -->
633 <div class="memitem">
634 <div class="memproto">
635 <table class="memname">
636 <tr>
637 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
638 <td>(</td>
639 <td class="paramname"></td><td>)</td>
640 <td> const<code> [inline, virtual, inherited]</code></td>
641 </tr>
642 </table>
643 </div>
644 <div class="memdoc">
645
646 <p>Get the preferred block size (window size -- 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). </p>
647 <p>This should be called before <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" 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>
648 <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="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" 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>
649
650 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#ad5e0ea8042bdec4dd18428991117e07a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#a68b8569b71504a0478caf990dbe30683">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0">PercussionOnsetDetector</a>.</p>
651
652 <p>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>
653
654 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
655
656 </div>
657 </div>
658 <a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="ZeroCrossing::getPreferredStepSize" ref="a514c716c22f81c055f19b56c3f882567" args="() const " -->
659 <div class="memitem">
660 <div class="memproto">
661 <table class="memname">
662 <tr>
663 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
664 <td>(</td>
665 <td class="paramname"></td><td>)</td>
666 <td> const<code> [inline, virtual, inherited]</code></td>
667 </tr>
668 </table>
669 </div>
670 <div class="memdoc">
671
672 <p>Get the preferred step size (window increment -- 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. </p>
673 <p>This should be called before <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" 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>
674 <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="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" 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>
675
676 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ad979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a859ad5d59402691daed3cf1af1899ebe">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#ad450bb7e7df559ae3d68dfbfb085676f">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968">PercussionOnsetDetector</a>.</p>
677
678 <p>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>
679
680 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
681
682 </div>
683 </div>
684 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="ZeroCrossing::getMinChannelCount" ref="a267b42e866df3cf0d190893e8096f525" args="() const " -->
685 <div class="memitem">
686 <div class="memproto">
687 <table class="memname">
688 <tr>
689 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
690 <td>(</td>
691 <td class="paramname"></td><td>)</td>
692 <td> const<code> [inline, virtual, inherited]</code></td>
693 </tr>
694 </table>
695 </div>
696 <div class="memdoc">
697
698 <p>Get the minimum supported number of input channels. </p>
699
700 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p>
701
702 <p>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>
703
704 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">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#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">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#l00265">runPlugin()</a>.</p>
705
706 </div>
707 </div>
708 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="ZeroCrossing::getMaxChannelCount" ref="a2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
709 <div class="memitem">
710 <div class="memproto">
711 <table class="memname">
712 <tr>
713 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
714 <td>(</td>
715 <td class="paramname"></td><td>)</td>
716 <td> const<code> [inline, virtual, inherited]</code></td>
717 </tr>
718 </table>
719 </div>
720 <div class="memdoc">
721
722 <p>Get the maximum supported number of input channels. </p>
723
724 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p>
725
726 <p>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>
727
728 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">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#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">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#l00265">runPlugin()</a>.</p>
729
730 </div>
731 </div>
732 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="ZeroCrossing::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
733 <div class="memitem">
734 <div class="memproto">
735 <table class="memname">
736 <tr>
737 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
738 <td>(</td>
739 <td class="paramname"></td><td>)</td>
740 <td> const<code> [inline, virtual, inherited]</code></td>
741 </tr>
742 </table>
743 </div>
744 <div class="memdoc">
745
746 <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 <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. </p>
747 <p>Do not reimplement this function in your subclass. </p>
748
749 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
750
751 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00430">430</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
752
753 </div>
754 </div>
755 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="ZeroCrossing::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
756 <div class="memitem">
757 <div class="memproto">
758 <table class="memname">
759 <tr>
760 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
761 <td>(</td>
762 <td class="paramname"></td><td>)</td>
763 <td> const<code> [inline, virtual, inherited]</code></td>
764 </tr>
765 </table>
766 </div>
767 <div class="memdoc">
768
769 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
770
771 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p>
772
773 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00072">72</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
774
775 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
776
777 </div>
778 </div>
779 <a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="ZeroCrossing::getParameterDescriptors" ref="aac3e49b3b66cacfbb768dfdf07444f21" args="() const " -->
780 <div class="memitem">
781 <div class="memproto">
782 <table class="memname">
783 <tr>
784 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
785 <td>(</td>
786 <td class="paramname"></td><td>)</td>
787 <td> const<code> [inline, virtual, inherited]</code></td>
788 </tr>
789 </table>
790 </div>
791 <div class="memdoc">
792
793 <p>Get the controllable parameters of this plugin. </p>
794
795 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#ae157465a4e07d180bab05b5c3a4d8987">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector</a>.</p>
796
797 <p>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>
798
799 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
800
801 </div>
802 </div>
803 <a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="ZeroCrossing::getParameter" ref="a97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " -->
804 <div class="memitem">
805 <div class="memproto">
806 <table class="memname">
807 <tr>
808 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
809 <td>(</td>
810 <td class="paramtype">std::string&#160;</td>
811 <td class="paramname"></td><td>)</td>
812 <td> const<code> [inline, virtual, inherited]</code></td>
813 </tr>
814 </table>
815 </div>
816 <div class="memdoc">
817
818 <p>Get the value of a named parameter. </p>
819 <p>The argument is the identifier field from that parameter's descriptor. </p>
820
821 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a2030b05fb1228b30ace16200780c9152">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector</a>.</p>
822
823 <p>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>
824
825 </div>
826 </div>
827 <a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="ZeroCrossing::setParameter" ref="a6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" -->
828 <div class="memitem">
829 <div class="memproto">
830 <table class="memname">
831 <tr>
832 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
833 <td>(</td>
834 <td class="paramtype">std::string&#160;</td>
835 <td class="paramname">, </td>
836 </tr>
837 <tr>
838 <td class="paramkey"></td>
839 <td></td>
840 <td class="paramtype">float&#160;</td>
841 <td class="paramname">&#160;</td>
842 </tr>
843 <tr>
844 <td></td>
845 <td>)</td>
846 <td></td><td><code> [inline, virtual, inherited]</code></td>
847 </tr>
848 </table>
849 </div>
850 <div class="memdoc">
851
852 <p>Set a named parameter. </p>
853 <p>The first argument is the identifier field from that parameter's descriptor. </p>
854
855 <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>
856
857 <p>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>
858
859 </div>
860 </div>
861 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="ZeroCrossing::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
862 <div class="memitem">
863 <div class="memproto">
864 <table class="memname">
865 <tr>
866 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
867 <td>(</td>
868 <td class="paramname"></td><td>)</td>
869 <td> const<code> [inline, virtual, inherited]</code></td>
870 </tr>
871 </table>
872 </div>
873 <div class="memdoc">
874
875 <p>Get the program settings available in this plugin. </p>
876 <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>
877 <p>The programs must have unique names. </p>
878
879 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p>
880
881 <p>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>
882
883 </div>
884 </div>
885 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="ZeroCrossing::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
886 <div class="memitem">
887 <div class="memproto">
888 <table class="memname">
889 <tr>
890 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
891 <td>(</td>
892 <td class="paramname"></td><td>)</td>
893 <td> const<code> [inline, virtual, inherited]</code></td>
894 </tr>
895 </table>
896 </div>
897 <div class="memdoc">
898
899 <p>Get the current program. </p>
900
901 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p>
902
903 <p>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>
904
905 </div>
906 </div>
907 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="ZeroCrossing::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" -->
908 <div class="memitem">
909 <div class="memproto">
910 <table class="memname">
911 <tr>
912 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
913 <td>(</td>
914 <td class="paramtype">std::string&#160;</td>
915 <td class="paramname"></td><td>)</td>
916 <td><code> [inline, virtual, inherited]</code></td>
917 </tr>
918 </table>
919 </div>
920 <div class="memdoc">
921
922 <p>Select a program. </p>
923 <p>(If the given program name is not one of the available programs, do nothing.) </p>
924
925 <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>
926
927 <p>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>
928
929 </div>
930 </div>
931 <hr/><h2>Member Data Documentation</h2>
932 <a class="anchor" id="a584f100b87c78f9af9da040d79567d52"></a><!-- doxytag: member="ZeroCrossing::m_stepSize" ref="a584f100b87c78f9af9da040d79567d52" args="" -->
933 <div class="memitem">
934 <div class="memproto">
935 <table class="memname">
936 <tr>
937 <td class="memname">size_t <a class="el" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">ZeroCrossing::m_stepSize</a><code> [protected]</code></td>
938 </tr>
939 </table>
940 </div>
941 <div class="memdoc">
942
943 <p>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>
944
945 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">initialise()</a>, and <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">process()</a>.</p>
946
947 </div>
948 </div>
949 <a class="anchor" id="a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"></a><!-- doxytag: member="ZeroCrossing::m_previousSample" ref="a0f2d9f2cab0a8a30344e1f2c0ebb8ee8" args="" -->
950 <div class="memitem">
951 <div class="memproto">
952 <table class="memname">
953 <tr>
954 <td class="memname">float <a class="el" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">ZeroCrossing::m_previousSample</a><code> [protected]</code></td>
955 </tr>
956 </table>
957 </div>
958 <div class="memdoc">
959
960 <p>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>
961
962 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">process()</a>, and <a class="el" href="ZeroCrossing_8cpp_source.html#l00105">reset()</a>.</p>
963
964 </div>
965 </div>
966 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="ZeroCrossing::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
967 <div class="memitem">
968 <div class="memproto">
969 <table class="memname">
970 <tr>
971 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
972 </tr>
973 </table>
974 </div>
975 <div class="memdoc">
976
977 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">436</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
978
979 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00375">FixedTempoEstimator::D::calculate()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">process()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p>
980
981 </div>
982 </div>
983 <hr/>The documentation for this class was generated from the following files:<ul>
984 <li><a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a></li>
985 <li><a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a></li>
986 </ul>
987 </div>
988 </div>
989 <div id="nav-path" class="navpath">
990 <ul>
991 <li class="navelem"><a class="el" href="classZeroCrossing.html">ZeroCrossing</a> </li>
992
993 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
994 <a href="http://www.doxygen.org/index.html">
995 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
996 </ul>
997 </div>
998
999
1000 </body>
1001 </html>