Mercurial > hg > vamp-website

annotate code-doc/vamp_8h-source.html @ 7:60ee9a026a62 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
...
author cannam
date Fri, 14 Nov 2008 11:56:54 +0000
parents 351c4ebce5f9
children cc0be37dc9d3
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: vamp.h Source File</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@0 7 <!-- Generated by Doxygen 1.5.5 -->
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@0 18 <div class="navpath"><a class="el" href="dir_b086eb10f854304ab96fb3af468374a7.html">vamp</a>
cannam@0 19 </div>
cannam@0 20 </div>
cannam@0 21 </div>
cannam@0 22 <h1>vamp.h</h1><a href="vamp_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@0 23 <a name="l00002"></a>00002
cannam@0 24 <a name="l00003"></a>00003 <span class="comment">/*</span>
cannam@0 25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
cannam@0 26 <a name="l00005"></a>00005 <span class="comment"></span>
cannam@0 27 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
cannam@0 28 <a name="l00007"></a>00007 <span class="comment"></span>
cannam@0 29 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
cannam@0 30 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
cannam@0 31 <a name="l00010"></a>00010 <span class="comment"> </span>
cannam@0 32 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
cannam@0 33 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
cannam@0 34 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
cannam@0 35 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
cannam@0 36 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
cannam@0 37 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
cannam@0 38 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
cannam@0 39 <a name="l00018"></a>00018 <span class="comment"></span>
cannam@0 40 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
cannam@0 41 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
cannam@0 42 <a name="l00021"></a>00021 <span class="comment"></span>
cannam@0 43 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
cannam@0 44 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
cannam@0 45 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
cannam@0 46 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
cannam@0 47 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
cannam@0 48 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
cannam@0 49 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
cannam@0 50 <a name="l00029"></a>00029 <span class="comment"></span>
cannam@0 51 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
cannam@0 52 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
cannam@0 53 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
cannam@0 54 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
cannam@0 55 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
cannam@0 56 <a name="l00035"></a>00035 <span class="comment">*/</span>
cannam@0 57 <a name="l00036"></a>00036
cannam@0 58 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef VAMP_HEADER_INCLUDED</span>
cannam@0 59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define VAMP_HEADER_INCLUDED</span>
cannam@0 60 <a name="l00039"></a>00039 <span class="preprocessor"></span>
cannam@0 61 <a name="l00040"></a>00040 <span class="preprocessor">#ifdef __cplusplus</span>
cannam@0 62 <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
cannam@0 63 <a name="l00042"></a>00042 <span class="preprocessor">#endif</span>
cannam@0 64 <a name="l00043"></a>00043 <span class="preprocessor"></span>
cannam@0 65 <a name="l00053"></a><a class="code" href="vamp_8h.html#6d6c8c755dbabf161f72712e0e2143c7">00053</a> <span class="preprocessor">#define VAMP_API_VERSION 1</span>
cannam@0 66 <a name="l00054"></a>00054 <span class="preprocessor"></span>
cannam@0 67 <a name="l00071"></a><a class="code" href="struct__VampParameterDescriptor.html">00071</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins.">_VampParameterDescriptor</a>
cannam@0 68 <a name="l00072"></a>00072 {
cannam@0 69 <a name="l00074"></a><a class="code" href="struct__VampParameterDescriptor.html#26d74afd6a3341a673f15955031845ab">00074</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampParameterDescriptor.html#26d74afd6a3341a673f15955031845ab" title="Computer-usable name of the parameter.">identifier</a>;
cannam@0 70 <a name="l00075"></a>00075
cannam@0 71 <a name="l00077"></a><a class="code" href="struct__VampParameterDescriptor.html#bba810bce9656f6002777f6c3f655957">00077</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampParameterDescriptor.html#bba810bce9656f6002777f6c3f655957" title="Human-readable name of the parameter.">name</a>;
cannam@0 72 <a name="l00078"></a>00078
cannam@0 73 <a name="l00080"></a><a class="code" href="struct__VampParameterDescriptor.html#95489272d6cf5a5b487e949da8e4fac6">00080</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampParameterDescriptor.html#95489272d6cf5a5b487e949da8e4fac6" title="Human-readable short text about the parameter.">description</a>;
cannam@0 74 <a name="l00081"></a>00081
cannam@0 75 <a name="l00083"></a><a class="code" href="struct__VampParameterDescriptor.html#8ca235f816b56dc99125e010eee08fc7">00083</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampParameterDescriptor.html#8ca235f816b56dc99125e010eee08fc7" title="Human-readable unit of the parameter.">unit</a>;
cannam@0 76 <a name="l00084"></a>00084
cannam@0 77 <a name="l00086"></a><a class="code" href="struct__VampParameterDescriptor.html#b59c84f0bbe0d4d0c578d893c087b0db">00086</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampParameterDescriptor.html#b59c84f0bbe0d4d0c578d893c087b0db" title="Minimum value.">minValue</a>;
cannam@0 78 <a name="l00087"></a>00087
cannam@0 79 <a name="l00089"></a><a class="code" href="struct__VampParameterDescriptor.html#6e7646babdb265c4abfc107ba4350d80">00089</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampParameterDescriptor.html#6e7646babdb265c4abfc107ba4350d80" title="Maximum value.">maxValue</a>;
cannam@0 80 <a name="l00090"></a>00090
cannam@0 81 <a name="l00092"></a><a class="code" href="struct__VampParameterDescriptor.html#3d37f986ee152ab55feb9902b35f7aca">00092</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampParameterDescriptor.html#3d37f986ee152ab55feb9902b35f7aca" title="Default value.">defaultValue</a>;
cannam@0 82 <a name="l00093"></a>00093
cannam@0 83 <a name="l00095"></a><a class="code" href="struct__VampParameterDescriptor.html#3f41e3b6b69c7a95ff0ce8625794f83a">00095</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampParameterDescriptor.html#3f41e3b6b69c7a95ff0ce8625794f83a" title="1 if parameter values are quantized to a particular resolution.">isQuantized</a>;
cannam@0 84 <a name="l00096"></a>00096
cannam@0 85 <a name="l00098"></a><a class="code" href="struct__VampParameterDescriptor.html#68c91fd3fc0b0b3617c2d343fe32d0e5">00098</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampParameterDescriptor.html#68c91fd3fc0b0b3617c2d343fe32d0e5" title="Quantization resolution, if isQuantized.">quantizeStep</a>;
cannam@0 86 <a name="l00099"></a>00099
cannam@0 87 <a name="l00101"></a><a class="code" href="struct__VampParameterDescriptor.html#188883325ab1e4a898e3dc53a8f88f9d">00101</a> <span class="keyword">const</span> <span class="keywordtype">char</span> **<a class="code" href="struct__VampParameterDescriptor.html#188883325ab1e4a898e3dc53a8f88f9d" title="Human-readable names of the values, if isQuantized.">valueNames</a>;
cannam@0 88 <a name="l00102"></a>00102
cannam@0 89 <a name="l00103"></a>00103 } <a class="code" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins.">VampParameterDescriptor</a>;
cannam@0 90 <a name="l00104"></a>00104
cannam@0 91 <a name="l00105"></a><a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821">00105</a> <span class="keyword">typedef</span> <span class="keyword">enum</span>
cannam@0 92 <a name="l00106"></a>00106 {
cannam@0 93 <a name="l00108"></a><a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821b546deafd57f175fb1e7f9cbea1c5113">00108</a> <a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821b546deafd57f175fb1e7f9cbea1c5113" title="Each process call returns results aligned with call&amp;#39;s block start.">vampOneSamplePerStep</a>,
cannam@0 94 <a name="l00109"></a>00109
cannam@0 95 <a name="l00111"></a><a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821afc8a05f722bc83ecce227e12e838cf8">00111</a> <a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821afc8a05f722bc83ecce227e12e838cf8" title="Returned results are evenly spaced at samplerate specified below.">vampFixedSampleRate</a>,
cannam@0 96 <a name="l00112"></a>00112
cannam@0 97 <a name="l00114"></a><a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821bae8a21a9e30eb73e16d6abc6c7415e8">00114</a> <a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821bae8a21a9e30eb73e16d6abc6c7415e8" title="Returned results have their own individual timestamps.">vampVariableSampleRate</a>
cannam@0 98 <a name="l00115"></a>00115
cannam@0 99 <a name="l00116"></a>00116 } <a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821">VampSampleType</a>;
cannam@0 100 <a name="l00117"></a>00117
cannam@0 101 <a name="l00118"></a><a class="code" href="struct__VampOutputDescriptor.html">00118</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a>
cannam@0 102 <a name="l00119"></a>00119 {
cannam@0 103 <a name="l00121"></a><a class="code" href="struct__VampOutputDescriptor.html#461161b2010370176115967e4f58a5f5">00121</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampOutputDescriptor.html#461161b2010370176115967e4f58a5f5" title="Computer-usable name of the output.">identifier</a>;
cannam@0 104 <a name="l00122"></a>00122
cannam@0 105 <a name="l00124"></a><a class="code" href="struct__VampOutputDescriptor.html#f4fca576bd47167fd2bf9b43d588815f">00124</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampOutputDescriptor.html#f4fca576bd47167fd2bf9b43d588815f" title="Human-readable name of the output.">name</a>;
cannam@0 106 <a name="l00125"></a>00125
cannam@0 107 <a name="l00127"></a><a class="code" href="struct__VampOutputDescriptor.html#bfa911b138cfb80cf63e8f2e0fa0fb89">00127</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampOutputDescriptor.html#bfa911b138cfb80cf63e8f2e0fa0fb89" title="Human-readable short text about the output.">description</a>;
cannam@0 108 <a name="l00128"></a>00128
cannam@0 109 <a name="l00130"></a><a class="code" href="struct__VampOutputDescriptor.html#d038caa8e596dfd037035637202f1d63">00130</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampOutputDescriptor.html#d038caa8e596dfd037035637202f1d63" title="Human-readable name of the unit of the output.">unit</a>;
cannam@0 110 <a name="l00131"></a>00131
cannam@0 111 <a name="l00133"></a><a class="code" href="struct__VampOutputDescriptor.html#e8571f5a2bc740738af0cb7dda0c4749">00133</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampOutputDescriptor.html#e8571f5a2bc740738af0cb7dda0c4749" title="1 if output has equal number of values for each returned result.">hasFixedBinCount</a>;
cannam@0 112 <a name="l00134"></a>00134
cannam@0 113 <a name="l00136"></a><a class="code" href="struct__VampOutputDescriptor.html#652ee422092720e44d23d98bdb68f978">00136</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampOutputDescriptor.html#652ee422092720e44d23d98bdb68f978" title="Number of values per result, if hasFixedBinCount.">binCount</a>;
cannam@0 114 <a name="l00137"></a>00137
cannam@0 115 <a name="l00139"></a><a class="code" href="struct__VampOutputDescriptor.html#10fffaa32bd894843ff7592240dfe447">00139</a> <span class="keyword">const</span> <span class="keywordtype">char</span> **<a class="code" href="struct__VampOutputDescriptor.html#10fffaa32bd894843ff7592240dfe447" title="Names of returned value bins, if hasFixedBinCount.">binNames</a>;
cannam@0 116 <a name="l00140"></a>00140
cannam@0 117 <a name="l00142"></a><a class="code" href="struct__VampOutputDescriptor.html#f6b512d772023b4e852216689c1c4465">00142</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampOutputDescriptor.html#f6b512d772023b4e852216689c1c4465" title="1 if each returned value falls within the same fixed min/max range.">hasKnownExtents</a>;
cannam@0 118 <a name="l00143"></a>00143
cannam@0 119 <a name="l00145"></a><a class="code" href="struct__VampOutputDescriptor.html#9a28180989e3d028c12a98517479dc46">00145</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampOutputDescriptor.html#9a28180989e3d028c12a98517479dc46" title="Minimum value for a returned result in any bin, if hasKnownExtents.">minValue</a>;
cannam@0 120 <a name="l00146"></a>00146
cannam@0 121 <a name="l00148"></a><a class="code" href="struct__VampOutputDescriptor.html#4cbe540a247df60f85b00b2aa16461ee">00148</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampOutputDescriptor.html#4cbe540a247df60f85b00b2aa16461ee" title="Maximum value for a returned result in any bin, if hasKnownExtents.">maxValue</a>;
cannam@0 122 <a name="l00149"></a>00149
cannam@0 123 <a name="l00151"></a><a class="code" href="struct__VampOutputDescriptor.html#b56cf0bbb17136819024574d5cc65e30">00151</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampOutputDescriptor.html#b56cf0bbb17136819024574d5cc65e30" title="1 if returned results are quantized to a particular resolution.">isQuantized</a>;
cannam@0 124 <a name="l00152"></a>00152
cannam@0 125 <a name="l00154"></a><a class="code" href="struct__VampOutputDescriptor.html#71aa40222dda4321030cccd0bb655fe3">00154</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampOutputDescriptor.html#71aa40222dda4321030cccd0bb655fe3" title="Quantization resolution for returned results, if isQuantized.">quantizeStep</a>;
cannam@0 126 <a name="l00155"></a>00155
cannam@0 127 <a name="l00157"></a><a class="code" href="struct__VampOutputDescriptor.html#5da1d27cc99badc214640e859b882072">00157</a> <a class="code" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> <a class="code" href="struct__VampOutputDescriptor.html#5da1d27cc99badc214640e859b882072" title="Time positioning method for returned results (see VampSampleType).">sampleType</a>;
cannam@0 128 <a name="l00158"></a>00158
cannam@0 129 <a name="l00161"></a><a class="code" href="struct__VampOutputDescriptor.html#1ccf193317b2b9c2eb0dbd8dcf61d26e">00161</a> <span class="keywordtype">float</span> <a class="code" href="struct__VampOutputDescriptor.html#1ccf193317b2b9c2eb0dbd8dcf61d26e" title="Sample rate of returned results, if sampleType is vampFixedSampleRate.">sampleRate</a>;
cannam@0 130 <a name="l00162"></a>00162
cannam@0 131 <a name="l00163"></a>00163 } <a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a>;
cannam@0 132 <a name="l00164"></a>00164
cannam@0 133 <a name="l00165"></a><a class="code" href="struct__VampFeature.html">00165</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampFeature.html">_VampFeature</a>
cannam@0 134 <a name="l00166"></a>00166 {
cannam@0 135 <a name="l00168"></a><a class="code" href="struct__VampFeature.html#be6aa7a08185beeb9deca2d08d99859f">00168</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#be6aa7a08185beeb9deca2d08d99859f" title="1 if the feature has a timestamp (i.e.">hasTimestamp</a>;
cannam@0 136 <a name="l00169"></a>00169
cannam@0 137 <a name="l00171"></a><a class="code" href="struct__VampFeature.html#31f0b57050e33d082692536097953d9c">00171</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#31f0b57050e33d082692536097953d9c" title="Seconds component of timestamp.">sec</a>;
cannam@0 138 <a name="l00172"></a>00172
cannam@0 139 <a name="l00174"></a><a class="code" href="struct__VampFeature.html#8874cb23600c6b10ca6e8a40920d999e">00174</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#8874cb23600c6b10ca6e8a40920d999e" title="Nanoseconds component of timestamp.">nsec</a>;
cannam@0 140 <a name="l00175"></a>00175
cannam@0 141 <a name="l00177"></a><a class="code" href="struct__VampFeature.html#b1ce7c8a2b489e9b0694a967497a29fd">00177</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeature.html#b1ce7c8a2b489e9b0694a967497a29fd" title="Number of values.">valueCount</a>;
cannam@0 142 <a name="l00178"></a>00178
cannam@0 143 <a name="l00180"></a><a class="code" href="struct__VampFeature.html#e4030f941ddb2bab8bc147b88e1f1c15">00180</a> <span class="keywordtype">float</span> *<a class="code" href="struct__VampFeature.html#e4030f941ddb2bab8bc147b88e1f1c15" title="Values for this returned sample.">values</a>;
cannam@0 144 <a name="l00181"></a>00181
cannam@0 145 <a name="l00183"></a><a class="code" href="struct__VampFeature.html#6662b7489a7890cae713bf4e8f6d52cd">00183</a> <span class="keywordtype">char</span> *<a class="code" href="struct__VampFeature.html#6662b7489a7890cae713bf4e8f6d52cd" title="Label for this returned sample.">label</a>;
cannam@0 146 <a name="l00184"></a>00184
cannam@0 147 <a name="l00185"></a>00185 } <a class="code" href="struct__VampFeature.html">VampFeature</a>;
cannam@0 148 <a name="l00186"></a>00186
cannam@0 149 <a name="l00187"></a><a class="code" href="struct__VampFeatureList.html">00187</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampFeatureList.html">_VampFeatureList</a>
cannam@0 150 <a name="l00188"></a>00188 {
cannam@0 151 <a name="l00190"></a><a class="code" href="struct__VampFeatureList.html#01db33a31ae5e04a4bd097f4b6aa75f1">00190</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampFeatureList.html#01db33a31ae5e04a4bd097f4b6aa75f1" title="Number of features in this feature list.">featureCount</a>;
cannam@0 152 <a name="l00191"></a>00191
cannam@0 153 <a name="l00193"></a><a class="code" href="struct__VampFeatureList.html#a2d18873fd5e58354460ea77fc48692f">00193</a> <a class="code" href="struct__VampFeature.html">VampFeature</a> *<a class="code" href="struct__VampFeatureList.html#a2d18873fd5e58354460ea77fc48692f" title="Features in this feature list.">features</a>;
cannam@0 154 <a name="l00194"></a>00194
cannam@0 155 <a name="l00195"></a>00195 } <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a>;
cannam@0 156 <a name="l00196"></a>00196
cannam@0 157 <a name="l00197"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">00197</a> <span class="keyword">typedef</span> <span class="keyword">enum</span>
cannam@0 158 <a name="l00198"></a>00198 {
cannam@0 159 <a name="l00199"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1">00199</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1">vampTimeDomain</a>,
cannam@0 160 <a name="l00200"></a><a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d">00200</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a>
cannam@0 161 <a name="l00201"></a>00201
cannam@0 162 <a name="l00202"></a>00202 } <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a>;
cannam@0 163 <a name="l00203"></a>00203
cannam@0 164 <a name="l00204"></a><a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">00204</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>;
cannam@0 165 <a name="l00205"></a>00205
cannam@0 166 <a name="l00206"></a><a class="code" href="struct__VampPluginDescriptor.html">00206</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a>
cannam@0 167 <a name="l00207"></a>00207 {
cannam@0 168 <a name="l00209"></a><a class="code" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2">00209</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2" title="API version with which this descriptor is compatible.">vampApiVersion</a>;
cannam@0 169 <a name="l00210"></a>00210
cannam@0 170 <a name="l00212"></a><a class="code" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219">00212</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219" title="Computer-usable name of the plugin.">identifier</a>;
cannam@0 171 <a name="l00213"></a>00213
cannam@0 172 <a name="l00215"></a><a class="code" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150">00215</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150" title="Human-readable name of the plugin.">name</a>;
cannam@0 173 <a name="l00216"></a>00216
cannam@0 174 <a name="l00218"></a><a class="code" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e">00218</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e" title="Human-readable short text about the plugin.">description</a>;
cannam@0 175 <a name="l00219"></a>00219
cannam@0 176 <a name="l00221"></a><a class="code" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b">00221</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b" title="Human-readable name of plugin&amp;#39;s author or vendor.">maker</a>;
cannam@0 177 <a name="l00222"></a>00222
cannam@0 178 <a name="l00224"></a><a class="code" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae">00224</a> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae" title="Version number of the plugin.">pluginVersion</a>;
cannam@0 179 <a name="l00225"></a>00225
cannam@0 180 <a name="l00227"></a><a class="code" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521">00227</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521" title="Human-readable summary of copyright or licensing for plugin.">copyright</a>;
cannam@0 181 <a name="l00228"></a>00228
cannam@0 182 <a name="l00230"></a><a class="code" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab">00230</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab" title="Number of parameter inputs.">parameterCount</a>;
cannam@0 183 <a name="l00231"></a>00231
cannam@0 184 <a name="l00233"></a><a class="code" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913">00233</a> <span class="keyword">const</span> <a class="code" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins.">VampParameterDescriptor</a> **<a class="code" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913" title="Fixed descriptors for parameter inputs.">parameters</a>;
cannam@0 185 <a name="l00234"></a>00234
cannam@0 186 <a name="l00236"></a><a class="code" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00">00236</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00" title="Number of programs.">programCount</a>;
cannam@0 187 <a name="l00237"></a>00237
cannam@0 188 <a name="l00239"></a><a class="code" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec">00239</a> <span class="keyword">const</span> <span class="keywordtype">char</span> **<a class="code" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec" title="Fixed names for programs.">programs</a>;
cannam@0 189 <a name="l00240"></a>00240
cannam@0 190 <a name="l00242"></a><a class="code" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4">00242</a> <a class="code" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a> <a class="code" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4" title="Preferred input domain for audio input (time or frequency).">inputDomain</a>;
cannam@0 191 <a name="l00243"></a>00243
cannam@0 192 <a name="l00245"></a>00245 <a class="code" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> (*<a class="code" href="struct__VampPluginDescriptor.html#19c4ce36fdeb88eeedb539efc544b8ee" title="Create and return a new instance of this plugin.">instantiate</a>)(<span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *,
cannam@0 193 <a name="l00246"></a>00246 <span class="keywordtype">float</span> inputSampleRate);
cannam@0 194 <a name="l00247"></a>00247
cannam@0 195 <a name="l00249"></a>00249 void (*<a class="code" href="struct__VampPluginDescriptor.html#0e4522c33e59c3c518b9262f2477bc27" title="Destroy an instance of this plugin.">cleanup</a>)(VampPluginHandle);
cannam@0 196 <a name="l00250"></a>00250
cannam@0 197 <a name="l00252"></a>00252 int (*<a class="code" href="struct__VampPluginDescriptor.html#d0978f17a5e568079470a1978a9aad22" title="Initialise an instance following parameter configuration.">initialise</a>)(VampPluginHandle,
cannam@0 198 <a name="l00253"></a>00253 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> inputChannels,
cannam@0 199 <a name="l00254"></a>00254 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stepSize,
cannam@0 200 <a name="l00255"></a>00255 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> blockSize);
cannam@0 201 <a name="l00256"></a>00256
cannam@0 202 <a name="l00258"></a>00258 void (*<a class="code" href="struct__VampPluginDescriptor.html#12267f6b506aeda3792ff7c982b02336" title="Reset an instance, ready to use again on new input data.">reset</a>)(VampPluginHandle);
cannam@0 203 <a name="l00259"></a>00259
cannam@0 204 <a name="l00261"></a>00261 float (*<a class="code" href="struct__VampPluginDescriptor.html#07174981875b55ee2ec7521a7f4fc395" title="Get a parameter value.">getParameter</a>)(VampPluginHandle, int);
cannam@0 205 <a name="l00262"></a>00262
cannam@0 206 <a name="l00264"></a>00264 void (*<a class="code" href="struct__VampPluginDescriptor.html#ad3cfc7a3b432df40bd9db13eee6a481" title="Set a parameter value.">setParameter</a>)(VampPluginHandle, int, float);
cannam@0 207 <a name="l00265"></a>00265
cannam@0 208 <a name="l00267"></a>00267 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#861a77525a95d424cb846820b018af53" title="Get the current program (if programCount &amp;gt; 0).">getCurrentProgram</a>)(VampPluginHandle);
cannam@0 209 <a name="l00268"></a>00268
cannam@0 210 <a name="l00270"></a>00270 void (*<a class="code" href="struct__VampPluginDescriptor.html#d9af40cb165ca187e49250964af5f5cf" title="Set the current program.">selectProgram</a>)(VampPluginHandle, <span class="keywordtype">unsigned</span> int);
cannam@0 211 <a name="l00271"></a>00271
cannam@0 212 <a name="l00273"></a>00273 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#2beddf2ce156c05dd24477ac663adcbb" title="Get the plugin&amp;#39;s preferred processing window increment in samples.">getPreferredStepSize</a>)(VampPluginHandle);
cannam@0 213 <a name="l00274"></a>00274
cannam@0 214 <a name="l00276"></a>00276 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#c626e42554ab1532c8d8b5132a0faee8" title="Get the plugin&amp;#39;s preferred processing window size in samples.">getPreferredBlockSize</a>)(VampPluginHandle);
cannam@0 215 <a name="l00277"></a>00277
cannam@0 216 <a name="l00279"></a>00279 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#f175ca17716db5a7545b61b01caabd92" title="Get the minimum number of input channels this plugin can handle.">getMinChannelCount</a>)(VampPluginHandle);
cannam@0 217 <a name="l00280"></a>00280
cannam@0 218 <a name="l00282"></a>00282 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#d1600203418d9646332f5b917284261b" title="Get the maximum number of input channels this plugin can handle.">getMaxChannelCount</a>)(VampPluginHandle);
cannam@0 219 <a name="l00283"></a>00283
cannam@0 220 <a name="l00285"></a>00285 <span class="keywordtype">unsigned</span> int (*<a class="code" href="struct__VampPluginDescriptor.html#a8fc88da704e24b2b5f674821dd380c1" title="Get the number of feature outputs (distinct sets of results).">getOutputCount</a>)(VampPluginHandle);
cannam@0 221 <a name="l00286"></a>00286
cannam@0 222 <a name="l00291"></a>00291 <a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *(*getOutputDescriptor)(VampPluginHandle,
cannam@0 223 <a name="l00292"></a>00292 <span class="keywordtype">unsigned</span> int);
cannam@0 224 <a name="l00293"></a>00293
cannam@0 225 <a name="l00295"></a>00295 void (*<a class="code" href="struct__VampPluginDescriptor.html#8cc38edc921616e67e551aa03397ec79" title="Destroy a descriptor for a feature output.">releaseOutputDescriptor</a>)(<a class="code" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *);
cannam@0 226 <a name="l00296"></a>00296
cannam@0 227 <a name="l00302"></a>00302 <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *(*process)(VampPluginHandle,
cannam@0 228 <a name="l00303"></a>00303 <span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers,
cannam@0 229 <a name="l00304"></a>00304 <span class="keywordtype">int</span> sec,
cannam@0 230 <a name="l00305"></a>00305 <span class="keywordtype">int</span> nsec);
cannam@0 231 <a name="l00306"></a>00306
cannam@0 232 <a name="l00308"></a>00308 <a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *(*getRemainingFeatures)(VampPluginHandle);
cannam@0 233 <a name="l00309"></a>00309
cannam@0 234 <a name="l00311"></a>00311 void (*<a class="code" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63" title="Release a feature set returned from process or getRemainingFeatures.">releaseFeatureSet</a>)(<a class="code" href="struct__VampFeatureList.html">VampFeatureList</a> *);
cannam@0 235 <a name="l00312"></a>00312
cannam@0 236 <a name="l00313"></a>00313 } <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>;
cannam@0 237 <a name="l00314"></a>00314
cannam@0 238 <a name="l00315"></a>00315
cannam@0 239 <a name="l00334"></a>00334 <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>
cannam@0 240 <a name="l00335"></a>00335 (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hostApiVersion, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index);
cannam@0 241 <a name="l00336"></a>00336
cannam@0 242 <a name="l00337"></a>00337
cannam@0 243 <a name="l00339"></a>00339 <span class="keyword">typedef</span> <span class="keyword">const</span> <a class="code" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *(*VampGetPluginDescriptorFunction)
cannam@0 244 <a name="l00340"></a><a class="code" href="vamp_8h.html#551bb7e0d8c970c2202be5f881817478">00340</a> (<span class="keywordtype">unsigned</span> int, <span class="keywordtype">unsigned</span> int);
cannam@0 245 <a name="l00341"></a>00341
cannam@0 246 <a name="l00342"></a>00342 <span class="preprocessor">#ifdef __cplusplus</span>
cannam@0 247 <a name="l00343"></a>00343 <span class="preprocessor"></span>}
cannam@0 248 <a name="l00344"></a>00344 <span class="preprocessor">#endif</span>
cannam@0 249 <a name="l00345"></a>00345 <span class="preprocessor"></span>
cannam@0 250 <a name="l00346"></a>00346 <span class="preprocessor">#endif</span>
cannam@0 251 </pre></div></div>
cannam@0 252 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by&nbsp;
cannam@0 253 <a href="http://www.doxygen.org/index.html">
cannam@0 254 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
cannam@0 255 </body>
cannam@0 256 </html>