|
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::HostExt::PluginWrapper Class Reference</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 Page</span></a></li>
|
|
cannam@0
|
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
cannam@0
|
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
cannam@0
|
14 <li><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="tabs">
|
|
cannam@0
|
19 <ul>
|
|
cannam@0
|
20 <li><a href="annotated.html"><span>Class List</span></a></li>
|
|
cannam@0
|
21 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
cannam@0
|
22 <li><a href="functions.html"><span>Class Members</span></a></li>
|
|
cannam@0
|
23 </ul>
|
|
cannam@0
|
24 </div>
|
|
cannam@0
|
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a>
|
|
cannam@0
|
26 </div>
|
|
cannam@0
|
27 </div>
|
|
cannam@0
|
28 <div class="contents">
|
|
cannam@0
|
29 <h1>Vamp::HostExt::PluginWrapper Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginWrapper" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include <<a class="el" href="PluginWrapper_8h-source.html">vamp-sdk/hostext/PluginWrapper.h</a>></code>
|
|
cannam@0
|
30 <p>
|
|
cannam@0
|
31 <div class="dynheader">
|
|
cannam@0
|
32 Inheritance diagram for Vamp::HostExt::PluginWrapper:</div>
|
|
cannam@0
|
33 <div class="dynsection">
|
|
cannam@0
|
34 <p><center><img src="classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginWrapper__inherit__map" alt="Inheritance graph"></center>
|
|
cannam@0
|
35 <map name="Vamp_1_1HostExt_1_1PluginWrapper__inherit__map">
|
|
cannam@0
|
36 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by..." alt="" coords="652,6,903,30"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management..." alt="" coords="655,54,900,78"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input..." alt="" coords="641,102,913,126"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter.html" title="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter" alt="" coords="580,150,975,174"><area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="181,78,280,102"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="5,78,133,102"></map>
|
|
cannam@0
|
37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
|
|
cannam@0
|
38
|
|
cannam@0
|
39 <p>
|
|
cannam@0
|
40 <a href="classVamp_1_1HostExt_1_1PluginWrapper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
cannam@0
|
41 <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> is a simple base class for adapter plugins.
|
|
cannam@0
|
42 <p>
|
|
cannam@0
|
43 It takes a pointer to a "to be wrapped" <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin on construction, and provides implementations of all 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> plugin methods that simply delegate through to the wrapped plugin. A subclass can therefore override only the methods that are meaningful for the particular adapter.<p>
|
|
cannam@0
|
44 <dl class="note" compact><dt><b>Note:</b></dt><dd>This class was introduced in version 1.1 of 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> plugin SDK. </dd></dl>
|
|
cannam@0
|
45
|
|
cannam@0
|
46 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00059">59</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
|
|
cannam@0
|
47 <table border="0" cellpadding="0" cellspacing="0">
|
|
cannam@0
|
48 <tr><td></td></tr>
|
|
cannam@0
|
49 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
|
|
cannam@0
|
50 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
|
|
cannam@0
|
51 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
|
|
cannam@0
|
52 }</td></tr>
|
|
cannam@0
|
53
|
|
cannam@0
|
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
|
|
cannam@0
|
55 < <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
|
|
cannam@0
|
56
|
|
cannam@0
|
57 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
|
|
cannam@0
|
58
|
|
cannam@0
|
59 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map< int, <br>
|
|
cannam@0
|
60 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
|
|
cannam@0
|
61
|
|
cannam@0
|
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
|
|
cannam@0
|
63 < <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
|
|
cannam@0
|
64
|
|
cannam@0
|
65 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
|
|
cannam@0
|
66
|
|
cannam@0
|
67 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
cannam@0
|
68 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7449a364d524de75352a4719fec2e1f5">~PluginWrapper</a> ()</td></tr>
|
|
cannam@0
|
69
|
|
cannam@0
|
70 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
|
|
cannam@0
|
71
|
|
cannam@0
|
72 <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#a5a1f8290d8e9a315695584dcb3ad137"></a><br></td></tr>
|
|
cannam@0
|
73 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr>
|
|
cannam@0
|
74
|
|
cannam@0
|
75 <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#d19cc0614ba41cdc26ef3394c5146fe6"></a><br></td></tr>
|
|
cannam@0
|
76 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#031aa818fd48fd0f4b5e1bf80c032870">getInputDomain</a> () const </td></tr>
|
|
cannam@0
|
77
|
|
cannam@0
|
78 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#031aa818fd48fd0f4b5e1bf80c032870"></a><br></td></tr>
|
|
cannam@0
|
79 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr>
|
|
cannam@0
|
80
|
|
cannam@0
|
81 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get 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> API compatibility level of the plugin. <a href="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr>
|
|
cannam@0
|
82 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr>
|
|
cannam@0
|
83
|
|
cannam@0
|
84 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr>
|
|
cannam@0
|
85 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr>
|
|
cannam@0
|
86
|
|
cannam@0
|
87 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#c70a3265bb25aeb03f6dd8f8a0442088"></a><br></td></tr>
|
|
cannam@0
|
88 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr>
|
|
cannam@0
|
89
|
|
cannam@0
|
90 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#c334f699c0996055942785410d8a065c"></a><br></td></tr>
|
|
cannam@0
|
91 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr>
|
|
cannam@0
|
92
|
|
cannam@0
|
93 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#59d5a2298951b317995675e664b1c7bb"></a><br></td></tr>
|
|
cannam@0
|
94 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr>
|
|
cannam@0
|
95
|
|
cannam@0
|
96 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr>
|
|
cannam@0
|
97 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr>
|
|
cannam@0
|
98
|
|
cannam@0
|
99 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr>
|
|
cannam@0
|
100 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#3b075b8f950b344503f0d27ac0fe332e">getParameterDescriptors</a> () const </td></tr>
|
|
cannam@0
|
101
|
|
cannam@0
|
102 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#3b075b8f950b344503f0d27ac0fe332e"></a><br></td></tr>
|
|
cannam@0
|
103 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr>
|
|
cannam@0
|
104
|
|
cannam@0
|
105 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr>
|
|
cannam@0
|
106 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr>
|
|
cannam@0
|
107
|
|
cannam@0
|
108 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr>
|
|
cannam@0
|
109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#f3abaf717dc4b00cad5770ed6dfa01e1">getPrograms</a> () const </td></tr>
|
|
cannam@0
|
110
|
|
cannam@0
|
111 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#f3abaf717dc4b00cad5770ed6dfa01e1"></a><br></td></tr>
|
|
cannam@0
|
112 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr>
|
|
cannam@0
|
113
|
|
cannam@0
|
114 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
|
|
cannam@0
|
115 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr>
|
|
cannam@0
|
116
|
|
cannam@0
|
117 <tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
|
|
cannam@0
|
118 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr>
|
|
cannam@0
|
119
|
|
cannam@0
|
120 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#0137d93d7019bacc31104836fb4d352e"></a><br></td></tr>
|
|
cannam@0
|
121 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr>
|
|
cannam@0
|
122
|
|
cannam@0
|
123 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr>
|
|
cannam@0
|
124 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr>
|
|
cannam@0
|
125
|
|
cannam@0
|
126 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
|
|
cannam@0
|
127 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
|
|
cannam@0
|
128
|
|
cannam@0
|
129 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
|
|
cannam@0
|
130 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#02c8c01972affeea58b091335e791ace">getOutputDescriptors</a> () const </td></tr>
|
|
cannam@0
|
131
|
|
cannam@0
|
132 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#02c8c01972affeea58b091335e791ace"></a><br></td></tr>
|
|
cannam@0
|
133 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
|
|
cannam@0
|
134
|
|
cannam@0
|
135 <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#fca78043c2843c1d45019983515e23f7"></a><br></td></tr>
|
|
cannam@0
|
136 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#1dce55a75a32b08fc56a52a300d9fcbe">getRemainingFeatures</a> ()</td></tr>
|
|
cannam@0
|
137
|
|
cannam@0
|
138 <tr><td class="mdescLeft"> </td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#1dce55a75a32b08fc56a52a300d9fcbe"></a><br></td></tr>
|
|
cannam@0
|
139 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
|
|
cannam@0
|
140
|
|
cannam@0
|
141 <tr><td class="mdescLeft"> </td><td class="mdescRight">Used to distinguish between <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> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
|
|
cannam@0
|
142 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
|
|
cannam@0
|
143 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#35cc2d42f8322f5022e89859a79c97be">PluginWrapper</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
|
|
cannam@0
|
144
|
|
cannam@0
|
145 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
|
|
cannam@0
|
146 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
|
|
cannam@0
|
147
|
|
cannam@0
|
148 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
|
|
cannam@0
|
149
|
|
cannam@0
|
150 </table>
|
|
cannam@0
|
151 <hr><h2>Member Typedef Documentation</h2>
|
|
cannam@0
|
152 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
|
|
cannam@0
|
153 <div class="memitem">
|
|
cannam@0
|
154 <div class="memproto">
|
|
cannam@0
|
155 <table class="memname">
|
|
cannam@0
|
156 <tr>
|
|
cannam@0
|
157 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>> <a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
158 </tr>
|
|
cannam@0
|
159 </table>
|
|
cannam@0
|
160 </div>
|
|
cannam@0
|
161 <div class="memdoc">
|
|
cannam@0
|
162
|
|
cannam@0
|
163 <p>
|
|
cannam@0
|
164
|
|
cannam@0
|
165 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00309">309</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
|
|
cannam@0
|
166
|
|
cannam@0
|
167 </div>
|
|
cannam@0
|
168 </div><p>
|
|
cannam@0
|
169 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
|
|
cannam@0
|
170 <div class="memitem">
|
|
cannam@0
|
171 <div class="memproto">
|
|
cannam@0
|
172 <table class="memname">
|
|
cannam@0
|
173 <tr>
|
|
cannam@0
|
174 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>> <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
175 </tr>
|
|
cannam@0
|
176 </table>
|
|
cannam@0
|
177 </div>
|
|
cannam@0
|
178 <div class="memdoc">
|
|
cannam@0
|
179
|
|
cannam@0
|
180 <p>
|
|
cannam@0
|
181
|
|
cannam@0
|
182 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
|
|
cannam@0
|
183
|
|
cannam@0
|
184 </div>
|
|
cannam@0
|
185 </div><p>
|
|
cannam@0
|
186 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
|
|
cannam@0
|
187 <div class="memitem">
|
|
cannam@0
|
188 <div class="memproto">
|
|
cannam@0
|
189 <table class="memname">
|
|
cannam@0
|
190 <tr>
|
|
cannam@0
|
191 <td class="memname">typedef std::map<int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>> <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td>
|
|
cannam@0
|
192 </tr>
|
|
cannam@0
|
193 </table>
|
|
cannam@0
|
194 </div>
|
|
cannam@0
|
195 <div class="memdoc">
|
|
cannam@0
|
196
|
|
cannam@0
|
197 <p>
|
|
cannam@0
|
198
|
|
cannam@0
|
199 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00348">348</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
|
|
cannam@0
|
200
|
|
cannam@0
|
201 </div>
|
|
cannam@0
|
202 </div><p>
|
|
cannam@0
|
203 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
|
|
cannam@0
|
204 <div class="memitem">
|
|
cannam@0
|
205 <div class="memproto">
|
|
cannam@0
|
206 <table class="memname">
|
|
cannam@0
|
207 <tr>
|
|
cannam@0
|
208 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>> <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
209 </tr>
|
|
cannam@0
|
210 </table>
|
|
cannam@0
|
211 </div>
|
|
cannam@0
|
212 <div class="memdoc">
|
|
cannam@0
|
213
|
|
cannam@0
|
214 <p>
|
|
cannam@0
|
215
|
|
cannam@0
|
216 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00195">195</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
|
|
cannam@0
|
217
|
|
cannam@0
|
218 </div>
|
|
cannam@0
|
219 </div><p>
|
|
cannam@0
|
220 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
|
|
cannam@0
|
221 <div class="memitem">
|
|
cannam@0
|
222 <div class="memproto">
|
|
cannam@0
|
223 <table class="memname">
|
|
cannam@0
|
224 <tr>
|
|
cannam@0
|
225 <td class="memname">typedef std::vector<std::string> <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
226 </tr>
|
|
cannam@0
|
227 </table>
|
|
cannam@0
|
228 </div>
|
|
cannam@0
|
229 <div class="memdoc">
|
|
cannam@0
|
230
|
|
cannam@0
|
231 <p>
|
|
cannam@0
|
232
|
|
cannam@0
|
233 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00217">217</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
|
|
cannam@0
|
234
|
|
cannam@0
|
235 </div>
|
|
cannam@0
|
236 </div><p>
|
|
cannam@0
|
237 <hr><h2>Member Enumeration Documentation</h2>
|
|
cannam@0
|
238 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
|
|
cannam@0
|
239 <div class="memitem">
|
|
cannam@0
|
240 <div class="memproto">
|
|
cannam@0
|
241 <table class="memname">
|
|
cannam@0
|
242 <tr>
|
|
cannam@0
|
243 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
|
|
cannam@0
|
244 </tr>
|
|
cannam@0
|
245 </table>
|
|
cannam@0
|
246 </div>
|
|
cannam@0
|
247 <div class="memdoc">
|
|
cannam@0
|
248
|
|
cannam@0
|
249 <p>
|
|
cannam@0
|
250 <dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
cannam@0
|
251 <table border="0" cellspacing="2" cellpadding="0">
|
|
cannam@0
|
252 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em> </td><td>
|
|
cannam@0
|
253 </td></tr>
|
|
cannam@0
|
254 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td>
|
|
cannam@0
|
255 </td></tr>
|
|
cannam@0
|
256 </table>
|
|
cannam@0
|
257 </dl>
|
|
cannam@0
|
258
|
|
cannam@0
|
259 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00149">149</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
|
|
cannam@0
|
260
|
|
cannam@0
|
261 </div>
|
|
cannam@0
|
262 </div><p>
|
|
cannam@0
|
263 <hr><h2>Constructor & Destructor Documentation</h2>
|
|
cannam@0
|
264 <a class="anchor" name="7449a364d524de75352a4719fec2e1f5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::~PluginWrapper" ref="7449a364d524de75352a4719fec2e1f5" args="()" -->
|
|
cannam@0
|
265 <div class="memitem">
|
|
cannam@0
|
266 <div class="memproto">
|
|
cannam@0
|
267 <table class="memname">
|
|
cannam@0
|
268 <tr>
|
|
cannam@0
|
269 <td class="memname">Vamp::HostExt::PluginWrapper::~PluginWrapper </td>
|
|
cannam@0
|
270 <td>(</td>
|
|
cannam@0
|
271 <td class="paramname"> </td>
|
|
cannam@0
|
272 <td> ) </td>
|
|
cannam@0
|
273 <td width="100%"><code> [virtual]</code></td>
|
|
cannam@0
|
274 </tr>
|
|
cannam@0
|
275 </table>
|
|
cannam@0
|
276 </div>
|
|
cannam@0
|
277 <div class="memdoc">
|
|
cannam@0
|
278
|
|
cannam@0
|
279 <p>
|
|
cannam@0
|
280
|
|
cannam@0
|
281 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00056">56</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
282
|
|
cannam@0
|
283 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
284
|
|
cannam@0
|
285 </div>
|
|
cannam@0
|
286 </div><p>
|
|
cannam@0
|
287 <a class="anchor" name="35cc2d42f8322f5022e89859a79c97be"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::PluginWrapper" ref="35cc2d42f8322f5022e89859a79c97be" args="(Plugin *plugin)" -->
|
|
cannam@0
|
288 <div class="memitem">
|
|
cannam@0
|
289 <div class="memproto">
|
|
cannam@0
|
290 <table class="memname">
|
|
cannam@0
|
291 <tr>
|
|
cannam@0
|
292 <td class="memname">Vamp::HostExt::PluginWrapper::PluginWrapper </td>
|
|
cannam@0
|
293 <td>(</td>
|
|
cannam@0
|
294 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td>
|
|
cannam@0
|
295 <td class="paramname"> <em>plugin</em> </td>
|
|
cannam@0
|
296 <td> ) </td>
|
|
cannam@0
|
297 <td width="100%"><code> [protected]</code></td>
|
|
cannam@0
|
298 </tr>
|
|
cannam@0
|
299 </table>
|
|
cannam@0
|
300 </div>
|
|
cannam@0
|
301 <div class="memdoc">
|
|
cannam@0
|
302
|
|
cannam@0
|
303 <p>
|
|
cannam@0
|
304
|
|
cannam@0
|
305 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00050">50</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
306
|
|
cannam@0
|
307 </div>
|
|
cannam@0
|
308 </div><p>
|
|
cannam@0
|
309 <hr><h2>Member Function Documentation</h2>
|
|
cannam@0
|
310 <a class="anchor" name="a5a1f8290d8e9a315695584dcb3ad137"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::initialise" ref="a5a1f8290d8e9a315695584dcb3ad137" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
|
|
cannam@0
|
311 <div class="memitem">
|
|
cannam@0
|
312 <div class="memproto">
|
|
cannam@0
|
313 <table class="memname">
|
|
cannam@0
|
314 <tr>
|
|
cannam@0
|
315 <td class="memname">bool Vamp::HostExt::PluginWrapper::initialise </td>
|
|
cannam@0
|
316 <td>(</td>
|
|
cannam@0
|
317 <td class="paramtype">size_t </td>
|
|
cannam@0
|
318 <td class="paramname"> <em>inputChannels</em>, </td>
|
|
cannam@0
|
319 </tr>
|
|
cannam@0
|
320 <tr>
|
|
cannam@0
|
321 <td class="paramkey"></td>
|
|
cannam@0
|
322 <td></td>
|
|
cannam@0
|
323 <td class="paramtype">size_t </td>
|
|
cannam@0
|
324 <td class="paramname"> <em>stepSize</em>, </td>
|
|
cannam@0
|
325 </tr>
|
|
cannam@0
|
326 <tr>
|
|
cannam@0
|
327 <td class="paramkey"></td>
|
|
cannam@0
|
328 <td></td>
|
|
cannam@0
|
329 <td class="paramtype">size_t </td>
|
|
cannam@0
|
330 <td class="paramname"> <em>blockSize</em></td><td> </td>
|
|
cannam@0
|
331 </tr>
|
|
cannam@0
|
332 <tr>
|
|
cannam@0
|
333 <td></td>
|
|
cannam@0
|
334 <td>)</td>
|
|
cannam@0
|
335 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
|
|
cannam@0
|
336 </tr>
|
|
cannam@0
|
337 </table>
|
|
cannam@0
|
338 </div>
|
|
cannam@0
|
339 <div class="memdoc">
|
|
cannam@0
|
340
|
|
cannam@0
|
341 <p>
|
|
cannam@0
|
342 Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).
|
|
cannam@0
|
343 <p>
|
|
cannam@0
|
344 The input sample rate should have been already specified at construction time.<p>
|
|
cannam@0
|
345 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
|
|
cannam@0
|
346 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
347
|
|
cannam@0
|
348 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#de0473c8fc54636431967cbf41649c1c">Vamp::HostExt::PluginChannelAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
349
|
|
cannam@0
|
350 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00062">62</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
351
|
|
cannam@0
|
352 <p>References <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin::initialise()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
353
|
|
cannam@0
|
354 </div>
|
|
cannam@0
|
355 </div><p>
|
|
cannam@0
|
356 <a class="anchor" name="d19cc0614ba41cdc26ef3394c5146fe6"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::reset" ref="d19cc0614ba41cdc26ef3394c5146fe6" args="()" -->
|
|
cannam@0
|
357 <div class="memitem">
|
|
cannam@0
|
358 <div class="memproto">
|
|
cannam@0
|
359 <table class="memname">
|
|
cannam@0
|
360 <tr>
|
|
cannam@0
|
361 <td class="memname">void Vamp::HostExt::PluginWrapper::reset </td>
|
|
cannam@0
|
362 <td>(</td>
|
|
cannam@0
|
363 <td class="paramname"> </td>
|
|
cannam@0
|
364 <td> ) </td>
|
|
cannam@0
|
365 <td width="100%"><code> [virtual]</code></td>
|
|
cannam@0
|
366 </tr>
|
|
cannam@0
|
367 </table>
|
|
cannam@0
|
368 </div>
|
|
cannam@0
|
369 <div class="memdoc">
|
|
cannam@0
|
370
|
|
cannam@0
|
371 <p>
|
|
cannam@0
|
372 Reset the plugin after use, to prepare it for another clean run.
|
|
cannam@0
|
373 <p>
|
|
cannam@0
|
374 Not called for the first initialisation (i.e. initialise must also do a reset).
|
|
cannam@0
|
375 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
376
|
|
cannam@0
|
377 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
|
|
cannam@0
|
378
|
|
cannam@0
|
379 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00068">68</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
380
|
|
cannam@0
|
381 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>, and <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin::reset()</a>.</p>
|
|
cannam@0
|
382
|
|
cannam@0
|
383 </div>
|
|
cannam@0
|
384 </div><p>
|
|
cannam@0
|
385 <a class="anchor" name="031aa818fd48fd0f4b5e1bf80c032870"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getInputDomain" ref="031aa818fd48fd0f4b5e1bf80c032870" args="() const " -->
|
|
cannam@0
|
386 <div class="memitem">
|
|
cannam@0
|
387 <div class="memproto">
|
|
cannam@0
|
388 <table class="memname">
|
|
cannam@0
|
389 <tr>
|
|
cannam@0
|
390 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Plugin::InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
|
|
cannam@0
|
391 <td>(</td>
|
|
cannam@0
|
392 <td class="paramname"> </td>
|
|
cannam@0
|
393 <td> ) </td>
|
|
cannam@0
|
394 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
395 </tr>
|
|
cannam@0
|
396 </table>
|
|
cannam@0
|
397 </div>
|
|
cannam@0
|
398 <div class="memdoc">
|
|
cannam@0
|
399
|
|
cannam@0
|
400 <p>
|
|
cannam@0
|
401 Get the plugin's required input domain.
|
|
cannam@0
|
402 <p>
|
|
cannam@0
|
403 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window.
|
|
cannam@0
|
404 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
405
|
|
cannam@0
|
406 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#376fa97a1c721255541fe35d71368976">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
407
|
|
cannam@0
|
408 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00074">74</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
409
|
|
cannam@0
|
410 <p>References <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin::getInputDomain()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
411
|
|
cannam@0
|
412 </div>
|
|
cannam@0
|
413 </div><p>
|
|
cannam@0
|
414 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
|
|
cannam@0
|
415 <div class="memitem">
|
|
cannam@0
|
416 <div class="memproto">
|
|
cannam@0
|
417 <table class="memname">
|
|
cannam@0
|
418 <tr>
|
|
cannam@0
|
419 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
|
|
cannam@0
|
420 <td>(</td>
|
|
cannam@0
|
421 <td class="paramname"> </td>
|
|
cannam@0
|
422 <td> ) </td>
|
|
cannam@0
|
423 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
424 </tr>
|
|
cannam@0
|
425 </table>
|
|
cannam@0
|
426 </div>
|
|
cannam@0
|
427 <div class="memdoc">
|
|
cannam@0
|
428
|
|
cannam@0
|
429 <p>
|
|
cannam@0
|
430 Get 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> API compatibility level of the plugin.
|
|
cannam@0
|
431 <p>
|
|
cannam@0
|
432
|
|
cannam@0
|
433 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
434
|
|
cannam@0
|
435 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00080">80</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
436
|
|
cannam@0
|
437 <p>References <a class="el" href="PluginBase_8h-source.html#l00067">Vamp::PluginBase::getVampApiVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
438
|
|
cannam@0
|
439 </div>
|
|
cannam@0
|
440 </div><p>
|
|
cannam@0
|
441 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
|
|
cannam@0
|
442 <div class="memitem">
|
|
cannam@0
|
443 <div class="memproto">
|
|
cannam@0
|
444 <table class="memname">
|
|
cannam@0
|
445 <tr>
|
|
cannam@0
|
446 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
|
|
cannam@0
|
447 <td>(</td>
|
|
cannam@0
|
448 <td class="paramname"> </td>
|
|
cannam@0
|
449 <td> ) </td>
|
|
cannam@0
|
450 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
451 </tr>
|
|
cannam@0
|
452 </table>
|
|
cannam@0
|
453 </div>
|
|
cannam@0
|
454 <div class="memdoc">
|
|
cannam@0
|
455
|
|
cannam@0
|
456 <p>
|
|
cannam@0
|
457 Get the computer-usable name of the plugin.
|
|
cannam@0
|
458 <p>
|
|
cannam@0
|
459 This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.<p>
|
|
cannam@0
|
460 This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).<p>
|
|
cannam@0
|
461 Example: "zero_crossings"
|
|
cannam@0
|
462 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
463
|
|
cannam@0
|
464 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00086">86</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
465
|
|
cannam@0
|
466 <p>References <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase::getIdentifier()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
467
|
|
cannam@0
|
468 </div>
|
|
cannam@0
|
469 </div><p>
|
|
cannam@0
|
470 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
|
|
cannam@0
|
471 <div class="memitem">
|
|
cannam@0
|
472 <div class="memproto">
|
|
cannam@0
|
473 <table class="memname">
|
|
cannam@0
|
474 <tr>
|
|
cannam@0
|
475 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
|
|
cannam@0
|
476 <td>(</td>
|
|
cannam@0
|
477 <td class="paramname"> </td>
|
|
cannam@0
|
478 <td> ) </td>
|
|
cannam@0
|
479 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
480 </tr>
|
|
cannam@0
|
481 </table>
|
|
cannam@0
|
482 </div>
|
|
cannam@0
|
483 <div class="memdoc">
|
|
cannam@0
|
484
|
|
cannam@0
|
485 <p>
|
|
cannam@0
|
486 Get a human-readable name or title of the plugin.
|
|
cannam@0
|
487 <p>
|
|
cannam@0
|
488 This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").<p>
|
|
cannam@0
|
489 Example: "Zero Crossings"
|
|
cannam@0
|
490 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
491
|
|
cannam@0
|
492 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00092">92</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
493
|
|
cannam@0
|
494 <p>References <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase::getName()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
495
|
|
cannam@0
|
496 </div>
|
|
cannam@0
|
497 </div><p>
|
|
cannam@0
|
498 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " -->
|
|
cannam@0
|
499 <div class="memitem">
|
|
cannam@0
|
500 <div class="memproto">
|
|
cannam@0
|
501 <table class="memname">
|
|
cannam@0
|
502 <tr>
|
|
cannam@0
|
503 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
|
|
cannam@0
|
504 <td>(</td>
|
|
cannam@0
|
505 <td class="paramname"> </td>
|
|
cannam@0
|
506 <td> ) </td>
|
|
cannam@0
|
507 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
508 </tr>
|
|
cannam@0
|
509 </table>
|
|
cannam@0
|
510 </div>
|
|
cannam@0
|
511 <div class="memdoc">
|
|
cannam@0
|
512
|
|
cannam@0
|
513 <p>
|
|
cannam@0
|
514 Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name".
|
|
cannam@0
|
515 <p>
|
|
cannam@0
|
516 May be empty if the name has said it all already.<p>
|
|
cannam@0
|
517 Example: "Detect and count zero crossing points"
|
|
cannam@0
|
518 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
519
|
|
cannam@0
|
520 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00098">98</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
521
|
|
cannam@0
|
522 <p>References <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase::getDescription()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
523
|
|
cannam@0
|
524 </div>
|
|
cannam@0
|
525 </div><p>
|
|
cannam@0
|
526 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " -->
|
|
cannam@0
|
527 <div class="memitem">
|
|
cannam@0
|
528 <div class="memproto">
|
|
cannam@0
|
529 <table class="memname">
|
|
cannam@0
|
530 <tr>
|
|
cannam@0
|
531 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
|
|
cannam@0
|
532 <td>(</td>
|
|
cannam@0
|
533 <td class="paramname"> </td>
|
|
cannam@0
|
534 <td> ) </td>
|
|
cannam@0
|
535 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
536 </tr>
|
|
cannam@0
|
537 </table>
|
|
cannam@0
|
538 </div>
|
|
cannam@0
|
539 <div class="memdoc">
|
|
cannam@0
|
540
|
|
cannam@0
|
541 <p>
|
|
cannam@0
|
542 Get the name of the author or vendor of the plugin in human-readable form.
|
|
cannam@0
|
543 <p>
|
|
cannam@0
|
544 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
|
|
cannam@0
|
545 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
546
|
|
cannam@0
|
547 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00104">104</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
548
|
|
cannam@0
|
549 <p>References <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase::getMaker()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
550
|
|
cannam@0
|
551 </div>
|
|
cannam@0
|
552 </div><p>
|
|
cannam@0
|
553 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " -->
|
|
cannam@0
|
554 <div class="memitem">
|
|
cannam@0
|
555 <div class="memproto">
|
|
cannam@0
|
556 <table class="memname">
|
|
cannam@0
|
557 <tr>
|
|
cannam@0
|
558 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
|
|
cannam@0
|
559 <td>(</td>
|
|
cannam@0
|
560 <td class="paramname"> </td>
|
|
cannam@0
|
561 <td> ) </td>
|
|
cannam@0
|
562 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
563 </tr>
|
|
cannam@0
|
564 </table>
|
|
cannam@0
|
565 </div>
|
|
cannam@0
|
566 <div class="memdoc">
|
|
cannam@0
|
567
|
|
cannam@0
|
568 <p>
|
|
cannam@0
|
569 Get the version number of the plugin.
|
|
cannam@0
|
570 <p>
|
|
cannam@0
|
571
|
|
cannam@0
|
572 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
573
|
|
cannam@0
|
574 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00110">110</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
575
|
|
cannam@0
|
576 <p>References <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase::getPluginVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
577
|
|
cannam@0
|
578 </div>
|
|
cannam@0
|
579 </div><p>
|
|
cannam@0
|
580 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
|
|
cannam@0
|
581 <div class="memitem">
|
|
cannam@0
|
582 <div class="memproto">
|
|
cannam@0
|
583 <table class="memname">
|
|
cannam@0
|
584 <tr>
|
|
cannam@0
|
585 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
|
|
cannam@0
|
586 <td>(</td>
|
|
cannam@0
|
587 <td class="paramname"> </td>
|
|
cannam@0
|
588 <td> ) </td>
|
|
cannam@0
|
589 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
590 </tr>
|
|
cannam@0
|
591 </table>
|
|
cannam@0
|
592 </div>
|
|
cannam@0
|
593 <div class="memdoc">
|
|
cannam@0
|
594
|
|
cannam@0
|
595 <p>
|
|
cannam@0
|
596 Get the copyright statement or licensing summary for the plugin.
|
|
cannam@0
|
597 <p>
|
|
cannam@0
|
598 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
|
|
cannam@0
|
599 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
600
|
|
cannam@0
|
601 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
602
|
|
cannam@0
|
603 <p>References <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase::getCopyright()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
604
|
|
cannam@0
|
605 </div>
|
|
cannam@0
|
606 </div><p>
|
|
cannam@0
|
607 <a class="anchor" name="3b075b8f950b344503f0d27ac0fe332e"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getParameterDescriptors" ref="3b075b8f950b344503f0d27ac0fe332e" args="() const " -->
|
|
cannam@0
|
608 <div class="memitem">
|
|
cannam@0
|
609 <div class="memproto">
|
|
cannam@0
|
610 <table class="memname">
|
|
cannam@0
|
611 <tr>
|
|
cannam@0
|
612 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PluginBase::ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
|
|
cannam@0
|
613 <td>(</td>
|
|
cannam@0
|
614 <td class="paramname"> </td>
|
|
cannam@0
|
615 <td> ) </td>
|
|
cannam@0
|
616 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
617 </tr>
|
|
cannam@0
|
618 </table>
|
|
cannam@0
|
619 </div>
|
|
cannam@0
|
620 <div class="memdoc">
|
|
cannam@0
|
621
|
|
cannam@0
|
622 <p>
|
|
cannam@0
|
623 Get the controllable parameters of this plugin.
|
|
cannam@0
|
624 <p>
|
|
cannam@0
|
625
|
|
cannam@0
|
626 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
627
|
|
cannam@0
|
628 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00122">122</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
629
|
|
cannam@0
|
630 <p>References <a class="el" href="PluginBase_8h-source.html#l00200">Vamp::PluginBase::getParameterDescriptors()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
631
|
|
cannam@0
|
632 </div>
|
|
cannam@0
|
633 </div><p>
|
|
cannam@0
|
634 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
|
|
cannam@0
|
635 <div class="memitem">
|
|
cannam@0
|
636 <div class="memproto">
|
|
cannam@0
|
637 <table class="memname">
|
|
cannam@0
|
638 <tr>
|
|
cannam@0
|
639 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
|
|
cannam@0
|
640 <td>(</td>
|
|
cannam@0
|
641 <td class="paramtype">std::string </td>
|
|
cannam@0
|
642 <td class="paramname"> </td>
|
|
cannam@0
|
643 <td> ) </td>
|
|
cannam@0
|
644 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
645 </tr>
|
|
cannam@0
|
646 </table>
|
|
cannam@0
|
647 </div>
|
|
cannam@0
|
648 <div class="memdoc">
|
|
cannam@0
|
649
|
|
cannam@0
|
650 <p>
|
|
cannam@0
|
651 Get the value of a named parameter.
|
|
cannam@0
|
652 <p>
|
|
cannam@0
|
653 The argument is the identifier field from that parameter's descriptor.
|
|
cannam@0
|
654 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
655
|
|
cannam@0
|
656 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00128">128</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
657
|
|
cannam@0
|
658 <p>References <a class="el" href="PluginBase_8h-source.html#l00208">Vamp::PluginBase::getParameter()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
659
|
|
cannam@0
|
660 </div>
|
|
cannam@0
|
661 </div><p>
|
|
cannam@0
|
662 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
|
|
cannam@0
|
663 <div class="memitem">
|
|
cannam@0
|
664 <div class="memproto">
|
|
cannam@0
|
665 <table class="memname">
|
|
cannam@0
|
666 <tr>
|
|
cannam@0
|
667 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
|
|
cannam@0
|
668 <td>(</td>
|
|
cannam@0
|
669 <td class="paramtype">std::string </td>
|
|
cannam@0
|
670 <td class="paramname">, </td>
|
|
cannam@0
|
671 </tr>
|
|
cannam@0
|
672 <tr>
|
|
cannam@0
|
673 <td class="paramkey"></td>
|
|
cannam@0
|
674 <td></td>
|
|
cannam@0
|
675 <td class="paramtype">float </td>
|
|
cannam@0
|
676 <td class="paramname"></td><td> </td>
|
|
cannam@0
|
677 </tr>
|
|
cannam@0
|
678 <tr>
|
|
cannam@0
|
679 <td></td>
|
|
cannam@0
|
680 <td>)</td>
|
|
cannam@0
|
681 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
|
|
cannam@0
|
682 </tr>
|
|
cannam@0
|
683 </table>
|
|
cannam@0
|
684 </div>
|
|
cannam@0
|
685 <div class="memdoc">
|
|
cannam@0
|
686
|
|
cannam@0
|
687 <p>
|
|
cannam@0
|
688 Set a named parameter.
|
|
cannam@0
|
689 <p>
|
|
cannam@0
|
690 The first argument is the identifier field from that parameter's descriptor.
|
|
cannam@0
|
691 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
692
|
|
cannam@0
|
693 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00134">134</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
694
|
|
cannam@0
|
695 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00214">Vamp::PluginBase::setParameter()</a>.</p>
|
|
cannam@0
|
696
|
|
cannam@0
|
697 </div>
|
|
cannam@0
|
698 </div><p>
|
|
cannam@0
|
699 <a class="anchor" name="f3abaf717dc4b00cad5770ed6dfa01e1"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPrograms" ref="f3abaf717dc4b00cad5770ed6dfa01e1" args="() const " -->
|
|
cannam@0
|
700 <div class="memitem">
|
|
cannam@0
|
701 <div class="memproto">
|
|
cannam@0
|
702 <table class="memname">
|
|
cannam@0
|
703 <tr>
|
|
cannam@0
|
704 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">PluginBase::ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
|
|
cannam@0
|
705 <td>(</td>
|
|
cannam@0
|
706 <td class="paramname"> </td>
|
|
cannam@0
|
707 <td> ) </td>
|
|
cannam@0
|
708 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
709 </tr>
|
|
cannam@0
|
710 </table>
|
|
cannam@0
|
711 </div>
|
|
cannam@0
|
712 <div class="memdoc">
|
|
cannam@0
|
713
|
|
cannam@0
|
714 <p>
|
|
cannam@0
|
715 Get the program settings available in this plugin.
|
|
cannam@0
|
716 <p>
|
|
cannam@0
|
717 A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.<p>
|
|
cannam@0
|
718 The programs must have unique names.
|
|
cannam@0
|
719 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
720
|
|
cannam@0
|
721 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00140">140</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
722
|
|
cannam@0
|
723 <p>References <a class="el" href="PluginBase_8h-source.html#l00229">Vamp::PluginBase::getPrograms()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
724
|
|
cannam@0
|
725 </div>
|
|
cannam@0
|
726 </div><p>
|
|
cannam@0
|
727 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " -->
|
|
cannam@0
|
728 <div class="memitem">
|
|
cannam@0
|
729 <div class="memproto">
|
|
cannam@0
|
730 <table class="memname">
|
|
cannam@0
|
731 <tr>
|
|
cannam@0
|
732 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
|
|
cannam@0
|
733 <td>(</td>
|
|
cannam@0
|
734 <td class="paramname"> </td>
|
|
cannam@0
|
735 <td> ) </td>
|
|
cannam@0
|
736 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
737 </tr>
|
|
cannam@0
|
738 </table>
|
|
cannam@0
|
739 </div>
|
|
cannam@0
|
740 <div class="memdoc">
|
|
cannam@0
|
741
|
|
cannam@0
|
742 <p>
|
|
cannam@0
|
743 Get the current program.
|
|
cannam@0
|
744 <p>
|
|
cannam@0
|
745
|
|
cannam@0
|
746 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
747
|
|
cannam@0
|
748 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00146">146</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
749
|
|
cannam@0
|
750 <p>References <a class="el" href="PluginBase_8h-source.html#l00234">Vamp::PluginBase::getCurrentProgram()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
751
|
|
cannam@0
|
752 </div>
|
|
cannam@0
|
753 </div><p>
|
|
cannam@0
|
754 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
|
|
cannam@0
|
755 <div class="memitem">
|
|
cannam@0
|
756 <div class="memproto">
|
|
cannam@0
|
757 <table class="memname">
|
|
cannam@0
|
758 <tr>
|
|
cannam@0
|
759 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
|
|
cannam@0
|
760 <td>(</td>
|
|
cannam@0
|
761 <td class="paramtype">std::string </td>
|
|
cannam@0
|
762 <td class="paramname"> </td>
|
|
cannam@0
|
763 <td> ) </td>
|
|
cannam@0
|
764 <td width="100%"><code> [virtual]</code></td>
|
|
cannam@0
|
765 </tr>
|
|
cannam@0
|
766 </table>
|
|
cannam@0
|
767 </div>
|
|
cannam@0
|
768 <div class="memdoc">
|
|
cannam@0
|
769
|
|
cannam@0
|
770 <p>
|
|
cannam@0
|
771 Select a program.
|
|
cannam@0
|
772 <p>
|
|
cannam@0
|
773 (If the given program name is not one of the available programs, do nothing.)
|
|
cannam@0
|
774 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
775
|
|
cannam@0
|
776 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00152">152</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
777
|
|
cannam@0
|
778 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00240">Vamp::PluginBase::selectProgram()</a>.</p>
|
|
cannam@0
|
779
|
|
cannam@0
|
780 </div>
|
|
cannam@0
|
781 </div><p>
|
|
cannam@0
|
782 <a class="anchor" name="0137d93d7019bacc31104836fb4d352e"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPreferredStepSize" ref="0137d93d7019bacc31104836fb4d352e" args="() const " -->
|
|
cannam@0
|
783 <div class="memitem">
|
|
cannam@0
|
784 <div class="memproto">
|
|
cannam@0
|
785 <table class="memname">
|
|
cannam@0
|
786 <tr>
|
|
cannam@0
|
787 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td>
|
|
cannam@0
|
788 <td>(</td>
|
|
cannam@0
|
789 <td class="paramname"> </td>
|
|
cannam@0
|
790 <td> ) </td>
|
|
cannam@0
|
791 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
792 </tr>
|
|
cannam@0
|
793 </table>
|
|
cannam@0
|
794 </div>
|
|
cannam@0
|
795 <div class="memdoc">
|
|
cannam@0
|
796
|
|
cannam@0
|
797 <p>
|
|
cannam@0
|
798 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function) for the plugin.
|
|
cannam@0
|
799 <p>
|
|
cannam@0
|
800 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
|
|
cannam@0
|
801 A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
|
|
cannam@0
|
802 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
803
|
|
cannam@0
|
804 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
805
|
|
cannam@0
|
806 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00158">158</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
807
|
|
cannam@0
|
808 <p>References <a class="el" href="Plugin_8h-source.html#l00186">Vamp::Plugin::getPreferredStepSize()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
809
|
|
cannam@0
|
810 </div>
|
|
cannam@0
|
811 </div><p>
|
|
cannam@0
|
812 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " -->
|
|
cannam@0
|
813 <div class="memitem">
|
|
cannam@0
|
814 <div class="memproto">
|
|
cannam@0
|
815 <table class="memname">
|
|
cannam@0
|
816 <tr>
|
|
cannam@0
|
817 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
|
|
cannam@0
|
818 <td>(</td>
|
|
cannam@0
|
819 <td class="paramname"> </td>
|
|
cannam@0
|
820 <td> ) </td>
|
|
cannam@0
|
821 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
822 </tr>
|
|
cannam@0
|
823 </table>
|
|
cannam@0
|
824 </div>
|
|
cannam@0
|
825 <div class="memdoc">
|
|
cannam@0
|
826
|
|
cannam@0
|
827 <p>
|
|
cannam@0
|
828 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function).
|
|
cannam@0
|
829 <p>
|
|
cannam@0
|
830 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
|
|
cannam@0
|
831 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
|
|
cannam@0
|
832 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
833
|
|
cannam@0
|
834 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
835
|
|
cannam@0
|
836 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00164">164</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
837
|
|
cannam@0
|
838 <p>References <a class="el" href="Plugin_8h-source.html#l00171">Vamp::Plugin::getPreferredBlockSize()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
839
|
|
cannam@0
|
840 <p>Referenced by <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00308">Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize()</a>.</p>
|
|
cannam@0
|
841
|
|
cannam@0
|
842 </div>
|
|
cannam@0
|
843 </div><p>
|
|
cannam@0
|
844 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
|
|
cannam@0
|
845 <div class="memitem">
|
|
cannam@0
|
846 <div class="memproto">
|
|
cannam@0
|
847 <table class="memname">
|
|
cannam@0
|
848 <tr>
|
|
cannam@0
|
849 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
|
|
cannam@0
|
850 <td>(</td>
|
|
cannam@0
|
851 <td class="paramname"> </td>
|
|
cannam@0
|
852 <td> ) </td>
|
|
cannam@0
|
853 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
854 </tr>
|
|
cannam@0
|
855 </table>
|
|
cannam@0
|
856 </div>
|
|
cannam@0
|
857 <div class="memdoc">
|
|
cannam@0
|
858
|
|
cannam@0
|
859 <p>
|
|
cannam@0
|
860 Get the minimum supported number of input channels.
|
|
cannam@0
|
861 <p>
|
|
cannam@0
|
862
|
|
cannam@0
|
863 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
864
|
|
cannam@0
|
865 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00170">170</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
866
|
|
cannam@0
|
867 <p>References <a class="el" href="Plugin_8h-source.html#l00191">Vamp::Plugin::getMinChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
868
|
|
cannam@0
|
869 </div>
|
|
cannam@0
|
870 </div><p>
|
|
cannam@0
|
871 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " -->
|
|
cannam@0
|
872 <div class="memitem">
|
|
cannam@0
|
873 <div class="memproto">
|
|
cannam@0
|
874 <table class="memname">
|
|
cannam@0
|
875 <tr>
|
|
cannam@0
|
876 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
|
|
cannam@0
|
877 <td>(</td>
|
|
cannam@0
|
878 <td class="paramname"> </td>
|
|
cannam@0
|
879 <td> ) </td>
|
|
cannam@0
|
880 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
881 </tr>
|
|
cannam@0
|
882 </table>
|
|
cannam@0
|
883 </div>
|
|
cannam@0
|
884 <div class="memdoc">
|
|
cannam@0
|
885
|
|
cannam@0
|
886 <p>
|
|
cannam@0
|
887 Get the maximum supported number of input channels.
|
|
cannam@0
|
888 <p>
|
|
cannam@0
|
889
|
|
cannam@0
|
890 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
891
|
|
cannam@0
|
892 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00175">175</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
893
|
|
cannam@0
|
894 <p>References <a class="el" href="Plugin_8h-source.html#l00196">Vamp::Plugin::getMaxChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
895
|
|
cannam@0
|
896 </div>
|
|
cannam@0
|
897 </div><p>
|
|
cannam@0
|
898 <a class="anchor" name="02c8c01972affeea58b091335e791ace"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getOutputDescriptors" ref="02c8c01972affeea58b091335e791ace" args="() const " -->
|
|
cannam@0
|
899 <div class="memitem">
|
|
cannam@0
|
900 <div class="memproto">
|
|
cannam@0
|
901 <table class="memname">
|
|
cannam@0
|
902 <tr>
|
|
cannam@0
|
903 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Plugin::OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
|
|
cannam@0
|
904 <td>(</td>
|
|
cannam@0
|
905 <td class="paramname"> </td>
|
|
cannam@0
|
906 <td> ) </td>
|
|
cannam@0
|
907 <td width="100%"> const<code> [virtual]</code></td>
|
|
cannam@0
|
908 </tr>
|
|
cannam@0
|
909 </table>
|
|
cannam@0
|
910 </div>
|
|
cannam@0
|
911 <div class="memdoc">
|
|
cannam@0
|
912
|
|
cannam@0
|
913 <p>
|
|
cannam@0
|
914 Get the outputs of this plugin.
|
|
cannam@0
|
915 <p>
|
|
cannam@0
|
916 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> call.
|
|
cannam@0
|
917 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
918
|
|
cannam@0
|
919 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#85a027f5859efb31d315205e234e94c0">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
|
|
cannam@0
|
920
|
|
cannam@0
|
921 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00181">181</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
922
|
|
cannam@0
|
923 <p>References <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin::getOutputDescriptors()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
924
|
|
cannam@0
|
925 </div>
|
|
cannam@0
|
926 </div><p>
|
|
cannam@0
|
927 <a class="anchor" name="fca78043c2843c1d45019983515e23f7"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::process" ref="fca78043c2843c1d45019983515e23f7" args="(const float *const *inputBuffers, RealTime timestamp)" -->
|
|
cannam@0
|
928 <div class="memitem">
|
|
cannam@0
|
929 <div class="memproto">
|
|
cannam@0
|
930 <table class="memname">
|
|
cannam@0
|
931 <tr>
|
|
cannam@0
|
932 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Plugin::FeatureSet</a> Vamp::HostExt::PluginWrapper::process </td>
|
|
cannam@0
|
933 <td>(</td>
|
|
cannam@0
|
934 <td class="paramtype">const float *const * </td>
|
|
cannam@0
|
935 <td class="paramname"> <em>inputBuffers</em>, </td>
|
|
cannam@0
|
936 </tr>
|
|
cannam@0
|
937 <tr>
|
|
cannam@0
|
938 <td class="paramkey"></td>
|
|
cannam@0
|
939 <td></td>
|
|
cannam@0
|
940 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td>
|
|
cannam@0
|
941 <td class="paramname"> <em>timestamp</em></td><td> </td>
|
|
cannam@0
|
942 </tr>
|
|
cannam@0
|
943 <tr>
|
|
cannam@0
|
944 <td></td>
|
|
cannam@0
|
945 <td>)</td>
|
|
cannam@0
|
946 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
|
|
cannam@0
|
947 </tr>
|
|
cannam@0
|
948 </table>
|
|
cannam@0
|
949 </div>
|
|
cannam@0
|
950 <div class="memdoc">
|
|
cannam@0
|
951
|
|
cannam@0
|
952 <p>
|
|
cannam@0
|
953 Process a single block of input data.
|
|
cannam@0
|
954 <p>
|
|
cannam@0
|
955 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp will be the real time in seconds of the start of the supplied block of samples.<p>
|
|
cannam@0
|
956 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p>
|
|
cannam@0
|
957 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.)
|
|
cannam@0
|
958 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
959
|
|
cannam@0
|
960 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#294e663b4d9ec885791faa1b440571ed">Vamp::HostExt::PluginChannelAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#0867737693c16801d40a6adbde07ec07">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
961
|
|
cannam@0
|
962 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00187">187</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
963
|
|
cannam@0
|
964 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>, and <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin::process()</a>.</p>
|
|
cannam@0
|
965
|
|
cannam@0
|
966 </div>
|
|
cannam@0
|
967 </div><p>
|
|
cannam@0
|
968 <a class="anchor" name="1dce55a75a32b08fc56a52a300d9fcbe"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getRemainingFeatures" ref="1dce55a75a32b08fc56a52a300d9fcbe" args="()" -->
|
|
cannam@0
|
969 <div class="memitem">
|
|
cannam@0
|
970 <div class="memproto">
|
|
cannam@0
|
971 <table class="memname">
|
|
cannam@0
|
972 <tr>
|
|
cannam@0
|
973 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Plugin::FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
|
|
cannam@0
|
974 <td>(</td>
|
|
cannam@0
|
975 <td class="paramname"> </td>
|
|
cannam@0
|
976 <td> ) </td>
|
|
cannam@0
|
977 <td width="100%"><code> [virtual]</code></td>
|
|
cannam@0
|
978 </tr>
|
|
cannam@0
|
979 </table>
|
|
cannam@0
|
980 </div>
|
|
cannam@0
|
981 <div class="memdoc">
|
|
cannam@0
|
982
|
|
cannam@0
|
983 <p>
|
|
cannam@0
|
984 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
|
|
cannam@0
|
985 <p>
|
|
cannam@0
|
986
|
|
cannam@0
|
987 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
988
|
|
cannam@0
|
989 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#8771cba75552aaa1340b68de9bf1659c">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
|
|
cannam@0
|
990
|
|
cannam@0
|
991 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00193">193</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
|
|
cannam@0
|
992
|
|
cannam@0
|
993 <p>References <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin::getRemainingFeatures()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
|
|
cannam@0
|
994
|
|
cannam@0
|
995 </div>
|
|
cannam@0
|
996 </div><p>
|
|
cannam@0
|
997 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
|
|
cannam@0
|
998 <div class="memitem">
|
|
cannam@0
|
999 <div class="memproto">
|
|
cannam@0
|
1000 <table class="memname">
|
|
cannam@0
|
1001 <tr>
|
|
cannam@0
|
1002 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
|
|
cannam@0
|
1003 <td>(</td>
|
|
cannam@0
|
1004 <td class="paramname"> </td>
|
|
cannam@0
|
1005 <td> ) </td>
|
|
cannam@0
|
1006 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
|
|
cannam@0
|
1007 </tr>
|
|
cannam@0
|
1008 </table>
|
|
cannam@0
|
1009 </div>
|
|
cannam@0
|
1010 <div class="memdoc">
|
|
cannam@0
|
1011
|
|
cannam@0
|
1012 <p>
|
|
cannam@0
|
1013 Used to distinguish between <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> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>.
|
|
cannam@0
|
1014 <p>
|
|
cannam@0
|
1015 Do not reimplement this function in your subclass.
|
|
cannam@0
|
1016 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
1017
|
|
cannam@0
|
1018 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00391">391</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
|
|
cannam@0
|
1019
|
|
cannam@0
|
1020 </div>
|
|
cannam@0
|
1021 </div><p>
|
|
cannam@0
|
1022 <hr><h2>Member Data Documentation</h2>
|
|
cannam@0
|
1023 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
|
|
cannam@0
|
1024 <div class="memitem">
|
|
cannam@0
|
1025 <div class="memproto">
|
|
cannam@0
|
1026 <table class="memname">
|
|
cannam@0
|
1027 <tr>
|
|
cannam@0
|
1028 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected]</code> </td>
|
|
cannam@0
|
1029 </tr>
|
|
cannam@0
|
1030 </table>
|
|
cannam@0
|
1031 </div>
|
|
cannam@0
|
1032 <div class="memdoc">
|
|
cannam@0
|
1033
|
|
cannam@0
|
1034 <p>
|
|
cannam@0
|
1035
|
|
cannam@0
|
1036 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00099">99</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
|
|
cannam@0
|
1037
|
|
cannam@0
|
1038 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00116">getCopyright()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00146">getCurrentProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00098">getDescription()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00086">getIdentifier()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00074">getInputDomain()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00104">getMaker()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00175">getMaxChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00170">getMinChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00092">getName()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00181">getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00128">getParameter()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00122">getParameterDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00110">getPluginVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00164">getPreferredBlockSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00158">getPreferredStepSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00140">getPrograms()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00193">getRemainingFeatures()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00080">getVampApiVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00062">initialise()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00187">process()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00068">reset()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00152">selectProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00134">setParameter()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00620">Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::~PluginDeletionNotifyAdapter()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00056">~PluginWrapper()</a>.</p>
|
|
cannam@0
|
1039
|
|
cannam@0
|
1040 </div>
|
|
cannam@0
|
1041 </div><p>
|
|
cannam@0
|
1042 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
|
|
cannam@0
|
1043 <div class="memitem">
|
|
cannam@0
|
1044 <div class="memproto">
|
|
cannam@0
|
1045 <table class="memname">
|
|
cannam@0
|
1046 <tr>
|
|
cannam@0
|
1047 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
|
|
cannam@0
|
1048 </tr>
|
|
cannam@0
|
1049 </table>
|
|
cannam@0
|
1050 </div>
|
|
cannam@0
|
1051 <div class="memdoc">
|
|
cannam@0
|
1052
|
|
cannam@0
|
1053 <p>
|
|
cannam@0
|
1054
|
|
cannam@0
|
1055 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00397">397</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
|
|
cannam@0
|
1056
|
|
cannam@0
|
1057 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00047">Vamp::HostExt::PluginRateExtractor::getRate()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00113">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
|
|
cannam@0
|
1058
|
|
cannam@0
|
1059 </div>
|
|
cannam@0
|
1060 </div><p>
|
|
cannam@0
|
1061 <hr>The documentation for this class was generated from the following files:<ul>
|
|
cannam@0
|
1062 <li><a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a><li><a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a></ul>
|
|
cannam@0
|
1063 </div>
|
|
cannam@0
|
1064 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:11 2008 for VampPluginSDK by
|
|
cannam@0
|
1065 <a href="http://www.doxygen.org/index.html">
|
|
cannam@0
|
1066 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
cannam@0
|
1067 </body>
|
|
cannam@0
|
1068 </html>
|
