Mercurial > hg > vamp-docs
view code-docs/plugins_8cpp_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 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"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>VampPluginSDK: plugins.cpp Source File</title> <link href="tabs.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="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, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.7</span> </div> </td> </tr> </tbody> </table> </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;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('plugins_8cpp_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">plugins.cpp</div> </div> </div><!--header--> <div class="contents"> <a href="plugins_8cpp.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">#include "<a class="code" href="vamp_8h.html">vamp/vamp.h</a>"</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include "<a class="code" href="PluginAdapter_8h.html">vamp-sdk/PluginAdapter.h</a>"</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="ZeroCrossing_8h.html">ZeroCrossing.h</a>"</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include "<a class="code" href="SpectralCentroid_8h.html">SpectralCentroid.h</a>"</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include "<a class="code" href="PercussionOnsetDetector_8h.html">PercussionOnsetDetector.h</a>"</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include "<a class="code" href="FixedTempoEstimator_8h.html">FixedTempoEstimator.h</a>"</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include "<a class="code" href="AmplitudeFollower_8h.html">AmplitudeFollower.h</a>"</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include "<a class="code" href="PowerSpectrum_8h.html">PowerSpectrum.h</a>"</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780"> 47</a></span> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter<ZeroCrossing></a> <a class="code" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5"> 48</a></span> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter<SpectralCentroid></a> <a class="code" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd"> 49</a></span> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter<PercussionOnsetDetector></a> <a class="code" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="plugins_8cpp.html#a937de36d22633261716032570064a4be"> 50</a></span> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter<FixedTempoEstimator></a> <a class="code" href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd"> 51</a></span> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter<AmplitudeFollower></a> <a class="code" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a>;</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7"> 52</a></span> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter<PowerSpectrum></a> <a class="code" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78"> 54</a></span> <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *<a class="code" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> version,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> (version < 1) <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">switch</span> (index) {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">case</span> 0: <span class="keywordflow">return</span> zeroCrossingAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a>();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">case</span> 1: <span class="keywordflow">return</span> spectralCentroidAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a>();</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">case</span> 2: <span class="keywordflow">return</span> percussionOnsetAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a>();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">case</span> 3: <span class="keywordflow">return</span> amplitudeAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a>();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">case</span> 4: <span class="keywordflow">return</span> fixedTempoAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a>();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">case</span> 5: <span class="keywordflow">return</span> powerSpectrum.<a class="code" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a>();</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">default</span>: <span class="keywordflow">return</span> 0;</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> }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="ttc" id="classVamp_1_1PluginAdapter_html"><div class="ttname"><a href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a></div><div class="ttdoc">PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...</div><div class="ttdef"><b>Definition:</b> <a href="PluginAdapter_8h_source.html#l00095">PluginAdapter.h:95</a></div></div> <div class="ttc" id="PluginAdapter_8h_html"><div class="ttname"><a href="PluginAdapter_8h.html">PluginAdapter.h</a></div></div> <div class="ttc" id="PowerSpectrum_8h_html"><div class="ttname"><a href="PowerSpectrum_8h.html">PowerSpectrum.h</a></div></div> <div class="ttc" id="plugins_8cpp_html_acee3823cb6a43281a2ecf923b69613dd"><div class="ttname"><a href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a></div><div class="ttdeci">static Vamp::PluginAdapter< PercussionOnsetDetector > percussionOnsetAdapter</div><div class="ttdef"><b>Definition:</b> <a href="plugins_8cpp_source.html#l00049">plugins.cpp:49</a></div></div> <div class="ttc" id="plugins_8cpp_html_a77810f485caaae4a8b2303496046d3d7"><div class="ttname"><a href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a></div><div class="ttdeci">static Vamp::PluginAdapter< PowerSpectrum > powerSpectrum</div><div class="ttdef"><b>Definition:</b> <a href="plugins_8cpp_source.html#l00052">plugins.cpp:52</a></div></div> <div class="ttc" id="SpectralCentroid_8h_html"><div class="ttname"><a href="SpectralCentroid_8h.html">SpectralCentroid.h</a></div></div> <div class="ttc" id="classVamp_1_1PluginAdapterBase_html_ad24595002512f9f00e8e45216d6f5dfb"><div class="ttname"><a href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor</a></div><div class="ttdeci">const VampPluginDescriptor * getDescriptor()</div><div class="ttdoc">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. </div></div> <div class="ttc" id="plugins_8cpp_html_a01871ad1ab2bb64e2c53fe5cce19b780"><div class="ttname"><a href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a></div><div class="ttdeci">static Vamp::PluginAdapter< ZeroCrossing > zeroCrossingAdapter</div><div class="ttdef"><b>Definition:</b> <a href="plugins_8cpp_source.html#l00047">plugins.cpp:47</a></div></div> <div class="ttc" id="plugins_8cpp_html_ac96bdfb6356a153341b29b43c4961cd5"><div class="ttname"><a href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a></div><div class="ttdeci">static Vamp::PluginAdapter< SpectralCentroid > spectralCentroidAdapter</div><div class="ttdef"><b>Definition:</b> <a href="plugins_8cpp_source.html#l00048">plugins.cpp:48</a></div></div> <div class="ttc" id="struct__VampPluginDescriptor_html"><div class="ttname"><a href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></div><div class="ttdef"><b>Definition:</b> <a href="vamp_8h_source.html#l00248">vamp.h:248</a></div></div> <div class="ttc" id="vamp_8h_html"><div class="ttname"><a href="vamp_8h.html">vamp.h</a></div></div> <div class="ttc" id="FixedTempoEstimator_8h_html"><div class="ttname"><a href="FixedTempoEstimator_8h.html">FixedTempoEstimator.h</a></div></div> <div class="ttc" id="ZeroCrossing_8h_html"><div class="ttname"><a href="ZeroCrossing_8h.html">ZeroCrossing.h</a></div></div> <div class="ttc" id="AmplitudeFollower_8h_html"><div class="ttname"><a href="AmplitudeFollower_8h.html">AmplitudeFollower.h</a></div></div> <div class="ttc" id="plugins_8cpp_html_a4e60bb6a99451da5deb18b969e6b16cd"><div class="ttname"><a href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a></div><div class="ttdeci">static Vamp::PluginAdapter< AmplitudeFollower > amplitudeAdapter</div><div class="ttdef"><b>Definition:</b> <a href="plugins_8cpp_source.html#l00051">plugins.cpp:51</a></div></div> <div class="ttc" id="plugins_8cpp_html_abb0fd6db76ddd39698bc370e0fd0ea78"><div class="ttname"><a href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a></div><div class="ttdeci">const VampPluginDescriptor * vampGetPluginDescriptor(unsigned int version, unsigned int index)</div><div class="ttdoc">Get the descriptor for a given plugin index in this library. </div><div class="ttdef"><b>Definition:</b> <a href="plugins_8cpp_source.html#l00054">plugins.cpp:54</a></div></div> <div class="ttc" id="plugins_8cpp_html_a937de36d22633261716032570064a4be"><div class="ttname"><a href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a></div><div class="ttdeci">static Vamp::PluginAdapter< FixedTempoEstimator > fixedTempoAdapter</div><div class="ttdef"><b>Definition:</b> <a href="plugins_8cpp_source.html#l00050">plugins.cpp:50</a></div></div> <div class="ttc" id="PercussionOnsetDetector_8h_html"><div class="ttname"><a href="PercussionOnsetDetector_8h.html">PercussionOnsetDetector.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="plugins_8cpp.html">plugins.cpp</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> </body> </html>