Mercurial > hg > vamp-website

comparison code-doc/classZeroCrossing.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children cc0be37dc9d3
comparison
equal deleted inserted replaced
-1:000000000000 0:351c4ebce5f9
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: ZeroCrossing Class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul>
17 </div>
18 <div class="tabs">
19 <ul>
20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23 </ul>
24 </div>
25 </div>
26 <div class="contents">
27 <h1>ZeroCrossing Class Reference</h1><!-- doxytag: class="ZeroCrossing" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include &lt;<a class="el" href="ZeroCrossing_8h-source.html">ZeroCrossing.h</a>&gt;</code>
28 <p>
29 <div class="dynheader">
30 Inheritance diagram for ZeroCrossing:</div>
31 <div class="dynsection">
32 <p><center><img src="classZeroCrossing__inherit__graph.png" border="0" usemap="#ZeroCrossing__inherit__map" alt="Inheritance graph"></center>
33 <map name="ZeroCrossing__inherit__map">
34 <area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="20,82,119,106"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="5,7,133,31"></map>
35 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
36
37 <p>
38 <a href="classZeroCrossing-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
39 Example plugin that calculates the positions and density of zero-crossing points in an audio waveform.
40 <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>
41 <table border="0" cellpadding="0" cellspacing="0">
42 <tr><td></td></tr>
43 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
45 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
46 }</td></tr>
47
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
49 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
50
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
52
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br>
54 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
55
56 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
57 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
58
59 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
60
61 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#9855153a54bdc9ba75cc1a705a149473">ZeroCrossing</a> (float inputSampleRate)</td></tr>
63
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#f1de0da862e6e2443581e4e16044675b">~ZeroCrossing</a> ()</td></tr>
65
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#f21bbcc87a6eb7875dfab7d86222dccc">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
67
68 <tr><td class="mdescLeft">&nbsp;</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="#f21bbcc87a6eb7875dfab7d86222dccc"></a><br></td></tr>
69 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#9ae6c4a31ea027dceb1e97ead807e228">reset</a> ()</td></tr>
70
71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#9ae6c4a31ea027dceb1e97ead807e228"></a><br></td></tr>
72 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#afe2ce6ebd353a14c40db7e8e60f4051">getInputDomain</a> () const </td></tr>
73
74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#afe2ce6ebd353a14c40db7e8e60f4051"></a><br></td></tr>
75 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#f2baf9e19fcdd11cfe97ace56d4f5c1a">getIdentifier</a> () const </td></tr>
76
77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#f2baf9e19fcdd11cfe97ace56d4f5c1a"></a><br></td></tr>
78 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#fa96f7ce6e7d9f03768f48c6a9d88498">getName</a> () const </td></tr>
79
80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#fa96f7ce6e7d9f03768f48c6a9d88498"></a><br></td></tr>
81 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#710bb0b013157adaeef2a9e6867b4478">getDescription</a> () const </td></tr>
82
83 <tr><td class="mdescLeft">&nbsp;</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="#710bb0b013157adaeef2a9e6867b4478"></a><br></td></tr>
84 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#c68561634a3c329a029c2fd3deaeae2a">getMaker</a> () const </td></tr>
85
86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#c68561634a3c329a029c2fd3deaeae2a"></a><br></td></tr>
87 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#d685f6c2f443f07a1634550c335571eb">getPluginVersion</a> () const </td></tr>
88
89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#d685f6c2f443f07a1634550c335571eb"></a><br></td></tr>
90 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#f9c41b92aa8ff8bddaebf75569ff789c">getCopyright</a> () const </td></tr>
91
92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#f9c41b92aa8ff8bddaebf75569ff789c"></a><br></td></tr>
93 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#c9d590a6feb1fc9a37d7892aefe2b688">getOutputDescriptors</a> () const </td></tr>
94
95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#c9d590a6feb1fc9a37d7892aefe2b688"></a><br></td></tr>
96 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#bf4aaa6fd8cc03de63f4e1e8942633da">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
97
98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#bf4aaa6fd8cc03de63f4e1e8942633da"></a><br></td></tr>
99 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#70996d1b7166e303903daf92a9a37ad8">getRemainingFeatures</a> ()</td></tr>
100
101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#70996d1b7166e303903daf92a9a37ad8"></a><br></td></tr>
102 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr>
103
104 <tr><td class="mdescLeft">&nbsp;</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#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). <a href="#a529adf83f87a603954eb31407602aac"></a><br></td></tr>
105 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr>
106
107 <tr><td class="mdescLeft">&nbsp;</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#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#514c716c22f81c055f19b56c3f882567"></a><br></td></tr>
108 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr>
109
110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#267b42e866df3cf0d190893e8096f525"></a><br></td></tr>
111 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr>
112
113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br></td></tr>
114 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
115
116 <tr><td class="mdescLeft">&nbsp;</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...">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="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
117 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr>
118
119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin. <a href="#8fd2c48291c64b790f0efb8948508dcf"></a><br></td></tr>
120 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr>
121
122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#ac3e49b3b66cacfbb768dfdf07444f21"></a><br></td></tr>
123 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr>
124
125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#97ababcd45348ceec998d0f8e0f38bf7"></a><br></td></tr>
126 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr>
127
128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#6c718ce822f7b73b98940d59dcaa9366"></a><br></td></tr>
129 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr>
130
131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#bb307c60bdb981d5f5af50c3c4ae84af"></a><br></td></tr>
132 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr>
133
134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#24e77eccf1bdfbbca3c79bb25e8799b3"></a><br></td></tr>
135 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
136
137 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#add3a547ef140bae200473a9518e3353"></a><br></td></tr>
138 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
139 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#584f100b87c78f9af9da040d79567d52">m_stepSize</a></td></tr>
140
141 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a></td></tr>
142
143 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
144
145 </table>
146 <hr><h2>Member Typedef Documentation</h2>
147 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="ZeroCrossing::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
148 <div class="memitem">
149 <div class="memproto">
150 <table class="memname">
151 <tr>
152 <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#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td>
153 </tr>
154 </table>
155 </div>
156 <div class="memdoc">
157
158 <p>
159
160 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00309">309</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
161
162 </div>
163 </div><p>
164 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="ZeroCrossing::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
165 <div class="memitem">
166 <div class="memproto">
167 <table class="memname">
168 <tr>
169 <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#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td>
170 </tr>
171 </table>
172 </div>
173 <div class="memdoc">
174
175 <p>
176
177 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
178
179 </div>
180 </div><p>
181 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="ZeroCrossing::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
182 <div class="memitem">
183 <div class="memproto">
184 <table class="memname">
185 <tr>
186 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td>
187 </tr>
188 </table>
189 </div>
190 <div class="memdoc">
191
192 <p>
193
194 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00348">348</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
195
196 </div>
197 </div><p>
198 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="ZeroCrossing::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
199 <div class="memitem">
200 <div class="memproto">
201 <table class="memname">
202 <tr>
203 <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#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td>
204 </tr>
205 </table>
206 </div>
207 <div class="memdoc">
208
209 <p>
210
211 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00195">195</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
212
213 </div>
214 </div><p>
215 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="ZeroCrossing::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
216 <div class="memitem">
217 <div class="memproto">
218 <table class="memname">
219 <tr>
220 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td>
221 </tr>
222 </table>
223 </div>
224 <div class="memdoc">
225
226 <p>
227
228 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00217">217</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
229
230 </div>
231 </div><p>
232 <hr><h2>Member Enumeration Documentation</h2>
233 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="ZeroCrossing::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
234 <div class="memitem">
235 <div class="memproto">
236 <table class="memname">
237 <tr>
238 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
239 </tr>
240 </table>
241 </div>
242 <div class="memdoc">
243
244 <p>
245 <dl compact><dt><b>Enumerator: </b></dt><dd>
246 <table border="0" cellspacing="2" cellpadding="0">
247 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
248 </td></tr>
249 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
250 </td></tr>
251 </table>
252 </dl>
253
254 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00149">149</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
255
256 </div>
257 </div><p>
258 <hr><h2>Constructor &amp; Destructor Documentation</h2>
259 <a class="anchor" name="9855153a54bdc9ba75cc1a705a149473"></a><!-- doxytag: member="ZeroCrossing::ZeroCrossing" ref="9855153a54bdc9ba75cc1a705a149473" args="(float inputSampleRate)" -->
260 <div class="memitem">
261 <div class="memproto">
262 <table class="memname">
263 <tr>
264 <td class="memname">ZeroCrossing::ZeroCrossing </td>
265 <td>(</td>
266 <td class="paramtype">float&nbsp;</td>
267 <td class="paramname"> <em>inputSampleRate</em> </td>
268 <td>&nbsp;)&nbsp;</td>
269 <td width="100%"></td>
270 </tr>
271 </table>
272 </div>
273 <div class="memdoc">
274
275 <p>
276
277 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00045">45</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
278
279 </div>
280 </div><p>
281 <a class="anchor" name="f1de0da862e6e2443581e4e16044675b"></a><!-- doxytag: member="ZeroCrossing::~ZeroCrossing" ref="f1de0da862e6e2443581e4e16044675b" args="()" -->
282 <div class="memitem">
283 <div class="memproto">
284 <table class="memname">
285 <tr>
286 <td class="memname">ZeroCrossing::~ZeroCrossing </td>
287 <td>(</td>
288 <td class="paramname"> </td>
289 <td>&nbsp;)&nbsp;</td>
290 <td width="100%"><code> [virtual]</code></td>
291 </tr>
292 </table>
293 </div>
294 <div class="memdoc">
295
296 <p>
297
298 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00052">52</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
299
300 </div>
301 </div><p>
302 <hr><h2>Member Function Documentation</h2>
303 <a class="anchor" name="f21bbcc87a6eb7875dfab7d86222dccc"></a><!-- doxytag: member="ZeroCrossing::initialise" ref="f21bbcc87a6eb7875dfab7d86222dccc" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
304 <div class="memitem">
305 <div class="memproto">
306 <table class="memname">
307 <tr>
308 <td class="memname">bool ZeroCrossing::initialise </td>
309 <td>(</td>
310 <td class="paramtype">size_t&nbsp;</td>
311 <td class="paramname"> <em>inputChannels</em>, </td>
312 </tr>
313 <tr>
314 <td class="paramkey"></td>
315 <td></td>
316 <td class="paramtype">size_t&nbsp;</td>
317 <td class="paramname"> <em>stepSize</em>, </td>
318 </tr>
319 <tr>
320 <td class="paramkey"></td>
321 <td></td>
322 <td class="paramtype">size_t&nbsp;</td>
323 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
324 </tr>
325 <tr>
326 <td></td>
327 <td>)</td>
328 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
329 </tr>
330 </table>
331 </div>
332 <div class="memdoc">
333
334 <p>
335 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).
336 <p>
337 The input sample rate should have been already specified at construction time.<p>
338 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
339 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
340
341 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00093">93</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
342
343 <p>References <a class="el" href="Plugin_8h-source.html#l00196">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="Plugin_8h-source.html#l00191">Vamp::Plugin::getMinChannelCount()</a>, and <a class="el" href="ZeroCrossing_8h-source.html#l00073">m_stepSize</a>.</p>
344
345 </div>
346 </div><p>
347 <a class="anchor" name="9ae6c4a31ea027dceb1e97ead807e228"></a><!-- doxytag: member="ZeroCrossing::reset" ref="9ae6c4a31ea027dceb1e97ead807e228" args="()" -->
348 <div class="memitem">
349 <div class="memproto">
350 <table class="memname">
351 <tr>
352 <td class="memname">void ZeroCrossing::reset </td>
353 <td>(</td>
354 <td class="paramname"> </td>
355 <td>&nbsp;)&nbsp;</td>
356 <td width="100%"><code> [virtual]</code></td>
357 </tr>
358 </table>
359 </div>
360 <div class="memdoc">
361
362 <p>
363 Reset the plugin after use, to prepare it for another clean run.
364 <p>
365 Not called for the first initialisation (i.e. initialise must also do a reset).
366 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
367
368 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00104">104</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
369
370 <p>References <a class="el" href="ZeroCrossing_8h-source.html#l00074">m_previousSample</a>.</p>
371
372 </div>
373 </div><p>
374 <a class="anchor" name="afe2ce6ebd353a14c40db7e8e60f4051"></a><!-- doxytag: member="ZeroCrossing::getInputDomain" ref="afe2ce6ebd353a14c40db7e8e60f4051" args="() const " -->
375 <div class="memitem">
376 <div class="memproto">
377 <table class="memname">
378 <tr>
379 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> ZeroCrossing::getInputDomain </td>
380 <td>(</td>
381 <td class="paramname"> </td>
382 <td>&nbsp;)&nbsp;</td>
383 <td width="100%"> const<code> [inline, virtual]</code></td>
384 </tr>
385 </table>
386 </div>
387 <div class="memdoc">
388
389 <p>
390 Get the plugin's required input domain.
391 <p>
392 If this is TimeDomain, the samples provided to the <a class="el" href="classZeroCrossing.html#bf4aaa6fd8cc03de63f4e1e8942633da" 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. 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#bf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data.">process()</a>. 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.
393 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
394
395 <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>
396
397 <p>References <a class="el" href="Plugin_8h-source.html#l00149">Vamp::Plugin::TimeDomain</a>.</p>
398
399 </div>
400 </div><p>
401 <a class="anchor" name="f2baf9e19fcdd11cfe97ace56d4f5c1a"></a><!-- doxytag: member="ZeroCrossing::getIdentifier" ref="f2baf9e19fcdd11cfe97ace56d4f5c1a" args="() const " -->
402 <div class="memitem">
403 <div class="memproto">
404 <table class="memname">
405 <tr>
406 <td class="memname">string ZeroCrossing::getIdentifier </td>
407 <td>(</td>
408 <td class="paramname"> </td>
409 <td>&nbsp;)&nbsp;</td>
410 <td width="100%"> const<code> [virtual]</code></td>
411 </tr>
412 </table>
413 </div>
414 <div class="memdoc">
415
416 <p>
417 Get the computer-usable name of the plugin.
418 <p>
419 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>
420 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>
421 Example: "zero_crossings"
422 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
423
424 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00057">57</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
425
426 </div>
427 </div><p>
428 <a class="anchor" name="fa96f7ce6e7d9f03768f48c6a9d88498"></a><!-- doxytag: member="ZeroCrossing::getName" ref="fa96f7ce6e7d9f03768f48c6a9d88498" args="() const " -->
429 <div class="memitem">
430 <div class="memproto">
431 <table class="memname">
432 <tr>
433 <td class="memname">string ZeroCrossing::getName </td>
434 <td>(</td>
435 <td class="paramname"> </td>
436 <td>&nbsp;)&nbsp;</td>
437 <td width="100%"> const<code> [virtual]</code></td>
438 </tr>
439 </table>
440 </div>
441 <div class="memdoc">
442
443 <p>
444 Get a human-readable name or title of the plugin.
445 <p>
446 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 Example: "Zero Crossings"
448 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
449
450 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00063">63</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
451
452 </div>
453 </div><p>
454 <a class="anchor" name="710bb0b013157adaeef2a9e6867b4478"></a><!-- doxytag: member="ZeroCrossing::getDescription" ref="710bb0b013157adaeef2a9e6867b4478" args="() const " -->
455 <div class="memitem">
456 <div class="memproto">
457 <table class="memname">
458 <tr>
459 <td class="memname">string ZeroCrossing::getDescription </td>
460 <td>(</td>
461 <td class="paramname"> </td>
462 <td>&nbsp;)&nbsp;</td>
463 <td width="100%"> const<code> [virtual]</code></td>
464 </tr>
465 </table>
466 </div>
467 <div class="memdoc">
468
469 <p>
470 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".
471 <p>
472 May be empty if the name has said it all already.<p>
473 Example: "Detect and count zero crossing points"
474 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
475
476 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00069">69</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
477
478 </div>
479 </div><p>
480 <a class="anchor" name="c68561634a3c329a029c2fd3deaeae2a"></a><!-- doxytag: member="ZeroCrossing::getMaker" ref="c68561634a3c329a029c2fd3deaeae2a" args="() const " -->
481 <div class="memitem">
482 <div class="memproto">
483 <table class="memname">
484 <tr>
485 <td class="memname">string ZeroCrossing::getMaker </td>
486 <td>(</td>
487 <td class="paramname"> </td>
488 <td>&nbsp;)&nbsp;</td>
489 <td width="100%"> const<code> [virtual]</code></td>
490 </tr>
491 </table>
492 </div>
493 <div class="memdoc">
494
495 <p>
496 Get the name of the author or vendor of the plugin in human-readable form.
497 <p>
498 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
499 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
500
501 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00075">75</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
502
503 </div>
504 </div><p>
505 <a class="anchor" name="d685f6c2f443f07a1634550c335571eb"></a><!-- doxytag: member="ZeroCrossing::getPluginVersion" ref="d685f6c2f443f07a1634550c335571eb" args="() const " -->
506 <div class="memitem">
507 <div class="memproto">
508 <table class="memname">
509 <tr>
510 <td class="memname">int ZeroCrossing::getPluginVersion </td>
511 <td>(</td>
512 <td class="paramname"> </td>
513 <td>&nbsp;)&nbsp;</td>
514 <td width="100%"> const<code> [virtual]</code></td>
515 </tr>
516 </table>
517 </div>
518 <div class="memdoc">
519
520 <p>
521 Get the version number of the plugin.
522 <p>
523
524 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
525
526 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00081">81</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
527
528 </div>
529 </div><p>
530 <a class="anchor" name="f9c41b92aa8ff8bddaebf75569ff789c"></a><!-- doxytag: member="ZeroCrossing::getCopyright" ref="f9c41b92aa8ff8bddaebf75569ff789c" args="() const " -->
531 <div class="memitem">
532 <div class="memproto">
533 <table class="memname">
534 <tr>
535 <td class="memname">string ZeroCrossing::getCopyright </td>
536 <td>(</td>
537 <td class="paramname"> </td>
538 <td>&nbsp;)&nbsp;</td>
539 <td width="100%"> const<code> [virtual]</code></td>
540 </tr>
541 </table>
542 </div>
543 <div class="memdoc">
544
545 <p>
546 Get the copyright statement or licensing summary for the plugin.
547 <p>
548 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
549 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
550
551 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00087">87</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
552
553 </div>
554 </div><p>
555 <a class="anchor" name="c9d590a6feb1fc9a37d7892aefe2b688"></a><!-- doxytag: member="ZeroCrossing::getOutputDescriptors" ref="c9d590a6feb1fc9a37d7892aefe2b688" args="() const " -->
556 <div class="memitem">
557 <div class="memproto">
558 <table class="memname">
559 <tr>
560 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">ZeroCrossing::OutputList</a> ZeroCrossing::getOutputDescriptors </td>
561 <td>(</td>
562 <td class="paramname"> </td>
563 <td>&nbsp;)&nbsp;</td>
564 <td width="100%"> const<code> [virtual]</code></td>
565 </tr>
566 </table>
567 </div>
568 <div class="memdoc">
569
570 <p>
571 Get the outputs of this plugin.
572 <p>
573 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#bf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data.">process()</a> call.
574 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
575
576 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">110</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
577
578 <p>References <a class="el" href="Plugin_8h-source.html#l00239">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="Plugin_8h-source.html#l00219">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="Plugin_8h-source.html#l00231">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="Plugin_8h-source.html#l00252">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="Plugin_8h-source.html#l00206">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="Plugin_8h-source.html#l00270">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="Plugin_8h-source.html#l00397">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="Plugin_8h-source.html#l00212">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="Plugin_8h-source.html#l00282">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="Plugin_8h-source.html#l00277">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="Plugin_8h-source.html#l00306">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="Plugin_8h-source.html#l00294">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="Plugin_8h-source.html#l00224">Vamp::Plugin::OutputDescriptor::unit</a>, and <a class="el" href="Plugin_8h-source.html#l00288">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p>
579
580 </div>
581 </div><p>
582 <a class="anchor" name="bf4aaa6fd8cc03de63f4e1e8942633da"></a><!-- doxytag: member="ZeroCrossing::process" ref="bf4aaa6fd8cc03de63f4e1e8942633da" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" -->
583 <div class="memitem">
584 <div class="memproto">
585 <table class="memname">
586 <tr>
587 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> ZeroCrossing::process </td>
588 <td>(</td>
589 <td class="paramtype">const float *const *&nbsp;</td>
590 <td class="paramname"> <em>inputBuffers</em>, </td>
591 </tr>
592 <tr>
593 <td class="paramkey"></td>
594 <td></td>
595 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a>&nbsp;</td>
596 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
597 </tr>
598 <tr>
599 <td></td>
600 <td>)</td>
601 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
602 </tr>
603 </table>
604 </div>
605 <div class="memdoc">
606
607 <p>
608 Process a single block of input data.
609 <p>
610 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 will be the real time in seconds of the start of the supplied block of samples.<p>
611 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>
612 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.)
613 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
614
615 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">141</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
616
617 <p>References <a class="el" href="RealTime_8cpp-source.html#l00232">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="Plugin_8h-source.html#l00325">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="Plugin_8h-source.html#l00397">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="Plugin_8h-source.html#l00332">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="Plugin_8h-source.html#l00339">Vamp::Plugin::Feature::values</a>.</p>
618
619 </div>
620 </div><p>
621 <a class="anchor" name="70996d1b7166e303903daf92a9a37ad8"></a><!-- doxytag: member="ZeroCrossing::getRemainingFeatures" ref="70996d1b7166e303903daf92a9a37ad8" args="()" -->
622 <div class="memitem">
623 <div class="memproto">
624 <table class="memname">
625 <tr>
626 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> ZeroCrossing::getRemainingFeatures </td>
627 <td>(</td>
628 <td class="paramname"> </td>
629 <td>&nbsp;)&nbsp;</td>
630 <td width="100%"><code> [virtual]</code></td>
631 </tr>
632 </table>
633 </div>
634 <div class="memdoc">
635
636 <p>
637 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
638 <p>
639
640 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
641
642 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp-source.html#l00190">190</a> of file <a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a>.</p>
643
644 </div>
645 </div><p>
646 <a class="anchor" name="a529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="ZeroCrossing::getPreferredBlockSize" ref="a529adf83f87a603954eb31407602aac" args="() const " -->
647 <div class="memitem">
648 <div class="memproto">
649 <table class="memname">
650 <tr>
651 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
652 <td>(</td>
653 <td class="paramname"> </td>
654 <td>&nbsp;)&nbsp;</td>
655 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
656 </tr>
657 </table>
658 </div>
659 <div class="memdoc">
660
661 <p>
662 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#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function).
663 <p>
664 This should be called before <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
665 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#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
666 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#d5e0ea8042bdec4dd18428991117e07a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>, and <a class="el" href="classPercussionOnsetDetector.html#410c0b47c6c849d7ed9b726b84402ad0">PercussionOnsetDetector</a>.</p>
667
668 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00171">171</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
669
670 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00164">Vamp::HostExt::PluginWrapper::getPreferredBlockSize()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00283">Vamp::HostExt::PluginInputDomainAdapter::Impl::getPreferredBlockSize()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00314">Vamp::HostExt::PluginBufferingAdapter::Impl::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
671
672 </div>
673 </div><p>
674 <a class="anchor" name="514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="ZeroCrossing::getPreferredStepSize" ref="514c716c22f81c055f19b56c3f882567" args="() const " -->
675 <div class="memitem">
676 <div class="memproto">
677 <table class="memname">
678 <tr>
679 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
680 <td>(</td>
681 <td class="paramname"> </td>
682 <td>&nbsp;)&nbsp;</td>
683 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
684 </tr>
685 </table>
686 </div>
687 <div class="memdoc">
688
689 <p>
690 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#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin.
691 <p>
692 This should be called before <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
693 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#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
694 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#859ad5d59402691daed3cf1af1899ebe">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>, and <a class="el" href="classPercussionOnsetDetector.html#733824891e11c306a7a678534b89b968">PercussionOnsetDetector</a>.</p>
695
696 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00186">186</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
697
698 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00158">Vamp::HostExt::PluginWrapper::getPreferredStepSize()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00271">Vamp::HostExt::PluginInputDomainAdapter::Impl::getPreferredStepSize()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00314">Vamp::HostExt::PluginBufferingAdapter::Impl::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
699
700 </div>
701 </div><p>
702 <a class="anchor" name="267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="ZeroCrossing::getMinChannelCount" ref="267b42e866df3cf0d190893e8096f525" args="() const " -->
703 <div class="memitem">
704 <div class="memproto">
705 <table class="memname">
706 <tr>
707 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
708 <td>(</td>
709 <td class="paramname"> </td>
710 <td>&nbsp;)&nbsp;</td>
711 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
712 </tr>
713 </table>
714 </div>
715 <div class="memdoc">
716
717 <p>
718 Get the minimum supported number of input channels.
719 <p>
720
721 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p>
722
723 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00191">191</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
724
725 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00170">Vamp::HostExt::PluginWrapper::getMinChannelCount()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00093">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00095">SpectralCentroid::initialise()</a>, <a class="el" href="PluginChannelAdapter_8cpp-source.html#l00119">Vamp::HostExt::PluginChannelAdapter::Impl::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>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
726
727 </div>
728 </div><p>
729 <a class="anchor" name="2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="ZeroCrossing::getMaxChannelCount" ref="2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " -->
730 <div class="memitem">
731 <div class="memproto">
732 <table class="memname">
733 <tr>
734 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
735 <td>(</td>
736 <td class="paramname"> </td>
737 <td>&nbsp;)&nbsp;</td>
738 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
739 </tr>
740 </table>
741 </div>
742 <div class="memdoc">
743
744 <p>
745 Get the maximum supported number of input channels.
746 <p>
747
748 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p>
749
750 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00196">196</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
751
752 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00175">Vamp::HostExt::PluginWrapper::getMaxChannelCount()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00093">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00095">SpectralCentroid::initialise()</a>, <a class="el" href="PluginChannelAdapter_8cpp-source.html#l00119">Vamp::HostExt::PluginChannelAdapter::Impl::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>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
753
754 </div>
755 </div><p>
756 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="ZeroCrossing::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
757 <div class="memitem">
758 <div class="memproto">
759 <table class="memname">
760 <tr>
761 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
762 <td>(</td>
763 <td class="paramname"> </td>
764 <td>&nbsp;)&nbsp;</td>
765 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
766 </tr>
767 </table>
768 </div>
769 <div class="memdoc">
770
771 <p>
772 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...">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>.
773 <p>
774 Do not reimplement this function in your subclass.
775 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
776
777 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00391">391</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
778
779 </div>
780 </div><p>
781 <a class="anchor" name="8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="ZeroCrossing::getVampApiVersion" ref="8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
782 <div class="memitem">
783 <div class="memproto">
784 <table class="memname">
785 <tr>
786 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
787 <td>(</td>
788 <td class="paramname"> </td>
789 <td>&nbsp;)&nbsp;</td>
790 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
791 </tr>
792 </table>
793 </div>
794 <div class="memdoc">
795
796 <p>
797 Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin.
798 <p>
799
800 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p>
801
802 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00067">67</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
803
804 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00080">Vamp::HostExt::PluginWrapper::getVampApiVersion()</a>.</p>
805
806 </div>
807 </div><p>
808 <a class="anchor" name="ac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="ZeroCrossing::getParameterDescriptors" ref="ac3e49b3b66cacfbb768dfdf07444f21" args="() const " -->
809 <div class="memitem">
810 <div class="memproto">
811 <table class="memname">
812 <tr>
813 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
814 <td>(</td>
815 <td class="paramname"> </td>
816 <td>&nbsp;)&nbsp;</td>
817 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
818 </tr>
819 </table>
820 </div>
821 <div class="memdoc">
822
823 <p>
824 Get the controllable parameters of this plugin.
825 <p>
826
827 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#bfa93b20d9b5651a32042a9bb7c8df13">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#3b075b8f950b344503f0d27ac0fe332e">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#9df01323a09e117bc12354ebe9244edf">AmplitudeFollower</a>, and <a class="el" href="classPercussionOnsetDetector.html#bceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector</a>.</p>
828
829 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00200">200</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
830
831 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00122">Vamp::HostExt::PluginWrapper::getParameterDescriptors()</a>.</p>
832
833 </div>
834 </div><p>
835 <a class="anchor" name="97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="ZeroCrossing::getParameter" ref="97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " -->
836 <div class="memitem">
837 <div class="memproto">
838 <table class="memname">
839 <tr>
840 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
841 <td>(</td>
842 <td class="paramtype">std::string&nbsp;</td>
843 <td class="paramname"> </td>
844 <td>&nbsp;)&nbsp;</td>
845 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
846 </tr>
847 </table>
848 </div>
849 <div class="memdoc">
850
851 <p>
852 Get the value of a named parameter.
853 <p>
854 The argument is the identifier field from that parameter's descriptor.
855 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#f0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#b278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower</a>, and <a class="el" href="classPercussionOnsetDetector.html#9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector</a>.</p>
856
857 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00208">208</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
858
859 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00128">Vamp::HostExt::PluginWrapper::getParameter()</a>.</p>
860
861 </div>
862 </div><p>
863 <a class="anchor" name="6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="ZeroCrossing::setParameter" ref="6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" -->
864 <div class="memitem">
865 <div class="memproto">
866 <table class="memname">
867 <tr>
868 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
869 <td>(</td>
870 <td class="paramtype">std::string&nbsp;</td>
871 <td class="paramname">, </td>
872 </tr>
873 <tr>
874 <td class="paramkey"></td>
875 <td></td>
876 <td class="paramtype">float&nbsp;</td>
877 <td class="paramname"></td><td>&nbsp;</td>
878 </tr>
879 <tr>
880 <td></td>
881 <td>)</td>
882 <td></td><td></td><td width="100%"><code> [inline, virtual, inherited]</code></td>
883 </tr>
884 </table>
885 </div>
886 <div class="memdoc">
887
888 <p>
889 Set a named parameter.
890 <p>
891 The first argument is the identifier field from that parameter's descriptor.
892 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#e1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, and <a class="el" href="classPercussionOnsetDetector.html#a097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p>
893
894 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00214">214</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
895
896 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00134">Vamp::HostExt::PluginWrapper::setParameter()</a>.</p>
897
898 </div>
899 </div><p>
900 <a class="anchor" name="bb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="ZeroCrossing::getPrograms" ref="bb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
901 <div class="memitem">
902 <div class="memproto">
903 <table class="memname">
904 <tr>
905 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
906 <td>(</td>
907 <td class="paramname"> </td>
908 <td>&nbsp;)&nbsp;</td>
909 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
910 </tr>
911 </table>
912 </div>
913 <div class="memdoc">
914
915 <p>
916 Get the program settings available in this plugin.
917 <p>
918 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>
919 The programs must have unique names.
920 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#7ac5681dcfe08b7b8a796bffc0aff3e3">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#f3abaf717dc4b00cad5770ed6dfa01e1">Vamp::HostExt::PluginWrapper</a>.</p>
921
922 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00229">229</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
923
924 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00140">Vamp::HostExt::PluginWrapper::getPrograms()</a>.</p>
925
926 </div>
927 </div><p>
928 <a class="anchor" name="24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="ZeroCrossing::getCurrentProgram" ref="24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
929 <div class="memitem">
930 <div class="memproto">
931 <table class="memname">
932 <tr>
933 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
934 <td>(</td>
935 <td class="paramname"> </td>
936 <td>&nbsp;)&nbsp;</td>
937 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
938 </tr>
939 </table>
940 </div>
941 <div class="memdoc">
942
943 <p>
944 Get the current program.
945 <p>
946
947 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p>
948
949 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00234">234</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
950
951 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00146">Vamp::HostExt::PluginWrapper::getCurrentProgram()</a>.</p>
952
953 </div>
954 </div><p>
955 <a class="anchor" name="add3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="ZeroCrossing::selectProgram" ref="add3a547ef140bae200473a9518e3353" args="(std::string)" -->
956 <div class="memitem">
957 <div class="memproto">
958 <table class="memname">
959 <tr>
960 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
961 <td>(</td>
962 <td class="paramtype">std::string&nbsp;</td>
963 <td class="paramname"> </td>
964 <td>&nbsp;)&nbsp;</td>
965 <td width="100%"><code> [inline, virtual, inherited]</code></td>
966 </tr>
967 </table>
968 </div>
969 <div class="memdoc">
970
971 <p>
972 Select a program.
973 <p>
974 (If the given program name is not one of the available programs, do nothing.)
975 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
976
977 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00240">240</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
978
979 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00152">Vamp::HostExt::PluginWrapper::selectProgram()</a>.</p>
980
981 </div>
982 </div><p>
983 <hr><h2>Member Data Documentation</h2>
984 <a class="anchor" name="584f100b87c78f9af9da040d79567d52"></a><!-- doxytag: member="ZeroCrossing::m_stepSize" ref="584f100b87c78f9af9da040d79567d52" args="" -->
985 <div class="memitem">
986 <div class="memproto">
987 <table class="memname">
988 <tr>
989 <td class="memname">size_t <a class="el" href="classZeroCrossing.html#584f100b87c78f9af9da040d79567d52">ZeroCrossing::m_stepSize</a><code> [protected]</code> </td>
990 </tr>
991 </table>
992 </div>
993 <div class="memdoc">
994
995 <p>
996
997 <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>
998
999 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00093">initialise()</a>, and <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">process()</a>.</p>
1000
1001 </div>
1002 </div><p>
1003 <a class="anchor" name="0f2d9f2cab0a8a30344e1f2c0ebb8ee8"></a><!-- doxytag: member="ZeroCrossing::m_previousSample" ref="0f2d9f2cab0a8a30344e1f2c0ebb8ee8" args="" -->
1004 <div class="memitem">
1005 <div class="memproto">
1006 <table class="memname">
1007 <tr>
1008 <td class="memname">float <a class="el" href="classZeroCrossing.html#0f2d9f2cab0a8a30344e1f2c0ebb8ee8">ZeroCrossing::m_previousSample</a><code> [protected]</code> </td>
1009 </tr>
1010 </table>
1011 </div>
1012 <div class="memdoc">
1013
1014 <p>
1015
1016 <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>
1017
1018 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">process()</a>, and <a class="el" href="ZeroCrossing_8cpp-source.html#l00104">reset()</a>.</p>
1019
1020 </div>
1021 </div><p>
1022 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="ZeroCrossing::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
1023 <div class="memitem">
1024 <div class="memproto">
1025 <table class="memname">
1026 <tr>
1027 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
1028 </tr>
1029 </table>
1030 </div>
1031 <div class="memdoc">
1032
1033 <p>
1034
1035 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00397">397</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
1036
1037 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00047">Vamp::HostExt::PluginRateExtractor::getRate()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00113">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
1038
1039 </div>
1040 </div><p>
1041 <hr>The documentation for this class was generated from the following files:<ul>
1042 <li><a class="el" href="ZeroCrossing_8h-source.html">ZeroCrossing.h</a><li><a class="el" href="ZeroCrossing_8cpp-source.html">ZeroCrossing.cpp</a></ul>
1043 </div>
1044 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:08 2008 for VampPluginSDK by&nbsp;
1045 <a href="http://www.doxygen.org/index.html">
1046 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
1047 </body>
1048 </html>