Mercurial > hg > vamp-docs

comparison code-docs/index.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
comparison
equal deleted inserted replaced
2:52d16fb98e80 3:5c2683745b33
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
5 <title>VampPluginSDK: Vamp Plugin SDK</title> 6 <title>VampPluginSDK: Vamp Plugin SDK</title>
6 7
7 <link href="tabs.css" rel="stylesheet" type="text/css"/> 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/> 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
26 <tr style="height: 56px;"> 27 <tr style="height: 56px;">
27 28
28 29
29 <td style="padding-left: 0.5em;"> 30 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK 31 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span> 32 &#160;<span id="projectnumber">2.4</span>
32 </div> 33 </div>
33 34
34 </td> 35 </td>
35 36
36 37
38 </tr> 39 </tr>
39 </tbody> 40 </tbody>
40 </table> 41 </table>
41 </div> 42 </div>
42 43
43 <!-- Generated by Doxygen 1.7.5.1 --> 44 <!-- Generated by Doxygen 1.8.0 -->
44 <div id="navrow1" class="tabs"> 45 <div id="navrow1" class="tabs">
45 <ul class="tablist"> 46 <ul class="tablist">
46 <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li> 47 <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li><a href="annotated.html"><span>Classes</span></a></li> 49 <li><a href="annotated.html"><span>Classes</span></a></li>
65 </script> 66 </script>
66 <div id="doc-content"> 67 <div id="doc-content">
67 <div class="header"> 68 <div class="header">
68 <div class="headertitle"> 69 <div class="headertitle">
69 <div class="title"><a class="el" href="namespaceVamp.html">Vamp</a> Plugin SDK </div> </div> 70 <div class="title"><a class="el" href="namespaceVamp.html">Vamp</a> Plugin SDK </div> </div>
70 </div> 71 </div><!--header-->
71 <div class="contents"> 72 <div class="contents">
72 <div class="textblock"><h2><a class="anchor" id="about"></a> 73 <div class="textblock"><h2><a class="anchor" id="about"></a>
73 About Vamp</h2> 74 About Vamp</h2>
74 <p><a class="el" href="namespaceVamp.html">Vamp</a> is an API for C and C++ plugins that process sampled audio data to produce descriptive output (measurements or semantic observations). Find more information at <a href="http://www.vamp-plugins.org/">http://www.vamp-plugins.org/</a> .</p> 75 <p><a class="el" href="namespaceVamp.html">Vamp</a> is an API for C and C++ plugins that process sampled audio data to produce descriptive output (measurements or semantic observations). Find more information at <a href="http://www.vamp-plugins.org/">http://www.vamp-plugins.org/</a> .</p>
75 <p>Although the official API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins is defined in C for maximum binary compatibility, we strongly recommend using the provided C++ classes in the SDK to implement your own plugins and hosts.</p> 76 <p>Although the official API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins is defined in C for maximum binary compatibility, we strongly recommend using the provided C++ classes in the SDK to implement your own plugins and hosts.</p>
96 using Percussive Feature Detection and Spectral Modulation" by Dan Barry, Derry Fitzgerald, Eugene Coyle and Bob Lawlor, ISSC 2005.</li> 97 using Percussive Feature Detection and Spectral Modulation" by Dan Barry, Derry Fitzgerald, Eugene Coyle and Bob Lawlor, ISSC 2005.</li>
97 </ul> 98 </ul>
98 <ul> 99 <ul>
99 <li><a class="el" href="classFixedTempoEstimator.html" title="Example plugin that estimates the tempo of a short fixed-tempo sample.">FixedTempoEstimator</a> calculates a single beats-per-minute value which is an estimate of the tempo of a piece of music that is assumed to be of fixed tempo, using autocorrelation of a frequency domain energy rise metric. It has several outputs that return intermediate results used in the calculation, and may be a useful example of a plugin having several outputs with varying feature structures.</li> 100 <li><a class="el" href="classFixedTempoEstimator.html" title="Example plugin that estimates the tempo of a short fixed-tempo sample.">FixedTempoEstimator</a> calculates a single beats-per-minute value which is an estimate of the tempo of a piece of music that is assumed to be of fixed tempo, using autocorrelation of a frequency domain energy rise metric. It has several outputs that return intermediate results used in the calculation, and may be a useful example of a plugin having several outputs with varying feature structures.</li>
100 </ul> 101 </ul>
102 <p>Plugin authors should also read the Programmer's Guide at <a href="http://vamp-plugins.org/guide.pdf">http://vamp-plugins.org/guide.pdf</a> .</p>
101 <h2><a class="anchor" id="hosts"></a> 103 <h2><a class="anchor" id="hosts"></a>
102 For Hosts</h2> 104 For Hosts</h2>
103 <p>Hosts will normally use a <a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...">Vamp::PluginHostAdapter</a> to convert each plugin's exposed C API back into a useful <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> C++ object.</p> 105 <p>Hosts will normally use a <a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...">Vamp::PluginHostAdapter</a> to convert each plugin's exposed C API back into a useful <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> C++ object.</p>
104 <p>The <a class="el" href="namespaceVamp_1_1HostExt.html">Vamp::HostExt</a> namespace contains several additional C++ classes to do this work for them, and make the host's life easier:</p> 106 <p>The <a class="el" href="namespaceVamp_1_1HostExt.html">Vamp::HostExt</a> namespace contains several additional C++ classes to do this work for them, and make the host's life easier:</p>
105 <ul> 107 <ul>
127 <div class="fragment"><pre class="fragment">vamp:pluginlibrary:pluginname::General Category &gt; Specific Category 129 <div class="fragment"><pre class="fragment">vamp:pluginlibrary:pluginname::General Category &gt; Specific Category
128 </pre></div><p>which a host may read and use to assign plugins a location within a category tree for display to the user. The expectation is that advanced users may also choose to set up their own preferred category trees, which is why this information is not queried as part of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin's API itself. The <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">Vamp::HostExt::PluginLoader</a> class also provides support for plugin category lookup using this scheme.</p> 130 </pre></div><p>which a host may read and use to assign plugins a location within a category tree for display to the user. The expectation is that advanced users may also choose to set up their own preferred category trees, which is why this information is not queried as part of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin's API itself. The <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">Vamp::HostExt::PluginLoader</a> class also provides support for plugin category lookup using this scheme.</p>
129 <h2><a class="anchor" id="license"></a> 131 <h2><a class="anchor" id="license"></a>
130 License</h2> 132 License</h2>
131 <p>This plugin SDK is freely redistributable under a "new-style BSD" licence. See the file COPYING for more details. In short, you may modify and redistribute the SDK and example plugins within any commercial or non-commercial, proprietary or open-source plugin or application under almost any conditions, with no obligation to provide source code, provided you retain the original copyright note. </p> 133 <p>This plugin SDK is freely redistributable under a "new-style BSD" licence. See the file COPYING for more details. In short, you may modify and redistribute the SDK and example plugins within any commercial or non-commercial, proprietary or open-source plugin or application under almost any conditions, with no obligation to provide source code, provided you retain the original copyright note. </p>
132 </div></div> 134 </div></div><!-- contents -->
133 </div> 135 </div>
134 <div id="nav-path" class="navpath"> 136 <div id="nav-path" class="navpath">
135 <ul> 137 <ul>
136 138
137 <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by 139 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
138 <a href="http://www.doxygen.org/index.html"> 140 <a href="http://www.doxygen.org/index.html">
139 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> 141 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
140 </ul> 142 </ul>
141 </div> 143 </div>
142 144
143 145
144 </body> 146 </body>