Mercurial > hg > vamp-docs
diff code-docs/PowerSpectrum_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/PowerSpectrum_8h_source.html Tue Dec 03 16:43:33 2013 +0000 +++ b/code-docs/PowerSpectrum_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: PowerSpectrum.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('PowerSpectrum_8h.html',''); +$(document).ready(function(){initNavTree('PowerSpectrum_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> @@ -76,90 +63,39 @@ <div class="title">PowerSpectrum.h</div> </div> </div><!--header--> <div class="contents"> -<a href="PowerSpectrum_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 _POWER_SPECTRUM_PLUGIN_H_</span> -<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _POWER_SPECTRUM_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="l00050"></a><a class="code" href="classPowerSpectrum.html">00050</a> <span class="keyword">class </span><a class="code" href="classPowerSpectrum.html" title="Example plugin that returns a power spectrum calculated (trivially) from the frequency domain represe...">PowerSpectrum</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="l00051"></a>00051 { -<a name="l00052"></a>00052 <span class="keyword">public</span>: -<a name="l00053"></a>00053 <a class="code" href="classPowerSpectrum.html#aa2550486513a4abcf7b52869002947e7">PowerSpectrum</a>(<span class="keywordtype">float</span> inputSampleRate); -<a name="l00054"></a>00054 <span class="keyword">virtual</span> <a class="code" href="classPowerSpectrum.html#ae7081e159ad1da5da1721b3048075306">~PowerSpectrum</a>(); -<a name="l00055"></a>00055 -<a name="l00056"></a>00056 <span class="keywordtype">bool</span> <a class="code" href="classPowerSpectrum.html#ae2d046334c4bede5be72a0d97e4dfb29" 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="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="classPowerSpectrum.html#a091ba21e1697ea4208f42e8295c389d9" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>(); -<a name="l00058"></a>00058 -<a name="l00059"></a><a class="code" href="classPowerSpectrum.html#ae04e0e34847a93f3444d04c802ee56ef">00059</a> <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classPowerSpectrum.html#ae04e0e34847a93f3444d04c802ee56ef" 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#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>; } -<a name="l00060"></a>00060 -<a name="l00061"></a>00061 std::string <a class="code" href="classPowerSpectrum.html#a9e9d8349461cbb88d7565a5e8c51b64e" title="Get the computer-usable name of the plugin.">getIdentifier</a>() <span class="keyword">const</span>; -<a name="l00062"></a>00062 std::string <a class="code" href="classPowerSpectrum.html#ac9214f9cafeeed3fca549c90aef57623" title="Get a human-readable name or title of the plugin.">getName</a>() <span class="keyword">const</span>; -<a name="l00063"></a>00063 std::string <a class="code" href="classPowerSpectrum.html#a7b48d56dc954f3af344f7e4dcd8993e5" 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="l00064"></a>00064 std::string <a class="code" href="classPowerSpectrum.html#a9f3e3f759e2b67c771a41f1c276984b2" 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="l00065"></a>00065 <span class="keywordtype">int</span> <a class="code" href="classPowerSpectrum.html#ad23d27e4e82f10404a37b933f6a72c33" title="Get the version number of the plugin.">getPluginVersion</a>() <span class="keyword">const</span>; -<a name="l00066"></a>00066 std::string <a class="code" href="classPowerSpectrum.html#a708b4d335c57643d5ef2b2e1caf43bd9" title="Get the copyright statement or licensing summary for the plugin.">getCopyright</a>() <span class="keyword">const</span>; -<a name="l00067"></a>00067 -<a name="l00068"></a>00068 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classPowerSpectrum.html#a6aac5f93e3a8c033026d739fed427242" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span>; -<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="classPowerSpectrum.html#aa5664ffc2b37a16db471fae791c1f55f" 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="l00071"></a>00071 <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="l00072"></a>00072 -<a name="l00073"></a>00073 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classPowerSpectrum.html#ac8a9661a785d38f4c5ce8ca2d53e69f9" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">getRemainingFeatures</a>(); -<a name="l00074"></a>00074 -<a name="l00075"></a>00075 <span class="keyword">protected</span>: -<a name="l00076"></a><a class="code" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">00076</a> <span class="keywordtype">size_t</span> <a class="code" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">m_blockSize</a>; -<a name="l00077"></a>00077 }; -<a name="l00078"></a>00078 -<a name="l00079"></a>00079 -<a name="l00080"></a>00080 <span class="preprocessor">#endif</span> -</pre></div></div><!-- contents --> +<a href="PowerSpectrum_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 _POWER_SPECTRUM_PLUGIN_H_</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define _POWER_SPECTRUM_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="l00050"></a><span class="lineno"><a class="line" href="classPowerSpectrum.html"> 50</a></span> <span class="keyword">class </span><a class="code" href="classPowerSpectrum.html">PowerSpectrum</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classPowerSpectrum.html#aa2550486513a4abcf7b52869002947e7">PowerSpectrum</a>(<span class="keywordtype">float</span> inputSampleRate);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> <a class="code" href="classPowerSpectrum.html#ae7081e159ad1da5da1721b3048075306">~PowerSpectrum</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"> 56</span>  <span class="keywordtype">bool</span> <a class="code" href="classPowerSpectrum.html#ae2d046334c4bede5be72a0d97e4dfb29">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="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span> <a class="code" href="classPowerSpectrum.html#a091ba21e1697ea4208f42e8295c389d9">reset</a>();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classPowerSpectrum.html#a6550205cd5c1bb45eca69b8ddbd0cb4f"> 59</a></span>  <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classPowerSpectrum.html#a6550205cd5c1bb45eca69b8ddbd0cb4f">getInputDomain</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::string <a class="code" href="classPowerSpectrum.html#a885e87df9fbb4e6cb2fff69116122326">getIdentifier</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::string <a class="code" href="classPowerSpectrum.html#a8f3d7d654e6aad23f307ef46dd9e70cb">getName</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="classPowerSpectrum.html#a0740aaee10568b4e21903ccd5a764e2a">getDescription</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::string <a class="code" href="classPowerSpectrum.html#a55764eb41af953c36339c4cade238be2">getMaker</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">int</span> <a class="code" href="classPowerSpectrum.html#acd30237d5e3516b3171ffddbfafd4271">getPluginVersion</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  std::string <a class="code" href="classPowerSpectrum.html#ab0e73795d0d94f1162bde9d024785147">getCopyright</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classPowerSpectrum.html#a75a374270a4f22c8104db3e815ff6d7b">getOutputDescriptors</a>() <span class="keyword">const</span>;</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="classPowerSpectrum.html#aa5664ffc2b37a16db471fae791c1f55f">process</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classPowerSpectrum.html#ac8a9661a785d38f4c5ce8ca2d53e69f9">getRemainingFeatures</a>();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8"> 76</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">m_blockSize</a>;</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> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</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="classPowerSpectrum_html_ae7081e159ad1da5da1721b3048075306"><div class="ttname"><a href="classPowerSpectrum.html#ae7081e159ad1da5da1721b3048075306">PowerSpectrum::~PowerSpectrum</a></div><div class="ttdeci">virtual ~PowerSpectrum()</div><div class="ttdef"><b>Definition:</b> <a href="PowerSpectrum_8cpp_source.html#l00051">PowerSpectrum.cpp:51</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="classPowerSpectrum_html_a8f3d7d654e6aad23f307ef46dd9e70cb"><div class="ttname"><a href="classPowerSpectrum.html#a8f3d7d654e6aad23f307ef46dd9e70cb">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00062">PowerSpectrum.cpp:62</a></div></div> +<div class="ttc" id="classVamp_1_1Plugin_html_a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"><div class="ttname"><a href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">Vamp::Plugin::FrequencyDomain</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="classPowerSpectrum_html_acd30237d5e3516b3171ffddbfafd4271"><div class="ttname"><a href="classPowerSpectrum.html#acd30237d5e3516b3171ffddbfafd4271">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00080">PowerSpectrum.cpp:80</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="classPowerSpectrum_html_a55764eb41af953c36339c4cade238be2"><div class="ttname"><a href="classPowerSpectrum.html#a55764eb41af953c36339c4cade238be2">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00074">PowerSpectrum.cpp:74</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_a885e87df9fbb4e6cb2fff69116122326"><div class="ttname"><a href="classPowerSpectrum.html#a885e87df9fbb4e6cb2fff69116122326">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00056">PowerSpectrum.cpp:56</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_aa5664ffc2b37a16db471fae791c1f55f"><div class="ttname"><a href="classPowerSpectrum.html#aa5664ffc2b37a16db471fae791c1f55f">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum.cpp:136</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_a6550205cd5c1bb45eca69b8ddbd0cb4f"><div class="ttname"><a href="classPowerSpectrum.html#a6550205cd5c1bb45eca69b8ddbd0cb4f">PowerSpectrum::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="PowerSpectrum_8h_source.html#l00059">PowerSpectrum.h:59</a></div></div> +<div class="ttc" id="classPowerSpectrum_html"><div class="ttname"><a href="classPowerSpectrum.html">PowerSpectrum</a></div><div class="ttdoc">Example plugin that returns a power spectrum calculated (trivially) from the frequency domain represe...</div><div class="ttdef"><b>Definition:</b> <a href="PowerSpectrum_8h_source.html#l00050">PowerSpectrum.h:50</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_a0740aaee10568b4e21903ccd5a764e2a"><div class="ttname"><a href="classPowerSpectrum.html#a0740aaee10568b4e21903ccd5a764e2a">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00068">PowerSpectrum.cpp:68</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="classPowerSpectrum_html_ae2d046334c4bede5be72a0d97e4dfb29"><div class="ttname"><a href="classPowerSpectrum.html#ae2d046334c4bede5be72a0d97e4dfb29">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum.cpp:92</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_ac8a9661a785d38f4c5ce8ca2d53e69f9"><div class="ttname"><a href="classPowerSpectrum.html#ac8a9661a785d38f4c5ce8ca2d53e69f9">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00166">PowerSpectrum.cpp:166</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_a75a374270a4f22c8104db3e815ff6d7b"><div class="ttname"><a href="classPowerSpectrum.html#a75a374270a4f22c8104db3e815ff6d7b">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum.cpp:108</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_a091ba21e1697ea4208f42e8295c389d9"><div class="ttname"><a href="classPowerSpectrum.html#a091ba21e1697ea4208f42e8295c389d9">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00103">PowerSpectrum.cpp:103</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 class="ttc" id="classPowerSpectrum_html_a399e997c033f26b07edb7cc83cd5a6d8"><div class="ttname"><a href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">PowerSpectrum::m_blockSize</a></div><div class="ttdeci">size_t m_blockSize</div><div class="ttdef"><b>Definition:</b> <a href="PowerSpectrum_8h_source.html#l00076">PowerSpectrum.h:76</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_ab0e73795d0d94f1162bde9d024785147"><div class="ttname"><a href="classPowerSpectrum.html#ab0e73795d0d94f1162bde9d024785147">PowerSpectrum::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="PowerSpectrum_8cpp_source.html#l00086">PowerSpectrum.cpp:86</a></div></div> +<div class="ttc" id="classPowerSpectrum_html_aa2550486513a4abcf7b52869002947e7"><div class="ttname"><a href="classPowerSpectrum.html#aa2550486513a4abcf7b52869002947e7">PowerSpectrum::PowerSpectrum</a></div><div class="ttdeci">PowerSpectrum(float inputSampleRate)</div><div class="ttdef"><b>Definition:</b> <a href="PowerSpectrum_8cpp_source.html#l00045">PowerSpectrum.cpp:45</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="PowerSpectrum_8h.html">PowerSpectrum.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="PowerSpectrum_8h.html">PowerSpectrum.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>