Mercurial > hg > vamp-website

diff code-doc/ZeroCrossing_8cpp-source.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
line wrap: on
line diff
--- a/code-doc/ZeroCrossing_8cpp-source.html	Mon Nov 24 15:17:08 2008 +0000
+++ b/code-doc/ZeroCrossing_8cpp-source.html	Tue Dec 09 11:02:57 2008 +0000
@@ -4,7 +4,7 @@
 <link href="doxygen.css" rel="stylesheet" type="text/css">
 <link href="tabs.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.5.5 -->
+<!-- Generated by Doxygen 1.5.6 -->
 <div class="navigation" id="top">
   <div class="tabs">
     <ul>
@@ -18,7 +18,7 @@
   <div class="navpath"><a class="el" href="dir_35887283b966ca996e4ff77f459c38ce.html">examples</a>
   </div>
 </div>
-</div>
+<div class="contents">
 <h1>ZeroCrossing.cpp</h1><a href="ZeroCrossing_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */</span>
 <a name="l00002"></a>00002 
 <a name="l00003"></a>00003 <span class="comment">/*</span>
@@ -62,160 +62,161 @@
 <a name="l00041"></a>00041 <span class="keyword">using</span> std::cerr;
 <a name="l00042"></a>00042 <span class="keyword">using</span> std::endl;
 <a name="l00043"></a>00043 
-<a name="l00044"></a>00044 
-<a name="l00045"></a><a class="code" href="classZeroCrossing.html#9855153a54bdc9ba75cc1a705a149473">00045</a> <a class="code" href="classZeroCrossing.html#9855153a54bdc9ba75cc1a705a149473">ZeroCrossing::ZeroCrossing</a>(<span class="keywordtype">float</span> inputSampleRate) :
-<a name="l00046"></a>00046     Plugin(inputSampleRate),
-<a name="l00047"></a>00047     m_stepSize(0),
-<a name="l00048"></a>00048     m_previousSample(0.0f)
-<a name="l00049"></a>00049 {
-<a name="l00050"></a>00050 }
-<a name="l00051"></a>00051 
-<a name="l00052"></a><a class="code" href="classZeroCrossing.html#f1de0da862e6e2443581e4e16044675b">00052</a> <a class="code" href="classZeroCrossing.html#f1de0da862e6e2443581e4e16044675b">ZeroCrossing::~ZeroCrossing</a>()
-<a name="l00053"></a>00053 {
-<a name="l00054"></a>00054 }
-<a name="l00055"></a>00055 
-<a name="l00056"></a>00056 <span class="keywordtype">string</span>
-<a name="l00057"></a><a class="code" href="classZeroCrossing.html#f2baf9e19fcdd11cfe97ace56d4f5c1a">00057</a> <a class="code" href="classZeroCrossing.html#f2baf9e19fcdd11cfe97ace56d4f5c1a" title="Get the computer-usable name of the plugin.">ZeroCrossing::getIdentifier</a>()<span class="keyword"> const</span>
-<a name="l00058"></a>00058 <span class="keyword"></span>{
-<a name="l00059"></a>00059     <span class="keywordflow">return</span> <span class="stringliteral">"zerocrossing"</span>;
-<a name="l00060"></a>00060 }
-<a name="l00061"></a>00061 
-<a name="l00062"></a>00062 <span class="keywordtype">string</span>
-<a name="l00063"></a><a class="code" href="classZeroCrossing.html#fa96f7ce6e7d9f03768f48c6a9d88498">00063</a> <a class="code" href="classZeroCrossing.html#fa96f7ce6e7d9f03768f48c6a9d88498" title="Get a human-readable name or title of the plugin.">ZeroCrossing::getName</a>()<span class="keyword"> const</span>
-<a name="l00064"></a>00064 <span class="keyword"></span>{
-<a name="l00065"></a>00065     <span class="keywordflow">return</span> <span class="stringliteral">"Zero Crossings"</span>;
-<a name="l00066"></a>00066 }
-<a name="l00067"></a>00067 
-<a name="l00068"></a>00068 <span class="keywordtype">string</span>
-<a name="l00069"></a><a class="code" href="classZeroCrossing.html#710bb0b013157adaeef2a9e6867b4478">00069</a> <a class="code" href="classZeroCrossing.html#710bb0b013157adaeef2a9e6867b4478" title="Get a human-readable description for the plugin, typically a line of text that may...">ZeroCrossing::getDescription</a>()<span class="keyword"> const</span>
-<a name="l00070"></a>00070 <span class="keyword"></span>{
-<a name="l00071"></a>00071     <span class="keywordflow">return</span> <span class="stringliteral">"Detect and count zero crossing points"</span>;
-<a name="l00072"></a>00072 }
-<a name="l00073"></a>00073 
-<a name="l00074"></a>00074 <span class="keywordtype">string</span>
-<a name="l00075"></a><a class="code" href="classZeroCrossing.html#c68561634a3c329a029c2fd3deaeae2a">00075</a> <a class="code" href="classZeroCrossing.html#c68561634a3c329a029c2fd3deaeae2a" title="Get the name of the author or vendor of the plugin in human-readable form.">ZeroCrossing::getMaker</a>()<span class="keyword"> const</span>
-<a name="l00076"></a>00076 <span class="keyword"></span>{
-<a name="l00077"></a>00077     <span class="keywordflow">return</span> <span class="stringliteral">"Vamp SDK Example Plugins"</span>;
-<a name="l00078"></a>00078 }
-<a name="l00079"></a>00079 
-<a name="l00080"></a>00080 <span class="keywordtype">int</span>
-<a name="l00081"></a><a class="code" href="classZeroCrossing.html#d685f6c2f443f07a1634550c335571eb">00081</a> <a class="code" href="classZeroCrossing.html#d685f6c2f443f07a1634550c335571eb" title="Get the version number of the plugin.">ZeroCrossing::getPluginVersion</a>()<span class="keyword"> const</span>
-<a name="l00082"></a>00082 <span class="keyword"></span>{
-<a name="l00083"></a>00083     <span class="keywordflow">return</span> 2;
-<a name="l00084"></a>00084 }
-<a name="l00085"></a>00085 
-<a name="l00086"></a>00086 <span class="keywordtype">string</span>
-<a name="l00087"></a><a class="code" href="classZeroCrossing.html#f9c41b92aa8ff8bddaebf75569ff789c">00087</a> <a class="code" href="classZeroCrossing.html#f9c41b92aa8ff8bddaebf75569ff789c" title="Get the copyright statement or licensing summary for the plugin.">ZeroCrossing::getCopyright</a>()<span class="keyword"> const</span>
-<a name="l00088"></a>00088 <span class="keyword"></span>{
-<a name="l00089"></a>00089     <span class="keywordflow">return</span> <span class="stringliteral">"Freely redistributable (BSD license)"</span>;
-<a name="l00090"></a>00090 }
-<a name="l00091"></a>00091 
-<a name="l00092"></a>00092 <span class="keywordtype">bool</span>
-<a name="l00093"></a><a class="code" href="classZeroCrossing.html#f21bbcc87a6eb7875dfab7d86222dccc">00093</a> <a class="code" href="classZeroCrossing.html#f21bbcc87a6eb7875dfab7d86222dccc" title="Initialise a plugin to prepare it for use with the given number of input channels...">ZeroCrossing::initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize)
-<a name="l00094"></a>00094 {
-<a name="l00095"></a>00095     <span class="keywordflow">if</span> (channels &lt; <a class="code" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525" title="Get the minimum supported number of input channels.">getMinChannelCount</a>() ||
-<a name="l00096"></a>00096         channels &gt; <a class="code" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>()) <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00097"></a>00097 
-<a name="l00098"></a>00098     <a class="code" href="classZeroCrossing.html#584f100b87c78f9af9da040d79567d52">m_stepSize</a> = std::min(stepSize, blockSize);
-<a name="l00099"></a>00099 
-<a name="l00100"></a>00100     <span class="keywordflow">return</span> <span class="keyword">true</span>;
-<a name="l00101"></a>00101 }
-<a name="l00102"></a>00102 
-<a name="l00103"></a>00103 <span class="keywordtype">void</span>
-<a name="l00104"></a><a class="code" href="classZeroCrossing.html#9ae6c4a31ea027dceb1e97ead807e228">00104</a> <a class="code" href="classZeroCrossing.html#9ae6c4a31ea027dceb1e97ead807e228" title="Reset the plugin after use, to prepare it for another clean run.">ZeroCrossing::reset</a>()
-<a name="l00105"></a>00105 {
-<a name="l00106"></a>00106     <a class="code" href="classZeroCrossing.html#0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a> = 0.0f;
-<a name="l00107"></a>00107 }
-<a name="l00108"></a>00108 
-<a name="l00109"></a>00109 <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">ZeroCrossing::OutputList</a>
-<a name="l00110"></a><a class="code" href="classZeroCrossing.html#c9d590a6feb1fc9a37d7892aefe2b688">00110</a> <a class="code" href="classZeroCrossing.html#c9d590a6feb1fc9a37d7892aefe2b688" title="Get the outputs of this plugin.">ZeroCrossing::getOutputDescriptors</a>()<span class="keyword"> const</span>
-<a name="l00111"></a>00111 <span class="keyword"></span>{
-<a name="l00112"></a>00112     <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> list;
-<a name="l00113"></a>00113 
-<a name="l00114"></a>00114     <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> zc;
-<a name="l00115"></a>00115     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b" title="The name of the output, in computer-usable form.">identifier</a> = <span class="stringliteral">"counts"</span>;
-<a name="l00116"></a>00116     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87" title="The human-readable name of the output.">name</a> = <span class="stringliteral">"Zero Crossing Counts"</span>;
-<a name="l00117"></a>00117     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1" title="A human-readable short text describing the output.">description</a> = <span class="stringliteral">"The number of zero crossing points per processing block"</span>;
-<a name="l00118"></a>00118     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4" title="The unit of the output, in human-readable form.">unit</a> = <span class="stringliteral">"crossings"</span>;
-<a name="l00119"></a>00119     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d" title="True if the output has the same number of values per sample for every output sample...">hasFixedBinCount</a> = <span class="keyword">true</span>;
-<a name="l00120"></a>00120     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = 1;
-<a name="l00121"></a>00121     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31" title="True if the results in each output bin fall within a fixed numeric range (minimum...">hasKnownExtents</a> = <span class="keyword">false</span>;
-<a name="l00122"></a>00122     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4" title="True if the output values are quantized to a particular resolution.">isQuantized</a> = <span class="keyword">true</span>;
-<a name="l00123"></a>00123     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b" title="Quantization resolution of the output values (e.g.">quantizeStep</a> = 1.0;
-<a name="l00124"></a>00124     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d" title="Positioning in time of the output results.">sampleType</a> = <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca" title="Results from each process() align with that call&amp;#39;s block start.">OutputDescriptor::OneSamplePerStep</a>;
-<a name="l00125"></a>00125     list.push_back(zc);
-<a name="l00126"></a>00126 
-<a name="l00127"></a>00127     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b" title="The name of the output, in computer-usable form.">identifier</a> = <span class="stringliteral">"zerocrossings"</span>;
-<a name="l00128"></a>00128     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87" title="The human-readable name of the output.">name</a> = <span class="stringliteral">"Zero Crossings"</span>;
-<a name="l00129"></a>00129     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1" title="A human-readable short text describing the output.">description</a> = <span class="stringliteral">"The locations of zero crossing points"</span>;
-<a name="l00130"></a>00130     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4" title="The unit of the output, in human-readable form.">unit</a> = <span class="stringliteral">""</span>;
-<a name="l00131"></a>00131     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d" title="True if the output has the same number of values per sample for every output sample...">hasFixedBinCount</a> = <span class="keyword">true</span>;
-<a name="l00132"></a>00132     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = 0;
-<a name="l00133"></a>00133     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d" title="Positioning in time of the output results.">sampleType</a> = <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e" title="Results are unevenly spaced and have individual timestamps.">OutputDescriptor::VariableSampleRate</a>;
-<a name="l00134"></a>00134     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#dd0cbbdfa9c91764037c39365b1d42af" title="Sample rate of the output results, as samples per second.">sampleRate</a> = <a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>;
-<a name="l00135"></a>00135     list.push_back(zc);
-<a name="l00136"></a>00136 
-<a name="l00137"></a>00137     <span class="keywordflow">return</span> list;
-<a name="l00138"></a>00138 }
-<a name="l00139"></a>00139 
-<a name="l00140"></a>00140 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a>
-<a name="l00141"></a><a class="code" href="classZeroCrossing.html#bf4aaa6fd8cc03de63f4e1e8942633da">00141</a> <a class="code" href="classZeroCrossing.html#bf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data.">ZeroCrossing::process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,
-<a name="l00142"></a>00142                       <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">Vamp::RealTime</a> timestamp)
-<a name="l00143"></a>00143 {
-<a name="l00144"></a>00144     <span class="keywordflow">if</span> (<a class="code" href="classZeroCrossing.html#584f100b87c78f9af9da040d79567d52">m_stepSize</a> == 0) {
-<a name="l00145"></a>00145         cerr &lt;&lt; <span class="stringliteral">"ERROR: ZeroCrossing::process: "</span>
-<a name="l00146"></a>00146              &lt;&lt; <span class="stringliteral">"ZeroCrossing has not been initialised"</span>
-<a name="l00147"></a>00147              &lt;&lt; endl;
-<a name="l00148"></a>00148         <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>();
-<a name="l00149"></a>00149     }
-<a name="l00150"></a>00150 
-<a name="l00151"></a>00151     <span class="keywordtype">float</span> prev = <a class="code" href="classZeroCrossing.html#0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a>;
-<a name="l00152"></a>00152     <span class="keywordtype">size_t</span> count = 0;
-<a name="l00153"></a>00153 
-<a name="l00154"></a>00154     <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> returnFeatures;
-<a name="l00155"></a>00155 
-<a name="l00156"></a>00156     <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; <a class="code" href="classZeroCrossing.html#584f100b87c78f9af9da040d79567d52">m_stepSize</a>; ++i) {
-<a name="l00157"></a>00157 
-<a name="l00158"></a>00158         <span class="keywordtype">float</span> sample = inputBuffers[0][i];
-<a name="l00159"></a>00159         <span class="keywordtype">bool</span> crossing = <span class="keyword">false</span>;
-<a name="l00160"></a>00160 
-<a name="l00161"></a>00161         <span class="keywordflow">if</span> (sample &lt;= 0.0) {
-<a name="l00162"></a>00162             <span class="keywordflow">if</span> (prev &gt; 0.0) crossing = <span class="keyword">true</span>;
-<a name="l00163"></a>00163         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (sample &gt; 0.0) {
-<a name="l00164"></a>00164             <span class="keywordflow">if</span> (prev &lt;= 0.0) crossing = <span class="keyword">true</span>;
-<a name="l00165"></a>00165         }
-<a name="l00166"></a>00166 
-<a name="l00167"></a>00167         <span class="keywordflow">if</span> (crossing) {
-<a name="l00168"></a>00168             ++count; 
-<a name="l00169"></a>00169             <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> feature;
-<a name="l00170"></a>00170             feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b" title="True if an output feature has its own timestamp.">hasTimestamp</a> = <span class="keyword">true</span>;
-<a name="l00171"></a>00171             feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#caa605f36839c07e76f4882f5e22d8d7" title="Timestamp of the output feature.">timestamp</a> = timestamp +
-<a name="l00172"></a>00172                 <a class="code" href="structVamp_1_1RealTime.html#3a5ecc8888b559aad3b7d96911786b3a" title="Convert a sample frame at the given sample rate into a RealTime.">Vamp::RealTime::frame2RealTime</a>(i, (<span class="keywordtype">size_t</span>)<a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>);
-<a name="l00173"></a>00173             returnFeatures[1].push_back(feature);
-<a name="l00174"></a>00174         }
-<a name="l00175"></a>00175 
-<a name="l00176"></a>00176         prev = sample;
-<a name="l00177"></a>00177     }
-<a name="l00178"></a>00178 
-<a name="l00179"></a>00179     <a class="code" href="classZeroCrossing.html#0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a> = prev;
-<a name="l00180"></a>00180 
-<a name="l00181"></a>00181     <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> feature;
-<a name="l00182"></a>00182     feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b" title="True if an output feature has its own timestamp.">hasTimestamp</a> = <span class="keyword">false</span>;
-<a name="l00183"></a>00183     feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#60b9f3057386820dbcaec0eb1189ce71" title="Results for a single sample of this feature.">values</a>.push_back(count);
-<a name="l00184"></a>00184 
-<a name="l00185"></a>00185     returnFeatures[0].push_back(feature);
-<a name="l00186"></a>00186     <span class="keywordflow">return</span> returnFeatures;
-<a name="l00187"></a>00187 }
-<a name="l00188"></a>00188 
-<a name="l00189"></a>00189 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a>
-<a name="l00190"></a><a class="code" href="classZeroCrossing.html#70996d1b7166e303903daf92a9a37ad8">00190</a> <a class="code" href="classZeroCrossing.html#70996d1b7166e303903daf92a9a37ad8" title="After all blocks have been processed, calculate and return any remaining features...">ZeroCrossing::getRemainingFeatures</a>()
-<a name="l00191"></a>00191 {
-<a name="l00192"></a>00192     <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>();
-<a name="l00193"></a>00193 }
-<a name="l00194"></a>00194 
+<a name="l00044"></a>00044 <span class="preprocessor">#include &lt;cmath&gt;</span>
+<a name="l00045"></a>00045 
+<a name="l00046"></a><a class="code" href="classZeroCrossing.html#9855153a54bdc9ba75cc1a705a149473">00046</a> <a class="code" href="classZeroCrossing.html#9855153a54bdc9ba75cc1a705a149473">ZeroCrossing::ZeroCrossing</a>(<span class="keywordtype">float</span> inputSampleRate) :
+<a name="l00047"></a>00047     Plugin(inputSampleRate),
+<a name="l00048"></a>00048     m_stepSize(0),
+<a name="l00049"></a>00049     m_previousSample(0.0f)
+<a name="l00050"></a>00050 {
+<a name="l00051"></a>00051 }
+<a name="l00052"></a>00052 
+<a name="l00053"></a><a class="code" href="classZeroCrossing.html#f1de0da862e6e2443581e4e16044675b">00053</a> <a class="code" href="classZeroCrossing.html#f1de0da862e6e2443581e4e16044675b">ZeroCrossing::~ZeroCrossing</a>()
+<a name="l00054"></a>00054 {
+<a name="l00055"></a>00055 }
+<a name="l00056"></a>00056 
+<a name="l00057"></a>00057 <span class="keywordtype">string</span>
+<a name="l00058"></a><a class="code" href="classZeroCrossing.html#f2baf9e19fcdd11cfe97ace56d4f5c1a">00058</a> <a class="code" href="classZeroCrossing.html#f2baf9e19fcdd11cfe97ace56d4f5c1a" title="Get the computer-usable name of the plugin.">ZeroCrossing::getIdentifier</a>()<span class="keyword"> const</span>
+<a name="l00059"></a>00059 <span class="keyword"></span>{
+<a name="l00060"></a>00060     <span class="keywordflow">return</span> <span class="stringliteral">"zerocrossing"</span>;
+<a name="l00061"></a>00061 }
+<a name="l00062"></a>00062 
+<a name="l00063"></a>00063 <span class="keywordtype">string</span>
+<a name="l00064"></a><a class="code" href="classZeroCrossing.html#fa96f7ce6e7d9f03768f48c6a9d88498">00064</a> <a class="code" href="classZeroCrossing.html#fa96f7ce6e7d9f03768f48c6a9d88498" title="Get a human-readable name or title of the plugin.">ZeroCrossing::getName</a>()<span class="keyword"> const</span>
+<a name="l00065"></a>00065 <span class="keyword"></span>{
+<a name="l00066"></a>00066     <span class="keywordflow">return</span> <span class="stringliteral">"Zero Crossings"</span>;
+<a name="l00067"></a>00067 }
+<a name="l00068"></a>00068 
+<a name="l00069"></a>00069 <span class="keywordtype">string</span>
+<a name="l00070"></a><a class="code" href="classZeroCrossing.html#710bb0b013157adaeef2a9e6867b4478">00070</a> <a class="code" href="classZeroCrossing.html#710bb0b013157adaeef2a9e6867b4478" title="Get a human-readable description for the plugin, typically a line of text that may...">ZeroCrossing::getDescription</a>()<span class="keyword"> const</span>
+<a name="l00071"></a>00071 <span class="keyword"></span>{
+<a name="l00072"></a>00072     <span class="keywordflow">return</span> <span class="stringliteral">"Detect and count zero crossing points"</span>;
+<a name="l00073"></a>00073 }
+<a name="l00074"></a>00074 
+<a name="l00075"></a>00075 <span class="keywordtype">string</span>
+<a name="l00076"></a><a class="code" href="classZeroCrossing.html#c68561634a3c329a029c2fd3deaeae2a">00076</a> <a class="code" href="classZeroCrossing.html#c68561634a3c329a029c2fd3deaeae2a" title="Get the name of the author or vendor of the plugin in human-readable form.">ZeroCrossing::getMaker</a>()<span class="keyword"> const</span>
+<a name="l00077"></a>00077 <span class="keyword"></span>{
+<a name="l00078"></a>00078     <span class="keywordflow">return</span> <span class="stringliteral">"Vamp SDK Example Plugins"</span>;
+<a name="l00079"></a>00079 }
+<a name="l00080"></a>00080 
+<a name="l00081"></a>00081 <span class="keywordtype">int</span>
+<a name="l00082"></a><a class="code" href="classZeroCrossing.html#d685f6c2f443f07a1634550c335571eb">00082</a> <a class="code" href="classZeroCrossing.html#d685f6c2f443f07a1634550c335571eb" title="Get the version number of the plugin.">ZeroCrossing::getPluginVersion</a>()<span class="keyword"> const</span>
+<a name="l00083"></a>00083 <span class="keyword"></span>{
+<a name="l00084"></a>00084     <span class="keywordflow">return</span> 2;
+<a name="l00085"></a>00085 }
+<a name="l00086"></a>00086 
+<a name="l00087"></a>00087 <span class="keywordtype">string</span>
+<a name="l00088"></a><a class="code" href="classZeroCrossing.html#f9c41b92aa8ff8bddaebf75569ff789c">00088</a> <a class="code" href="classZeroCrossing.html#f9c41b92aa8ff8bddaebf75569ff789c" title="Get the copyright statement or licensing summary for the plugin.">ZeroCrossing::getCopyright</a>()<span class="keyword"> const</span>
+<a name="l00089"></a>00089 <span class="keyword"></span>{
+<a name="l00090"></a>00090     <span class="keywordflow">return</span> <span class="stringliteral">"Freely redistributable (BSD license)"</span>;
+<a name="l00091"></a>00091 }
+<a name="l00092"></a>00092 
+<a name="l00093"></a>00093 <span class="keywordtype">bool</span>
+<a name="l00094"></a><a class="code" href="classZeroCrossing.html#f21bbcc87a6eb7875dfab7d86222dccc">00094</a> <a class="code" href="classZeroCrossing.html#f21bbcc87a6eb7875dfab7d86222dccc" title="Initialise a plugin to prepare it for use with the given number of input channels...">ZeroCrossing::initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize)
+<a name="l00095"></a>00095 {
+<a name="l00096"></a>00096     <span class="keywordflow">if</span> (channels &lt; <a class="code" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525" title="Get the minimum supported number of input channels.">getMinChannelCount</a>() ||
+<a name="l00097"></a>00097         channels &gt; <a class="code" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>()) <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00098"></a>00098 
+<a name="l00099"></a>00099     <a class="code" href="classZeroCrossing.html#584f100b87c78f9af9da040d79567d52">m_stepSize</a> = std::min(stepSize, blockSize);
+<a name="l00100"></a>00100 
+<a name="l00101"></a>00101     <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00102"></a>00102 }
+<a name="l00103"></a>00103 
+<a name="l00104"></a>00104 <span class="keywordtype">void</span>
+<a name="l00105"></a><a class="code" href="classZeroCrossing.html#9ae6c4a31ea027dceb1e97ead807e228">00105</a> <a class="code" href="classZeroCrossing.html#9ae6c4a31ea027dceb1e97ead807e228" title="Reset the plugin after use, to prepare it for another clean run.">ZeroCrossing::reset</a>()
+<a name="l00106"></a>00106 {
+<a name="l00107"></a>00107     <a class="code" href="classZeroCrossing.html#0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a> = 0.0f;
+<a name="l00108"></a>00108 }
+<a name="l00109"></a>00109 
+<a name="l00110"></a>00110 <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">ZeroCrossing::OutputList</a>
+<a name="l00111"></a><a class="code" href="classZeroCrossing.html#c9d590a6feb1fc9a37d7892aefe2b688">00111</a> <a class="code" href="classZeroCrossing.html#c9d590a6feb1fc9a37d7892aefe2b688" title="Get the outputs of this plugin.">ZeroCrossing::getOutputDescriptors</a>()<span class="keyword"> const</span>
+<a name="l00112"></a>00112 <span class="keyword"></span>{
+<a name="l00113"></a>00113     <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> list;
+<a name="l00114"></a>00114 
+<a name="l00115"></a>00115     <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> zc;
+<a name="l00116"></a>00116     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b" title="The name of the output, in computer-usable form.">identifier</a> = <span class="stringliteral">"counts"</span>;
+<a name="l00117"></a>00117     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87" title="The human-readable name of the output.">name</a> = <span class="stringliteral">"Zero Crossing Counts"</span>;
+<a name="l00118"></a>00118     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1" title="A human-readable short text describing the output.">description</a> = <span class="stringliteral">"The number of zero crossing points per processing block"</span>;
+<a name="l00119"></a>00119     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4" title="The unit of the output, in human-readable form.">unit</a> = <span class="stringliteral">"crossings"</span>;
+<a name="l00120"></a>00120     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d" title="True if the output has the same number of values per sample for every output sample...">hasFixedBinCount</a> = <span class="keyword">true</span>;
+<a name="l00121"></a>00121     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = 1;
+<a name="l00122"></a>00122     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31" title="True if the results in each output bin fall within a fixed numeric range (minimum...">hasKnownExtents</a> = <span class="keyword">false</span>;
+<a name="l00123"></a>00123     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4" title="True if the output values are quantized to a particular resolution.">isQuantized</a> = <span class="keyword">true</span>;
+<a name="l00124"></a>00124     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b" title="Quantization resolution of the output values (e.g.">quantizeStep</a> = 1.0;
+<a name="l00125"></a>00125     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d" title="Positioning in time of the output results.">sampleType</a> = <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca" title="Results from each process() align with that call&amp;#39;s block start.">OutputDescriptor::OneSamplePerStep</a>;
+<a name="l00126"></a>00126     list.push_back(zc);
+<a name="l00127"></a>00127 
+<a name="l00128"></a>00128     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b" title="The name of the output, in computer-usable form.">identifier</a> = <span class="stringliteral">"zerocrossings"</span>;
+<a name="l00129"></a>00129     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87" title="The human-readable name of the output.">name</a> = <span class="stringliteral">"Zero Crossings"</span>;
+<a name="l00130"></a>00130     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1" title="A human-readable short text describing the output.">description</a> = <span class="stringliteral">"The locations of zero crossing points"</span>;
+<a name="l00131"></a>00131     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4" title="The unit of the output, in human-readable form.">unit</a> = <span class="stringliteral">""</span>;
+<a name="l00132"></a>00132     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d" title="True if the output has the same number of values per sample for every output sample...">hasFixedBinCount</a> = <span class="keyword">true</span>;
+<a name="l00133"></a>00133     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = 0;
+<a name="l00134"></a>00134     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d" title="Positioning in time of the output results.">sampleType</a> = <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e" title="Results are unevenly spaced and have individual timestamps.">OutputDescriptor::VariableSampleRate</a>;
+<a name="l00135"></a>00135     zc.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#dd0cbbdfa9c91764037c39365b1d42af" title="Sample rate of the output results, as samples per second.">sampleRate</a> = <a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>;
+<a name="l00136"></a>00136     list.push_back(zc);
+<a name="l00137"></a>00137 
+<a name="l00138"></a>00138     <span class="keywordflow">return</span> list;
+<a name="l00139"></a>00139 }
+<a name="l00140"></a>00140 
+<a name="l00141"></a>00141 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a>
+<a name="l00142"></a><a class="code" href="classZeroCrossing.html#bf4aaa6fd8cc03de63f4e1e8942633da">00142</a> <a class="code" href="classZeroCrossing.html#bf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data.">ZeroCrossing::process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,
+<a name="l00143"></a>00143                       <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">Vamp::RealTime</a> timestamp)
+<a name="l00144"></a>00144 {
+<a name="l00145"></a>00145     <span class="keywordflow">if</span> (<a class="code" href="classZeroCrossing.html#584f100b87c78f9af9da040d79567d52">m_stepSize</a> == 0) {
+<a name="l00146"></a>00146         cerr &lt;&lt; <span class="stringliteral">"ERROR: ZeroCrossing::process: "</span>
+<a name="l00147"></a>00147              &lt;&lt; <span class="stringliteral">"ZeroCrossing has not been initialised"</span>
+<a name="l00148"></a>00148              &lt;&lt; endl;
+<a name="l00149"></a>00149         <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>();
+<a name="l00150"></a>00150     }
+<a name="l00151"></a>00151 
+<a name="l00152"></a>00152     <span class="keywordtype">float</span> prev = <a class="code" href="classZeroCrossing.html#0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a>;
+<a name="l00153"></a>00153     <span class="keywordtype">size_t</span> count = 0;
+<a name="l00154"></a>00154 
+<a name="l00155"></a>00155     <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> returnFeatures;
+<a name="l00156"></a>00156 
+<a name="l00157"></a>00157     <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; <a class="code" href="classZeroCrossing.html#584f100b87c78f9af9da040d79567d52">m_stepSize</a>; ++i) {
+<a name="l00158"></a>00158 
+<a name="l00159"></a>00159         <span class="keywordtype">float</span> sample = inputBuffers[0][i];
+<a name="l00160"></a>00160         <span class="keywordtype">bool</span> crossing = <span class="keyword">false</span>;
+<a name="l00161"></a>00161 
+<a name="l00162"></a>00162         <span class="keywordflow">if</span> (sample &lt;= 0.0) {
+<a name="l00163"></a>00163             <span class="keywordflow">if</span> (prev &gt; 0.0) crossing = <span class="keyword">true</span>;
+<a name="l00164"></a>00164         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (sample &gt; 0.0) {
+<a name="l00165"></a>00165             <span class="keywordflow">if</span> (prev &lt;= 0.0) crossing = <span class="keyword">true</span>;
+<a name="l00166"></a>00166         }
+<a name="l00167"></a>00167 
+<a name="l00168"></a>00168         <span class="keywordflow">if</span> (crossing) {
+<a name="l00169"></a>00169             ++count; 
+<a name="l00170"></a>00170             <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> feature;
+<a name="l00171"></a>00171             feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b" title="True if an output feature has its own timestamp.">hasTimestamp</a> = <span class="keyword">true</span>;
+<a name="l00172"></a>00172             feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#caa605f36839c07e76f4882f5e22d8d7" title="Timestamp of the output feature.">timestamp</a> = timestamp +
+<a name="l00173"></a>00173                 <a class="code" href="structVamp_1_1RealTime.html#939b4b1d1ca190db69a418883f16ce8a" title="Convert a sample frame at the given sample rate into a RealTime.">Vamp::RealTime::frame2RealTime</a>(i, (<span class="keywordtype">size_t</span>)<a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a>);
+<a name="l00174"></a>00174             returnFeatures[1].push_back(feature);
+<a name="l00175"></a>00175         }
+<a name="l00176"></a>00176 
+<a name="l00177"></a>00177         prev = sample;
+<a name="l00178"></a>00178     }
+<a name="l00179"></a>00179 
+<a name="l00180"></a>00180     <a class="code" href="classZeroCrossing.html#0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a> = prev;
+<a name="l00181"></a>00181 
+<a name="l00182"></a>00182     <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> feature;
+<a name="l00183"></a>00183     feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b" title="True if an output feature has its own timestamp.">hasTimestamp</a> = <span class="keyword">false</span>;
+<a name="l00184"></a>00184     feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#60b9f3057386820dbcaec0eb1189ce71" title="Results for a single sample of this feature.">values</a>.push_back(count);
+<a name="l00185"></a>00185 
+<a name="l00186"></a>00186     returnFeatures[0].push_back(feature);
+<a name="l00187"></a>00187     <span class="keywordflow">return</span> returnFeatures;
+<a name="l00188"></a>00188 }
+<a name="l00189"></a>00189 
+<a name="l00190"></a>00190 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a>
+<a name="l00191"></a><a class="code" href="classZeroCrossing.html#70996d1b7166e303903daf92a9a37ad8">00191</a> <a class="code" href="classZeroCrossing.html#70996d1b7166e303903daf92a9a37ad8" title="After all blocks have been processed, calculate and return any remaining features...">ZeroCrossing::getRemainingFeatures</a>()
+<a name="l00192"></a>00192 {
+<a name="l00193"></a>00193     <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>();
+<a name="l00194"></a>00194 }
+<a name="l00195"></a>00195 
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
 <a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 </body>
 </html>