Mercurial > hg > vamp-website

comparison code-doc/namespaceVamp.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
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: Vamp Namespace Reference</title> 3 <title>VampPluginSDK: Vamp Namespace Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.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.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
21 <li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li> 21 <li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li>
22 </ul> 22 </ul>
23 </div> 23 </div>
24 </div> 24 </div>
25 <div class="contents"> 25 <div class="contents">
26 <h1>Vamp Namespace Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> 26 <h1>Vamp Namespace Reference</h1>
27 If you want to compile using FFTW instead of the built-in FFT implementation for the PluginInputDomainAdapter, define HAVE_FFTW3 in the Makefile.
28 <p>
29 Be aware that FFTW is licensed under the GPL -- unlike this SDK, which is provided under a more liberal BSD license in order to permit use in closed source applications. The use of FFTW would mean that your code would need to be licensed under the GPL as well. Do not define this symbol unless you understand and accept the implications of this.<p>
30 Parties such as Linux distribution packagers who redistribute this SDK for use in other programs should _not_ define this symbol, as it would change the effective licensing terms under which the SDK was available to third party developers.<p>
31 The default is not to use FFTW, and to use the built-in FFT instead.<p>
32 Note: The FFTW code uses FFTW_MEASURE, and so will perform badly on its first invocation unless the host has saved and restored FFTW wisdom (see the FFTW documentation).
33 <p> 27 <p>
34 28
35 <p> 29 <p>
36 <table border="0" cellpadding="0" cellspacing="0"> 30 <table border="0" cellpadding="0" cellspacing="0">
37 <tr><td></td></tr> 31 <tr><td></td></tr>
39 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></td></tr> 33 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></td></tr>
40 34
41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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. <a href="classVamp_1_1Plugin.html#_details">More...</a><br></td></tr> 35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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. <a href="classVamp_1_1Plugin.html#_details">More...</a><br></td></tr>
42 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a></td></tr> 36 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a></td></tr>
43 37
44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> C API. <a href="classVamp_1_1PluginAdapterBase.html#_details">More...</a><br></td></tr> 38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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. <a href="classVamp_1_1PluginAdapterBase.html#_details">More...</a><br></td></tr>
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a></td></tr> 39 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a></td></tr>
46 40
47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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. <a href="classVamp_1_1PluginAdapter.html#_details">More...</a><br></td></tr> 41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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. <a href="classVamp_1_1PluginAdapter.html#_details">More...</a><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a></td></tr> 42 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a></td></tr>
49 43
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A base class for plugins with optional configurable parameters, programs, etc. <a href="classVamp_1_1PluginBase.html#_details">More...</a><br></td></tr> 44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A base class for plugins with optional configurable parameters, programs, etc. <a href="classVamp_1_1PluginBase.html#_details">More...</a><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a></td></tr>
52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">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. <a href="classVamp_1_1PluginHostAdapter.html#_details">More...</a><br></td></tr>
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a></td></tr> 45 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a></td></tr>
55 46
56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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. <a href="structVamp_1_1RealTime.html#_details">More...</a><br></td></tr> 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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. <a href="structVamp_1_1RealTime.html#_details">More...</a><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a></td></tr>
49
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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. <a href="classVamp_1_1PluginHostAdapter.html#_details">More...</a><br></td></tr>
57 <tr><td colspan="2"><br><h2>Namespaces</h2></td></tr> 51 <tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></td></tr> 52 <tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></td></tr>
59 53
60 <tr><td colspan="2"><br><h2>Functions</h2></td></tr> 54 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html#84f347b339c111e035f4f0d6ed37f4e0">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;rt)</td></tr> 55 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html#85842d554b6abf7bf9ff648b70f39fef">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;rt)</td></tr>
62 56
63 </table> 57 </table>
64 <hr><h2>Function Documentation</h2> 58 <hr><h2>Function Documentation</h2>
65 <a class="anchor" name="84f347b339c111e035f4f0d6ed37f4e0"></a><!-- doxytag: member="Vamp::operator&lt;&lt;" ref="84f347b339c111e035f4f0d6ed37f4e0" args="(std::ostream &amp;out, const RealTime &amp;rt)" --> 59 <a class="anchor" name="85842d554b6abf7bf9ff648b70f39fef"></a><!-- doxytag: member="Vamp::operator&lt;&lt;" ref="85842d554b6abf7bf9ff648b70f39fef" args="(std::ostream &amp;out, const RealTime &amp;rt)" -->
66 <div class="memitem"> 60 <div class="memitem">
67 <div class="memproto"> 61 <div class="memproto">
68 <table class="memname"> 62 <table class="memname">
69 <tr> 63 <tr>
70 <td class="memname">std::ostream &amp; Vamp::operator&lt;&lt; </td> 64 <td class="memname">std::ostream&amp; Vamp::operator&lt;&lt; </td>
71 <td>(</td> 65 <td>(</td>
72 <td class="paramtype">std::ostream &amp;&nbsp;</td> 66 <td class="paramtype">std::ostream &amp;&nbsp;</td>
73 <td class="paramname"> <em>out</em>, </td> 67 <td class="paramname"> <em>out</em>, </td>
74 </tr> 68 </tr>
75 <tr> 69 <tr>
79 <td class="paramname"> <em>rt</em></td><td>&nbsp;</td> 73 <td class="paramname"> <em>rt</em></td><td>&nbsp;</td>
80 </tr> 74 </tr>
81 <tr> 75 <tr>
82 <td></td> 76 <td></td>
83 <td>)</td> 77 <td>)</td>
84 <td></td><td></td><td width="100%"></td> 78 <td></td><td></td><td></td>
85 </tr> 79 </tr>
86 </table> 80 </table>
87 </div> 81 </div>
88 <div class="memdoc"> 82 <div class="memdoc">
89 83
90 <p> 84 <p>
91 85
92 <p>Definition at line <a class="el" href="RealTime_8cpp-source.html#l00110">110</a> of file <a class="el" href="RealTime_8cpp-source.html">RealTime.cpp</a>.</p>
93
94 <p>References <a class="el" href="RealTime_8h-source.html#l00066">Vamp::RealTime::nsec</a>, <a class="el" href="RealTime_8cpp-source.html#l00073">ONE_BILLION</a>, <a class="el" href="RealTime_8h-source.html#l00065">Vamp::RealTime::sec</a>, and <a class="el" href="RealTime_8h-source.html#l00155">Vamp::RealTime::zeroTime</a>.</p>
95
96 </div> 86 </div>
97 </div><p> 87 </div><p>
98 </div> 88 </div>
99 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:09 2008 for VampPluginSDK by&nbsp; 89 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:20 2008 for VampPluginSDK by&nbsp;
100 <a href="http://www.doxygen.org/index.html"> 90 <a href="http://www.doxygen.org/index.html">
101 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 91 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
102 </body> 92 </body>
103 </html> 93 </html>