Mercurial > hg > vamp-docs
diff code-docs/ZeroCrossing_8h_source.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7
Update code docs to v2.7 SDK
| author | Chris Cannam |
|---|---|
| date | Fri, 24 Feb 2017 16:44:47 +0000 |
| parents | 5c2683745b33 |
| children |
line wrap: on
line diff
--- a/code-docs/ZeroCrossing_8h_source.html Tue Dec 03 16:43:33 2013 +0000 +++ b/code-docs/ZeroCrossing_8h_source.html Fri Feb 24 16:44:47 2017 +0000 @@ -3,64 +3,51 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> <title>VampPluginSDK: ZeroCrossing.h Source File</title> - <link href="tabs.css" rel="stylesheet" type="text/css"/> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> - - +<link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> -<div id="top"><!-- do not remove this div! --> - - +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - - - <td style="padding-left: 0.5em;"> + <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK -  <span id="projectnumber">2.4</span> +  <span id="projectnumber">2.7</span> </div> - </td> - - - </tr> </tbody> </table> </div> - -<!-- Generated by Doxygen 1.8.0 --> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="namespaces.html"><span>Namespaces</span></a></li> - <li><a href="annotated.html"><span>Classes</span></a></li> - <li class="current"><a href="files.html"><span>Files</span></a></li> - <li><a href="dirs.html"><span>Directories</span></a></li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="files.html"><span>File List</span></a></li> - <li><a href="globals.html"><span>File Members</span></a></li> - </ul> - </div> -</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',false,false,'search.php','Search'); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" @@ -68,7 +55,7 @@ </div> </div> <script type="text/javascript"> - initNavTree('ZeroCrossing_8h.html',''); +$(document).ready(function(){initNavTree('ZeroCrossing_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> @@ -76,91 +63,40 @@ <div class="title">ZeroCrossing.h</div> </div> </div><!--header--> <div class="contents"> -<a href="ZeroCrossing_8h.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> -<a name="l00004"></a>00004 <span class="comment"> Vamp</span> -<a name="l00005"></a>00005 <span class="comment"></span> -<a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span> -<a name="l00007"></a>00007 <span class="comment"></span> -<a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span> -<a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span> -<a name="l00010"></a>00010 <span class="comment"> </span> -<a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span> -<a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span> -<a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span> -<a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> -<a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span> -<a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span> -<a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span> -<a name="l00018"></a>00018 <span class="comment"></span> -<a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span> -<a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span> -<a name="l00021"></a>00021 <span class="comment"></span> -<a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span> -<a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> -<a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span> -<a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span> -<a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span> -<a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span> -<a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span> -<a name="l00029"></a>00029 <span class="comment"></span> -<a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span> -<a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span> -<a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span> -<a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span> -<a name="l00034"></a>00034 <span class="comment"> authorization.</span> -<a name="l00035"></a>00035 <span class="comment">*/</span> -<a name="l00036"></a>00036 -<a name="l00037"></a>00037 <span class="preprocessor">#ifndef _ZERO_CROSSING_PLUGIN_H_</span> -<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _ZERO_CROSSING_PLUGIN_H_</span> -<a name="l00039"></a>00039 <span class="preprocessor"></span> -<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a>"</span> -<a name="l00041"></a>00041 -<a name="l00047"></a><a class="code" href="classZeroCrossing.html">00047</a> <span class="keyword">class </span><a class="code" href="classZeroCrossing.html" title="Example plugin that calculates the positions and density of zero-crossing points in an audio waveform...">ZeroCrossing</a> : <span class="keyword">public</span> <a class="code" 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> -<a name="l00048"></a>00048 { -<a name="l00049"></a>00049 <span class="keyword">public</span>: -<a name="l00050"></a>00050 <a class="code" href="classZeroCrossing.html#a9855153a54bdc9ba75cc1a705a149473">ZeroCrossing</a>(<span class="keywordtype">float</span> inputSampleRate); -<a name="l00051"></a>00051 <span class="keyword">virtual</span> <a class="code" href="classZeroCrossing.html#af1de0da862e6e2443581e4e16044675b">~ZeroCrossing</a>(); -<a name="l00052"></a>00052 -<a name="l00053"></a>00053 <span class="keywordtype">bool</span> <a class="code" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize); -<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="classZeroCrossing.html#a9ae6c4a31ea027dceb1e97ead807e228" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>(); -<a name="l00055"></a>00055 -<a name="l00056"></a><a class="code" href="classZeroCrossing.html#aafe2ce6ebd353a14c40db7e8e60f4051">00056</a> <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classZeroCrossing.html#aafe2ce6ebd353a14c40db7e8e60f4051" title="Get the plugin's required input domain.">getInputDomain</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>; } -<a name="l00057"></a>00057 -<a name="l00058"></a>00058 std::string <a class="code" href="classZeroCrossing.html#af2baf9e19fcdd11cfe97ace56d4f5c1a" title="Get the computer-usable name of the plugin.">getIdentifier</a>() <span class="keyword">const</span>; -<a name="l00059"></a>00059 std::string <a class="code" href="classZeroCrossing.html#afa96f7ce6e7d9f03768f48c6a9d88498" title="Get a human-readable name or title of the plugin.">getName</a>() <span class="keyword">const</span>; -<a name="l00060"></a>00060 std::string <a class="code" href="classZeroCrossing.html#a710bb0b013157adaeef2a9e6867b4478" title="Get a human-readable description for the plugin, typically a line of text that may optionally be disp...">getDescription</a>() <span class="keyword">const</span>; -<a name="l00061"></a>00061 std::string <a class="code" href="classZeroCrossing.html#ac68561634a3c329a029c2fd3deaeae2a" title="Get the name of the author or vendor of the plugin in human-readable form.">getMaker</a>() <span class="keyword">const</span>; -<a name="l00062"></a>00062 <span class="keywordtype">int</span> <a class="code" href="classZeroCrossing.html#ad685f6c2f443f07a1634550c335571eb" title="Get the version number of the plugin.">getPluginVersion</a>() <span class="keyword">const</span>; -<a name="l00063"></a>00063 std::string <a class="code" href="classZeroCrossing.html#af9c41b92aa8ff8bddaebf75569ff789c" title="Get the copyright statement or licensing summary for the plugin.">getCopyright</a>() <span class="keyword">const</span>; -<a name="l00064"></a>00064 -<a name="l00065"></a>00065 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classZeroCrossing.html#ac9d590a6feb1fc9a37d7892aefe2b688" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span>; -<a name="l00066"></a>00066 -<a name="l00067"></a>00067 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data.">process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, -<a name="l00068"></a>00068 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">Vamp::RealTime</a> timestamp); -<a name="l00069"></a>00069 -<a name="l00070"></a>00070 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classZeroCrossing.html#a70996d1b7166e303903daf92a9a37ad8" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">getRemainingFeatures</a>(); -<a name="l00071"></a>00071 -<a name="l00072"></a>00072 <span class="keyword">protected</span>: -<a name="l00073"></a><a class="code" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">00073</a> <span class="keywordtype">size_t</span> <a class="code" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">m_stepSize</a>; -<a name="l00074"></a><a class="code" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">00074</a> <span class="keywordtype">float</span> <a class="code" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a>; -<a name="l00075"></a>00075 }; -<a name="l00076"></a>00076 -<a name="l00077"></a>00077 -<a name="l00078"></a>00078 <span class="preprocessor">#endif</span> -</pre></div></div><!-- contents --> +<a href="ZeroCrossing_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Vamp</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> An API for audio analysis and feature extraction plugins.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Copyright 2006 Chris Cannam.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> </span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> Permission is hereby granted, free of charge, to any person</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> obtaining a copy of this software and associated documentation</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> files (the "Software"), to deal in the Software without</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> restriction, including without limitation the rights to use, copy,</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> The above copyright notice and this permission notice shall be</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> included in all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> Except as contained in this notice, the names of the Centre for</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> use or other dealings in this Software without prior written</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> authorization.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">*/</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifndef _ZERO_CROSSING_PLUGIN_H_</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define _ZERO_CROSSING_PLUGIN_H_</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "<a class="code" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a>"</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classZeroCrossing.html"> 47</a></span> <span class="keyword">class </span><a class="code" href="classZeroCrossing.html">ZeroCrossing</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classZeroCrossing.html#a9855153a54bdc9ba75cc1a705a149473">ZeroCrossing</a>(<span class="keywordtype">float</span> inputSampleRate);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">virtual</span> <a class="code" href="classZeroCrossing.html#af1de0da862e6e2443581e4e16044675b">~ZeroCrossing</a>();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">bool</span> <a class="code" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc">initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> <a class="code" href="classZeroCrossing.html#a9ae6c4a31ea027dceb1e97ead807e228">reset</a>();</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classZeroCrossing.html#a2fd2cefbd1564e4d30ccabd64d6555e7"> 56</a></span>  <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classZeroCrossing.html#a2fd2cefbd1564e4d30ccabd64d6555e7">getInputDomain</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>; }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::string <a class="code" href="classZeroCrossing.html#af5049a01a3f003f17a45c61b599c6543">getIdentifier</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::string <a class="code" href="classZeroCrossing.html#a191365f793e6488d02d57029eb14deb2">getName</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  std::string <a class="code" href="classZeroCrossing.html#a7ba1cfd102a427f8333ddfa2fe234d58">getDescription</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::string <a class="code" href="classZeroCrossing.html#a9ddf295d977b6c64d8acd34b7e0ce1b0">getMaker</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">int</span> <a class="code" href="classZeroCrossing.html#a4199350192d84a4ec5f379805cd3e7cf">getPluginVersion</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::string <a class="code" href="classZeroCrossing.html#af955fb85b26a5497690aecbd288975f2">getCopyright</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classZeroCrossing.html#ab83cfab3f9674920e295c2f3571bb24e">getOutputDescriptors</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da">process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classZeroCrossing.html#a70996d1b7166e303903daf92a9a37ad8">getRemainingFeatures</a>();</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52"> 73</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">m_stepSize</a>;</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"> 74</a></span>  <span class="keywordtype">float</span> <a class="code" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classVamp_1_1Plugin_html_a30f531b8fb69fac41a24e3d2a6a08ed9"><div class="ttname"><a href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a></div><div class="ttdeci">std::vector< OutputDescriptor > OutputList</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00335">vamp-sdk/Plugin.h:335</a></div></div> +<div class="ttc" id="classZeroCrossing_html_abf4aaa6fd8cc03de63f4e1e8942633da"><div class="ttname"><a href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da">ZeroCrossing::process</a></div><div class="ttdeci">FeatureSet process(const float *const *inputBuffers, Vamp::RealTime timestamp)</div><div class="ttdoc">Process a single block of input data. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00143">ZeroCrossing.cpp:143</a></div></div> +<div class="ttc" id="classVamp_1_1Plugin_html"><div class="ttname"><a href="classVamp_1_1Plugin.html">Vamp::Plugin</a></div><div class="ttdoc">Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00124">vamp-sdk/Plugin.h:124</a></div></div> +<div class="ttc" id="classVamp_1_1Plugin_html_a39cb7649d6dcc20e4cb1640cd55907bc"><div class="ttname"><a href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></div><div class="ttdeci">InputDomain</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00152">vamp-sdk/Plugin.h:152</a></div></div> +<div class="ttc" id="classZeroCrossing_html_ab83cfab3f9674920e295c2f3571bb24e"><div class="ttname"><a href="classZeroCrossing.html#ab83cfab3f9674920e295c2f3571bb24e">ZeroCrossing::getOutputDescriptors</a></div><div class="ttdeci">OutputList getOutputDescriptors() const</div><div class="ttdoc">Get the outputs of this plugin. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing.cpp:112</a></div></div> +<div class="ttc" id="classZeroCrossing_html_af21bbcc87a6eb7875dfab7d86222dccc"><div class="ttname"><a href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc">ZeroCrossing::initialise</a></div><div class="ttdeci">bool initialise(size_t channels, size_t stepSize, size_t blockSize)</div><div class="ttdoc">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). </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00095">ZeroCrossing.cpp:95</a></div></div> +<div class="ttc" id="classZeroCrossing_html"><div class="ttname"><a href="classZeroCrossing.html">ZeroCrossing</a></div><div class="ttdoc">Example plugin that calculates the positions and density of zero-crossing points in an audio waveform...</div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8h_source.html#l00047">ZeroCrossing.h:47</a></div></div> +<div class="ttc" id="classVamp_1_1Plugin_html_a448fb57dc245d47923ec9eeaf9856c5f"><div class="ttname"><a href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a></div><div class="ttdeci">std::map< int, FeatureList > FeatureSet</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00395">vamp-sdk/Plugin.h:395</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a584f100b87c78f9af9da040d79567d52"><div class="ttname"><a href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">ZeroCrossing::m_stepSize</a></div><div class="ttdeci">size_t m_stepSize</div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8h_source.html#l00073">ZeroCrossing.h:73</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a70996d1b7166e303903daf92a9a37ad8"><div class="ttname"><a href="classZeroCrossing.html#a70996d1b7166e303903daf92a9a37ad8">ZeroCrossing::getRemainingFeatures</a></div><div class="ttdeci">FeatureSet getRemainingFeatures()</div><div class="ttdoc">After all blocks have been processed, calculate and return any remaining features derived from the co...</div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00192">ZeroCrossing.cpp:192</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a9ae6c4a31ea027dceb1e97ead807e228"><div class="ttname"><a href="classZeroCrossing.html#a9ae6c4a31ea027dceb1e97ead807e228">ZeroCrossing::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Reset the plugin after use, to prepare it for another clean run. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00106">ZeroCrossing.cpp:106</a></div></div> +<div class="ttc" id="classZeroCrossing_html_af5049a01a3f003f17a45c61b599c6543"><div class="ttname"><a href="classZeroCrossing.html#af5049a01a3f003f17a45c61b599c6543">ZeroCrossing::getIdentifier</a></div><div class="ttdeci">std::string getIdentifier() const</div><div class="ttdoc">Get the computer-usable name of the plugin. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00059">ZeroCrossing.cpp:59</a></div></div> +<div class="ttc" id="classZeroCrossing_html_af1de0da862e6e2443581e4e16044675b"><div class="ttname"><a href="classZeroCrossing.html#af1de0da862e6e2443581e4e16044675b">ZeroCrossing::~ZeroCrossing</a></div><div class="ttdeci">virtual ~ZeroCrossing()</div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00054">ZeroCrossing.cpp:54</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a9855153a54bdc9ba75cc1a705a149473"><div class="ttname"><a href="classZeroCrossing.html#a9855153a54bdc9ba75cc1a705a149473">ZeroCrossing::ZeroCrossing</a></div><div class="ttdeci">ZeroCrossing(float inputSampleRate)</div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00047">ZeroCrossing.cpp:47</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a2fd2cefbd1564e4d30ccabd64d6555e7"><div class="ttname"><a href="classZeroCrossing.html#a2fd2cefbd1564e4d30ccabd64d6555e7">ZeroCrossing::getInputDomain</a></div><div class="ttdeci">InputDomain getInputDomain() const</div><div class="ttdoc">Get the plugin&#39;s required input domain. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8h_source.html#l00056">ZeroCrossing.h:56</a></div></div> +<div class="ttc" id="classVamp_1_1Plugin_html_a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"><div class="ttname"><a href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">Vamp::Plugin::TimeDomain</a></div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2Plugin_8h_source.html#l00152">vamp-sdk/Plugin.h:152</a></div></div> +<div class="ttc" id="structVamp_1_1RealTime_html"><div class="ttname"><a href="structVamp_1_1RealTime.html">Vamp::RealTime</a></div><div class="ttdoc">RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...</div><div class="ttdef"><b>Definition:</b> <a href="vamp-sdk_2RealTime_8h_source.html#l00066">vamp-sdk/RealTime.h:66</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a4199350192d84a4ec5f379805cd3e7cf"><div class="ttname"><a href="classZeroCrossing.html#a4199350192d84a4ec5f379805cd3e7cf">ZeroCrossing::getPluginVersion</a></div><div class="ttdeci">int getPluginVersion() const</div><div class="ttdoc">Get the version number of the plugin. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00083">ZeroCrossing.cpp:83</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a9ddf295d977b6c64d8acd34b7e0ce1b0"><div class="ttname"><a href="classZeroCrossing.html#a9ddf295d977b6c64d8acd34b7e0ce1b0">ZeroCrossing::getMaker</a></div><div class="ttdeci">std::string getMaker() const</div><div class="ttdoc">Get the name of the author or vendor of the plugin in human-readable form. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00077">ZeroCrossing.cpp:77</a></div></div> +<div class="ttc" id="classZeroCrossing_html_af955fb85b26a5497690aecbd288975f2"><div class="ttname"><a href="classZeroCrossing.html#af955fb85b26a5497690aecbd288975f2">ZeroCrossing::getCopyright</a></div><div class="ttdeci">std::string getCopyright() const</div><div class="ttdoc">Get the copyright statement or licensing summary for the plugin. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00089">ZeroCrossing.cpp:89</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a191365f793e6488d02d57029eb14deb2"><div class="ttname"><a href="classZeroCrossing.html#a191365f793e6488d02d57029eb14deb2">ZeroCrossing::getName</a></div><div class="ttdeci">std::string getName() const</div><div class="ttdoc">Get a human-readable name or title of the plugin. </div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00065">ZeroCrossing.cpp:65</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a7ba1cfd102a427f8333ddfa2fe234d58"><div class="ttname"><a href="classZeroCrossing.html#a7ba1cfd102a427f8333ddfa2fe234d58">ZeroCrossing::getDescription</a></div><div class="ttdeci">std::string getDescription() const</div><div class="ttdoc">Get a human-readable description for the plugin, typically a line of text that may optionally be disp...</div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8cpp_source.html#l00071">ZeroCrossing.cpp:71</a></div></div> +<div class="ttc" id="classZeroCrossing_html_a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"><div class="ttname"><a href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">ZeroCrossing::m_previousSample</a></div><div class="ttdeci">float m_previousSample</div><div class="ttdef"><b>Definition:</b> <a href="ZeroCrossing_8h_source.html#l00074">ZeroCrossing.h:74</a></div></div> +<div class="ttc" id="vamp-sdk_2Plugin_8h_html"><div class="ttname"><a href="vamp-sdk_2Plugin_8h.html">Plugin.h</a></div></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="dir_d28a4824dc47e487b107a5db32ef43c4.html">examples</a></li><li class="navelem"><a class="el" href="ZeroCrossing_8h.html">ZeroCrossing.h</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> </div> - <div id="nav-path" class="navpath"> - <ul> - <li class="navelem"><a class="el" href="ZeroCrossing_8h.html">ZeroCrossing.h</a> </li> - - <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by - <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> - </ul> - </div> - - </body> </html>