Mercurial > hg > vamp-website

comparison code-doc/annotated.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents cc0be37dc9d3
children 8260c0f4e05b
comparison
equal deleted inserted replaced
34:4b4db9230e94 35:0976232e353b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Class List</title> 3 <title>VampPluginSDK: Class List</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css">
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.6 --> 7 <!-- Generated by Doxygen 1.5.8 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
32 <tr><td class="indexkey"><a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a></td><td class="indexvalue"></td></tr> 32 <tr><td class="indexkey"><a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a></td><td class="indexvalue"></td></tr>
33 <tr><td class="indexkey"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></td><td class="indexvalue">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins </td></tr> 33 <tr><td class="indexkey"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></td><td class="indexvalue">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins </td></tr>
34 <tr><td class="indexkey"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></td><td class="indexvalue"></td></tr> 34 <tr><td class="indexkey"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></td><td class="indexvalue"></td></tr>
35 <tr><td class="indexkey"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a></td><td class="indexvalue">Example plugin implementing the SuperCollider amplitude follower function </td></tr> 35 <tr><td class="indexkey"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a></td><td class="indexvalue">Example plugin implementing the SuperCollider amplitude follower function </td></tr>
36 <tr><td class="indexkey"><a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a></td><td class="indexvalue">Example plugin that estimates the tempo of a short fixed-tempo sample </td></tr> 36 <tr><td class="indexkey"><a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a></td><td class="indexvalue">Example plugin that estimates the tempo of a short fixed-tempo sample </td></tr>
37 <tr><td class="indexkey"><a class="el" href="classFixedTempoEstimator_1_1D.html">FixedTempoEstimator::D</a></td><td class="indexvalue"></td></tr> 37 <tr><td class="indexkey"><a class="el" href="classFixedTempoEstimator_1_1D.html">FixedTempoEstimator::FixedTempoEstimator::D</a></td><td class="indexvalue"></td></tr>
38 <tr><td class="indexkey"><a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a></td><td class="indexvalue">Example plugin that detects percussive events </td></tr> 38 <tr><td class="indexkey"><a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a></td><td class="indexvalue">Example plugin that detects percussive events </td></tr>
39 <tr><td class="indexkey"><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> is a base class for plugin instance classes that provide feature extraction from audio or related data </td></tr> 39 <tr><td class="indexkey"><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> is a base class for plugin instance classes that provide feature extraction from audio or related data </td></tr>
40 <tr><td class="indexkey"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Vamp::Plugin::Feature</a></td><td class="indexvalue"></td></tr> 40 <tr><td class="indexkey"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Vamp::Plugin::Plugin::Feature</a></td><td class="indexvalue"></td></tr>
41 <tr><td class="indexkey"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">Vamp::Plugin::OutputDescriptor</a></td><td class="indexvalue"></td></tr> 41 <tr><td class="indexkey"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">Vamp::Plugin::Plugin::OutputDescriptor</a></td><td class="indexvalue"></td></tr>
42 <tr><td class="indexkey"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter&lt; P &gt;</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation </td></tr> 42 <tr><td class="indexkey"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter&lt; P &gt;</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation </td></tr>
43 <tr><td class="indexkey"><a class="el" href="classVamp_1_1PluginAdapterBase.html">Vamp::PluginAdapterBase</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API </td></tr> 43 <tr><td class="indexkey"><a class="el" href="classVamp_1_1PluginAdapterBase.html">Vamp::PluginAdapterBase</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API </td></tr>
44 <tr><td class="indexkey"><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td class="indexvalue">A base class for plugins with optional configurable parameters, programs, etc </td></tr> 44 <tr><td class="indexkey"><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td class="indexvalue">A base class for plugins with optional configurable parameters, programs, etc </td></tr>
45 <tr><td class="indexkey"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">Vamp::PluginBase::ParameterDescriptor</a></td><td class="indexvalue"></td></tr> 45 <tr><td class="indexkey"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">Vamp::PluginBase::PluginBase::ParameterDescriptor</a></td><td class="indexvalue"></td></tr>
46 <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">Vamp::HostExt::PluginBufferingAdapter</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size </td></tr> 46 <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">Vamp::HostExt::PluginBufferingAdapter</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size </td></tr>
47 <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html">Vamp::HostExt::PluginChannelAdapter</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data </td></tr> 47 <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html">Vamp::HostExt::PluginChannelAdapter</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data </td></tr>
48 <tr><td class="indexkey"><a class="el" href="classVamp_1_1PluginHostAdapter.html">Vamp::PluginHostAdapter</a></td><td class="indexvalue"><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...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> object </td></tr> 48 <tr><td class="indexkey"><a class="el" href="classVamp_1_1PluginHostAdapter.html">Vamp::PluginHostAdapter</a></td><td class="indexvalue"><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...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> object </td></tr>
49 <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html">Vamp::HostExt::PluginInputDomainAdapter</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that converts time-domain input into frequency-domain input for plugins that need it </td></tr> 49 <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html">Vamp::HostExt::PluginInputDomainAdapter</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that converts time-domain input into frequency-domain input for plugins that need it </td></tr>
50 <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">Vamp::HostExt::PluginLoader</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">Vamp::HostExt::PluginLoader</a> is a convenience class for discovering and loading <a class="el" href="namespaceVamp.html">Vamp</a> plugins using the typical plugin-path, library naming, and categorisation conventions described in the <a class="el" href="namespaceVamp.html">Vamp</a> SDK documentation </td></tr> 50 <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">Vamp::HostExt::PluginLoader</a></td><td class="indexvalue"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">Vamp::HostExt::PluginLoader</a> is a convenience class for discovering and loading <a class="el" href="namespaceVamp.html">Vamp</a> plugins using the typical plugin-path, library naming, and categorisation conventions described in the <a class="el" href="namespaceVamp.html">Vamp</a> SDK documentation </td></tr>
54 <tr><td class="indexkey"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a></td><td class="indexvalue"><a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions </td></tr> 54 <tr><td class="indexkey"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a></td><td class="indexvalue"><a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions </td></tr>
55 <tr><td class="indexkey"><a class="el" href="classSpectralCentroid.html">SpectralCentroid</a></td><td class="indexvalue">Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio </td></tr> 55 <tr><td class="indexkey"><a class="el" href="classSpectralCentroid.html">SpectralCentroid</a></td><td class="indexvalue">Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio </td></tr>
56 <tr><td class="indexkey"><a class="el" href="classZeroCrossing.html">ZeroCrossing</a></td><td class="indexvalue">Example plugin that calculates the positions and density of zero-crossing points in an audio waveform </td></tr> 56 <tr><td class="indexkey"><a class="el" href="classZeroCrossing.html">ZeroCrossing</a></td><td class="indexvalue">Example plugin that calculates the positions and density of zero-crossing points in an audio waveform </td></tr>
57 </table> 57 </table>
58 </div> 58 </div>
59 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp; 59 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
60 <a href="http://www.doxygen.org/index.html"> 60 <a href="http://www.doxygen.org/index.html">
61 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> 61 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
62 </body> 62 </body>
63 </html> 63 </html>