Mercurial > hg > vamp-docs

view code-docs/ZeroCrossing_8h_source.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<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" />
<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="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">VampPluginSDK
   &#160;<span id="projectnumber">2.4</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&#160;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&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('ZeroCrossing_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<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 &quot;Software&quot;), 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 &quot;AS IS&quot;, 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 &quot;<a class="code" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a>&quot;</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&#39;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 -->
</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>