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