annotate code-doc/plugins_8cpp-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
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: plugins.cpp Source File</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 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@0 24 <div class="navpath"><a class="el" href="dir_35887283b966ca996e4ff77f459c38ce.html">examples</a>
cannam@0 25 </div>
cannam@0 26 </div>
cannam@21 27 <div class="contents">
cannam@0 28 <h1>plugins.cpp</h1><a href="plugins_8cpp.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@0 29 <a name="l00002"></a>00002
cannam@0 30 <a name="l00003"></a>00003 <span class="comment">/*</span>
cannam@0 31 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
cannam@0 32 <a name="l00005"></a>00005 <span class="comment"></span>
cannam@0 33 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
cannam@0 34 <a name="l00007"></a>00007 <span class="comment"></span>
cannam@0 35 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
cannam@0 36 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
cannam@0 37 <a name="l00010"></a>00010 <span class="comment"> </span>
cannam@0 38 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
cannam@0 39 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
cannam@0 40 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
cannam@0 41 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
cannam@0 42 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
cannam@0 43 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
cannam@0 44 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
cannam@0 45 <a name="l00018"></a>00018 <span class="comment"></span>
cannam@0 46 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
cannam@0 47 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
cannam@0 48 <a name="l00021"></a>00021 <span class="comment"></span>
cannam@0 49 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
cannam@0 50 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
cannam@0 51 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
cannam@0 52 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
cannam@0 53 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
cannam@0 54 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
cannam@0 55 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
cannam@0 56 <a name="l00029"></a>00029 <span class="comment"></span>
cannam@0 57 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
cannam@0 58 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
cannam@0 59 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
cannam@0 60 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
cannam@0 61 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
cannam@0 62 <a name="l00035"></a>00035 <span class="comment">*/</span>
cannam@0 63 <a name="l00036"></a>00036
cannam@0 64 <a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="vamp_8h.html">vamp/vamp.h</a>"</span>
cannam@0 65 <a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="PluginAdapter_8h.html">vamp-sdk/PluginAdapter.h</a>"</span>
cannam@0 66 <a name="l00039"></a>00039
cannam@0 67 <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="ZeroCrossing_8h.html">ZeroCrossing.h</a>"</span>
cannam@0 68 <a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="SpectralCentroid_8h.html">SpectralCentroid.h</a>"</span>
cannam@0 69 <a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="PercussionOnsetDetector_8h.html">PercussionOnsetDetector.h</a>"</span>
cannam@21 70 <a name="l00043"></a>00043 <span class="preprocessor">#include "<a class="code" href="FixedTempoEstimator_8h.html">FixedTempoEstimator.h</a>"</span>
cannam@21 71 <a name="l00044"></a>00044 <span class="preprocessor">#include "<a class="code" href="AmplitudeFollower_8h.html">AmplitudeFollower.h</a>"</span>
cannam@21 72 <a name="l00045"></a>00045 <span class="preprocessor">#include "<a class="code" href="PowerSpectrum_8h.html">PowerSpectrum.h</a>"</span>
cannam@21 73 <a name="l00046"></a>00046
cannam@21 74 <a name="l00047"></a><a class="code" href="plugins_8cpp.html#01871ad1ab2bb64e2c53fe5cce19b780">00047</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">Vamp::PluginAdapter&lt;ZeroCrossing&gt;</a> <a class="code" href="plugins_8cpp.html#01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a>;
cannam@21 75 <a name="l00048"></a><a class="code" href="plugins_8cpp.html#c96bdfb6356a153341b29b43c4961cd5">00048</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">Vamp::PluginAdapter&lt;SpectralCentroid&gt;</a> <a class="code" href="plugins_8cpp.html#c96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a>;
cannam@21 76 <a name="l00049"></a><a class="code" href="plugins_8cpp.html#cee3823cb6a43281a2ecf923b69613dd">00049</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">Vamp::PluginAdapter&lt;PercussionOnsetDetector&gt;</a> <a class="code" href="plugins_8cpp.html#cee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a>;
cannam@21 77 <a name="l00050"></a><a class="code" href="plugins_8cpp.html#937de36d22633261716032570064a4be">00050</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">Vamp::PluginAdapter&lt;FixedTempoEstimator&gt;</a> <a class="code" href="plugins_8cpp.html#937de36d22633261716032570064a4be">fixedTempoAdapter</a>;
cannam@21 78 <a name="l00051"></a><a class="code" href="plugins_8cpp.html#4e60bb6a99451da5deb18b969e6b16cd">00051</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">Vamp::PluginAdapter&lt;AmplitudeFollower&gt;</a> <a class="code" href="plugins_8cpp.html#4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a>;
cannam@21 79 <a name="l00052"></a><a class="code" href="plugins_8cpp.html#77810f485caaae4a8b2303496046d3d7">00052</a> <span class="keyword">static</span> <a class="code" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">Vamp::PluginAdapter&lt;PowerSpectrum&gt;</a> <a class="code" href="plugins_8cpp.html#77810f485caaae4a8b2303496046d3d7">powerSpectrum</a>;
cannam@21 80 <a name="l00053"></a>00053
cannam@21 81 <a name="l00054"></a><a class="code" href="plugins_8cpp.html#bb0fd6db76ddd39698bc370e0fd0ea78">00054</a> <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *<a class="code" href="vamp_8h.html#50cf6f17d0718f02093be6c7f63fcf30" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> version,
cannam@21 82 <a name="l00055"></a>00055 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index)
cannam@21 83 <a name="l00056"></a>00056 {
cannam@21 84 <a name="l00057"></a>00057 <span class="keywordflow">if</span> (version &lt; 1) <span class="keywordflow">return</span> 0;
cannam@21 85 <a name="l00058"></a>00058
cannam@21 86 <a name="l00059"></a>00059 <span class="keywordflow">switch</span> (index) {
cannam@21 87 <a name="l00060"></a>00060 <span class="keywordflow">case</span> 0: <span class="keywordflow">return</span> zeroCrossingAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb" title="Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter...">getDescriptor</a>();
cannam@21 88 <a name="l00061"></a>00061 <span class="keywordflow">case</span> 1: <span class="keywordflow">return</span> spectralCentroidAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb" title="Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter...">getDescriptor</a>();
cannam@21 89 <a name="l00062"></a>00062 <span class="keywordflow">case</span> 2: <span class="keywordflow">return</span> percussionOnsetAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb" title="Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter...">getDescriptor</a>();
cannam@21 90 <a name="l00063"></a>00063 <span class="keywordflow">case</span> 3: <span class="keywordflow">return</span> amplitudeAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb" title="Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter...">getDescriptor</a>();
cannam@21 91 <a name="l00064"></a>00064 <span class="keywordflow">case</span> 4: <span class="keywordflow">return</span> fixedTempoAdapter.<a class="code" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb" title="Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter...">getDescriptor</a>();
cannam@21 92 <a name="l00065"></a>00065 <span class="keywordflow">case</span> 5: <span class="keywordflow">return</span> powerSpectrum.<a class="code" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb" title="Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter...">getDescriptor</a>();
cannam@21 93 <a name="l00066"></a>00066 <span class="keywordflow">default</span>: <span class="keywordflow">return</span> 0;
cannam@21 94 <a name="l00067"></a>00067 }
cannam@21 95 <a name="l00068"></a>00068 }
cannam@21 96 <a name="l00069"></a>00069
cannam@0 97 </pre></div></div>
cannam@35 98 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
cannam@0 99 <a href="http://www.doxygen.org/index.html">
cannam@35 100 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 101 </body>
cannam@0 102 </html>