Mercurial > hg > vamp-website

annotate code-doc/PowerSpectrum_8h-source.html @ 128:817c3988afc7 website tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 0976232e353b
children
rev   line source
cannam@21 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@21 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@21 3 <title>VampPluginSDK: PowerSpectrum.h Source File</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@21 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@21 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@21 8 <div class="navigation" id="top">
cannam@21 9 <div class="tabs">
cannam@21 10 <ul>
cannam@21 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@21 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@21 13 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@21 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@21 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@21 16 </ul>
cannam@21 17 </div>
cannam@35 18 <div class="tabs">
cannam@35 19 <ul>
cannam@35 20 <li><a href="files.html"><span>File&nbsp;List</span></a></li>
cannam@35 21 <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
cannam@35 22 </ul>
cannam@35 23 </div>
cannam@21 24 <div class="navpath"><a class="el" href="dir_35887283b966ca996e4ff77f459c38ce.html">examples</a>
cannam@21 25 </div>
cannam@21 26 </div>
cannam@21 27 <div class="contents">
cannam@21 28 <h1>PowerSpectrum.h</h1><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>
cannam@21 29 <a name="l00002"></a>00002
cannam@21 30 <a name="l00003"></a>00003 <span class="comment">/*</span>
cannam@21 31 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
cannam@21 32 <a name="l00005"></a>00005 <span class="comment"></span>
cannam@21 33 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
cannam@21 34 <a name="l00007"></a>00007 <span class="comment"></span>
cannam@21 35 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
cannam@21 36 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
cannam@21 37 <a name="l00010"></a>00010 <span class="comment"> </span>
cannam@21 38 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
cannam@21 39 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
cannam@21 40 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
cannam@21 41 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
cannam@21 42 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
cannam@21 43 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
cannam@21 44 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
cannam@21 45 <a name="l00018"></a>00018 <span class="comment"></span>
cannam@21 46 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
cannam@21 47 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
cannam@21 48 <a name="l00021"></a>00021 <span class="comment"></span>
cannam@21 49 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
cannam@21 50 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
cannam@21 51 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
cannam@21 52 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
cannam@21 53 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
cannam@21 54 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
cannam@21 55 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
cannam@21 56 <a name="l00029"></a>00029 <span class="comment"></span>
cannam@21 57 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
cannam@21 58 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
cannam@21 59 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
cannam@21 60 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
cannam@21 61 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
cannam@21 62 <a name="l00035"></a>00035 <span class="comment">*/</span>
cannam@21 63 <a name="l00036"></a>00036
cannam@21 64 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _POWER_SPECTRUM_PLUGIN_H_</span>
cannam@21 65 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _POWER_SPECTRUM_PLUGIN_H_</span>
cannam@21 66 <a name="l00039"></a>00039 <span class="preprocessor"></span>
cannam@21 67 <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a>"</span>
cannam@21 68 <a name="l00041"></a>00041
cannam@21 69 <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...">PowerSpectrum</a> : <span class="keyword">public</span> Vamp::<a class="code" href="classVamp_1_1Plugin.html#1b78c4f46c72ef345ed27f0b9bf20ac9">Plugin</a>
cannam@21 70 <a name="l00051"></a>00051 {
cannam@21 71 <a name="l00052"></a>00052 <span class="keyword">public</span>:
cannam@21 72 <a name="l00053"></a>00053 <a class="code" href="classPowerSpectrum.html#a2550486513a4abcf7b52869002947e7">PowerSpectrum</a>(<span class="keywordtype">float</span> inputSampleRate);
cannam@21 73 <a name="l00054"></a>00054 <span class="keyword">virtual</span> <a class="code" href="classPowerSpectrum.html#e7081e159ad1da5da1721b3048075306">~PowerSpectrum</a>();
cannam@21 74 <a name="l00055"></a>00055
cannam@21 75 <a name="l00056"></a>00056 <span class="keywordtype">bool</span> <a class="code" href="classPowerSpectrum.html#e2d046334c4bede5be72a0d97e4dfb29" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize);
cannam@21 76 <a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="classPowerSpectrum.html#091ba21e1697ea4208f42e8295c389d9" title="Reset the plugin after use, to prepare it for another clean run.">reset</a>();
cannam@21 77 <a name="l00058"></a>00058
cannam@21 78 <a name="l00059"></a><a class="code" href="classPowerSpectrum.html#e04e0e34847a93f3444d04c802ee56ef">00059</a> <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="code" href="classPowerSpectrum.html#e04e0e34847a93f3444d04c802ee56ef" title="Get the plugin&amp;#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#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>; }
cannam@21 79 <a name="l00060"></a>00060
cannam@21 80 <a name="l00061"></a>00061 std::string <a class="code" href="classPowerSpectrum.html#9e9d8349461cbb88d7565a5e8c51b64e" title="Get the computer-usable name of the plugin.">getIdentifier</a>() <span class="keyword">const</span>;
cannam@21 81 <a name="l00062"></a>00062 std::string <a class="code" href="classPowerSpectrum.html#c9214f9cafeeed3fca549c90aef57623" title="Get a human-readable name or title of the plugin.">getName</a>() <span class="keyword">const</span>;
cannam@21 82 <a name="l00063"></a>00063 std::string <a class="code" href="classPowerSpectrum.html#7b48d56dc954f3af344f7e4dcd8993e5" title="Get a human-readable description for the plugin, typically a line of text that may...">getDescription</a>() <span class="keyword">const</span>;
cannam@21 83 <a name="l00064"></a>00064 std::string <a class="code" href="classPowerSpectrum.html#9f3e3f759e2b67c771a41f1c276984b2" title="Get the name of the author or vendor of the plugin in human-readable form.">getMaker</a>() <span class="keyword">const</span>;
cannam@21 84 <a name="l00065"></a>00065 <span class="keywordtype">int</span> <a class="code" href="classPowerSpectrum.html#d23d27e4e82f10404a37b933f6a72c33" title="Get the version number of the plugin.">getPluginVersion</a>() <span class="keyword">const</span>;
cannam@21 85 <a name="l00066"></a>00066 std::string <a class="code" href="classPowerSpectrum.html#708b4d335c57643d5ef2b2e1caf43bd9" title="Get the copyright statement or licensing summary for the plugin.">getCopyright</a>() <span class="keyword">const</span>;
cannam@21 86 <a name="l00067"></a>00067
cannam@21 87 <a name="l00068"></a>00068 <a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="code" href="classPowerSpectrum.html#6aac5f93e3a8c033026d739fed427242" title="Get the outputs of this plugin.">getOutputDescriptors</a>() <span class="keyword">const</span>;
cannam@21 88 <a name="l00069"></a>00069
cannam@21 89 <a name="l00070"></a>00070 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classPowerSpectrum.html#a5664ffc2b37a16db471fae791c1f55f" 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,
cannam@21 90 <a name="l00071"></a>00071 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">Vamp::RealTime</a> timestamp);
cannam@21 91 <a name="l00072"></a>00072
cannam@21 92 <a name="l00073"></a>00073 <a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="code" href="classPowerSpectrum.html#c8a9661a785d38f4c5ce8ca2d53e69f9" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures</a>();
cannam@21 93 <a name="l00074"></a>00074
cannam@21 94 <a name="l00075"></a>00075 <span class="keyword">protected</span>:
cannam@21 95 <a name="l00076"></a><a class="code" href="classPowerSpectrum.html#399e997c033f26b07edb7cc83cd5a6d8">00076</a> <span class="keywordtype">size_t</span> <a class="code" href="classPowerSpectrum.html#399e997c033f26b07edb7cc83cd5a6d8">m_blockSize</a>;
cannam@21 96 <a name="l00077"></a>00077 };
cannam@21 97 <a name="l00078"></a>00078
cannam@21 98 <a name="l00079"></a>00079
cannam@21 99 <a name="l00080"></a>00080 <span class="preprocessor">#endif</span>
cannam@21 100 </pre></div></div>
cannam@35 101 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
cannam@21 102 <a href="http://www.doxygen.org/index.html">
cannam@35 103 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@21 104 </body>
cannam@21 105 </html>