Mercurial > hg > vamp-website
view code-doc/vamp-sdk_2Plugin_8h-source.html @ 128:817c3988afc7 website tip
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 |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VampPluginSDK: Plugin.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.8 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.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 class="tabs"> <ul> <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 class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a> </div> </div> <div class="contents"> <h1>vamp-sdk/Plugin.h</h1><a href="vamp-sdk_2Plugin_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 _VAMP_SDK_PLUGIN_H_</span> <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_H_</span> <a name="l00039"></a>00039 <span class="preprocessor"></span> <a name="l00040"></a>00040 <span class="preprocessor">#include <string></span> <a name="l00041"></a>00041 <span class="preprocessor">#include <vector></span> <a name="l00042"></a>00042 <span class="preprocessor">#include <map></span> <a name="l00043"></a>00043 <a name="l00044"></a>00044 <span class="preprocessor">#include "PluginBase.h"</span> <a name="l00045"></a>00045 <span class="preprocessor">#include "RealTime.h"</span> <a name="l00046"></a>00046 <a name="l00047"></a>00047 <span class="preprocessor">#include "<a class="code" href="plugguard_8h.html">plugguard.h</a>"</span> <a name="l00048"></a>00048 <a class="code" href="plugguard_8h.html#1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(Plugin.h) <a name="l00049"></a>00049 <a name="l00050"></a><a class="code" href="namespaceVamp.html">00050</a> namespace Vamp { <a name="l00051"></a>00051 <a name="l00124"></a><a class="code" href="classVamp_1_1Plugin.html">00124</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Plugin</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a> <a name="l00125"></a>00125 { <a name="l00126"></a>00126 <span class="keyword">public</span>: <a name="l00127"></a><a class="code" href="classVamp_1_1Plugin.html#42d3096f9c1f58b1876024cd8d9ab80b">00127</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1Plugin.html#42d3096f9c1f58b1876024cd8d9ab80b">~Plugin</a>() { } <a name="l00128"></a>00128 <a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> inputChannels, <a name="l00142"></a>00142 <span class="keywordtype">size_t</span> stepSize, <a name="l00143"></a>00143 <span class="keywordtype">size_t</span> blockSize) = 0; <a name="l00144"></a>00144 <a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0; <a name="l00151"></a>00151 <a name="l00152"></a><a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">00152</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { TimeDomain, FrequencyDomain }; <a name="l00153"></a>00153 <a name="l00169"></a>00169 <span class="keyword">virtual</span> InputDomain getInputDomain() <span class="keyword">const</span> = 0; <a name="l00170"></a>00170 <a name="l00179"></a><a class="code" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">00179</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac" title="Get the preferred block size (window size -- the number of sample frames passed in...">getPreferredBlockSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; } <a name="l00180"></a>00180 <a name="l00194"></a><a class="code" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">00194</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567" title="Get the preferred step size (window increment -- the distance in sample frames between...">getPreferredStepSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; } <a name="l00195"></a>00195 <a name="l00199"></a><a class="code" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">00199</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525" title="Get the minimum supported number of input channels.">getMinChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; } <a name="l00200"></a>00200 <a name="l00204"></a><a class="code" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">00204</a> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; } <a name="l00205"></a>00205 <a name="l00206"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">00206</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> <a name="l00207"></a>00207 { <a name="l00214"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#2e6f77bcb12d4c95da25348ac85b8696">00214</a> std::string identifier; <a name="l00215"></a>00215 <a name="l00220"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0992e05ea70425878365ba85663400a7">00220</a> std::string name; <a name="l00221"></a>00221 <a name="l00227"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#8b44602d8ccea8bb862fd766e74efa1c">00227</a> std::string description; <a name="l00228"></a>00228 <a name="l00232"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#52f4b3d8d7070cc9c5ab4aa6ff0c01a0">00232</a> std::string unit; <a name="l00233"></a>00233 <a name="l00239"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0653d3a85fdc226e60fd5e612b399e0c">00239</a> <span class="keywordtype">bool</span> hasFixedBinCount; <a name="l00240"></a>00240 <a name="l00247"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#238a4781ebb4151832cbf521feb0fedc">00247</a> <span class="keywordtype">size_t</span> binCount; <a name="l00248"></a>00248 <a name="l00253"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#62b6bdd0d36381da4176b27663072b49">00253</a> std::vector<std::string> binNames; <a name="l00254"></a>00254 <a name="l00260"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#4b8d0d88bee613709e91b48402e28c8e">00260</a> <span class="keywordtype">bool</span> hasKnownExtents; <a name="l00261"></a>00261 <a name="l00266"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1fc73936c43014393918fe6cce46ac6d">00266</a> <span class="keywordtype">float</span> minValue; <a name="l00267"></a>00267 <a name="l00272"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0df82ce301ad1bc337a272cb730426cf">00272</a> <span class="keywordtype">float</span> maxValue; <a name="l00273"></a>00273 <a name="l00278"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#43673cd31b2b65af427a8e8b8746b6e8">00278</a> <span class="keywordtype">bool</span> isQuantized; <a name="l00279"></a>00279 <a name="l00285"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#674cd333889514cf8408c18762fede12">00285</a> <span class="keywordtype">float</span> quantizeStep; <a name="l00286"></a>00286 <a name="l00287"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">00287</a> <span class="keyword">enum</span> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> { <a name="l00288"></a>00288 <a name="l00290"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c8915f78de285a79dd415e0c6012d1ead">00290</a> OneSamplePerStep, <a name="l00291"></a>00291 <a name="l00293"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cecfd91605a3f11c716e822dc696c27a3">00293</a> FixedSampleRate, <a name="l00294"></a>00294 <a name="l00296"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c95be613508cf4009a7dc2f70ddf99547">00296</a> VariableSampleRate <a name="l00297"></a>00297 }; <a name="l00298"></a>00298 <a name="l00302"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3cd2e0b7a6da19c32bbb6809a83d9adf">00302</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> sampleType; <a name="l00303"></a>00303 <a name="l00314"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e49cc87dcb0f09b59feb85d2b78e80ef">00314</a> <span class="keywordtype">float</span> sampleRate; <a name="l00315"></a>00315 <a name="l00320"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#93cc15894c89a142741c2bd088cdd6af">00320</a> <span class="keywordtype">bool</span> hasDuration; <a name="l00321"></a>00321 <a name="l00322"></a><a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ba660cc15254061875cbf9ba932aca95">00322</a> <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>() : <span class="comment">// defaults for mandatory non-class-type members</span> <a name="l00323"></a>00323 hasFixedBinCount(false), hasKnownExtents(false), isQuantized(false), <a name="l00324"></a>00324 sampleType(OneSamplePerStep), hasDuration(false) { } <a name="l00325"></a>00325 }; <a name="l00326"></a>00326 <a name="l00327"></a><a class="code" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">00327</a> <span class="keyword">typedef</span> std::vector<OutputDescriptor> OutputList; <a name="l00328"></a>00328 <a name="l00334"></a>00334 <span class="keyword">virtual</span> OutputList getOutputDescriptors() <span class="keyword">const</span> = 0; <a name="l00335"></a>00335 <a name="l00336"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">00336</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> <a name="l00337"></a>00337 { <a name="l00344"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#116bb1b3420a067fc1290b75982fdf62">00344</a> <span class="keywordtype">bool</span> hasTimestamp; <a name="l00345"></a>00345 <a name="l00352"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#aaf212bd458dc5e6f441bf7606121311">00352</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> timestamp; <a name="l00353"></a>00353 <a name="l00360"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#2a962f4b26d6417ad1b72ae29949332e">00360</a> <span class="keywordtype">bool</span> hasDuration; <a name="l00361"></a>00361 <a name="l00367"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#f09e2624341f81c8f1f9c2d9137b4230">00367</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> duration; <a name="l00368"></a>00368 <a name="l00374"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#106162977cdc92a02146fcb5ed18a34d">00374</a> std::vector<float> values; <a name="l00375"></a>00375 <a name="l00379"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#14ff2ab7442f508fc3bd3d96c3e85eb5">00379</a> std::string label; <a name="l00380"></a>00380 <a name="l00381"></a><a class="code" href="structVamp_1_1Plugin_1_1Feature.html#3cd6cae91305ae8bcbd6248954a460f8">00381</a> <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>() : <span class="comment">// defaults for mandatory non-class-type members</span> <a name="l00382"></a>00382 hasTimestamp(false), hasDuration(false) { } <a name="l00383"></a>00383 }; <a name="l00384"></a>00384 <a name="l00385"></a><a class="code" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">00385</a> <span class="keyword">typedef</span> std::vector<Feature> FeatureList; <a name="l00386"></a>00386 <a name="l00387"></a><a class="code" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">00387</a> <span class="keyword">typedef</span> std::map<int, FeatureList> FeatureSet; <span class="comment">// key is output no</span> <a name="l00388"></a>00388 <a name="l00416"></a>00416 <span class="keyword">virtual</span> FeatureSet process(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, <a name="l00417"></a>00417 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> timestamp) = 0; <a name="l00418"></a>00418 <a name="l00423"></a>00423 <span class="keyword">virtual</span> FeatureSet getRemainingFeatures() = 0; <a name="l00424"></a>00424 <a name="l00430"></a><a class="code" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">00430</a> <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91" title="Used to distinguish between Vamp::Plugin and other potential sibling subclasses of...">getType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"Feature Extraction Plugin"</span>; } <a name="l00431"></a>00431 <a name="l00432"></a>00432 <span class="keyword">protected</span>: <a name="l00433"></a><a class="code" href="classVamp_1_1Plugin.html#1b78c4f46c72ef345ed27f0b9bf20ac9">00433</a> <a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Plugin</a>(<span class="keywordtype">float</span> inputSampleRate) : <a name="l00434"></a>00434 m_inputSampleRate(inputSampleRate) { } <a name="l00435"></a>00435 <a name="l00436"></a><a class="code" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">00436</a> <span class="keywordtype">float</span> m_inputSampleRate; <a name="l00437"></a>00437 }; <a name="l00438"></a>00438 <a name="l00439"></a>00439 } <a name="l00440"></a>00440 <a name="l00441"></a>00441 <a class="code" href="plugguard_8h.html#c879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(Plugin.h) <a name="l00442"></a>00442 <a name="l00443"></a>00443 <span class="preprocessor">#endif</span> <a name="l00444"></a>00444 <span class="preprocessor"></span> <a name="l00445"></a>00445 <a name="l00446"></a>00446 </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> </body> </html>