Mercurial > hg > vamp-website
comparison code-doc/classAmplitudeFollower.html @ 50:8260c0f4e05b website
Update code docs for 2.3
author | cannam |
---|---|
date | Tue, 04 Oct 2011 13:47:23 +0000 |
parents | 0976232e353b |
children |
comparison
equal
deleted
inserted
replaced
49:f75f330aa130 | 50:8260c0f4e05b |
---|---|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> | 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> | 2 <html xmlns="http://www.w3.org/1999/xhtml"> |
3 <head> | |
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | |
3 <title>VampPluginSDK: AmplitudeFollower Class Reference</title> | 5 <title>VampPluginSDK: AmplitudeFollower Class Reference</title> |
4 <link href="tabs.css" rel="stylesheet" type="text/css"> | 6 |
5 <link href="doxygen.css" rel="stylesheet" type="text/css"> | 7 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
6 </head><body> | 8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
7 <!-- Generated by Doxygen 1.5.8 --> | 9 <link href="navtree.css" rel="stylesheet" type="text/css"/> |
8 <div class="navigation" id="top"> | 10 <script type="text/javascript" src="jquery.js"></script> |
9 <div class="tabs"> | 11 <script type="text/javascript" src="resize.js"></script> |
10 <ul> | 12 <script type="text/javascript" src="navtree.js"></script> |
11 <li><a href="main.html"><span>Main Page</span></a></li> | 13 <script type="text/javascript"> |
14 $(document).ready(initResizable); | |
15 </script> | |
16 | |
17 | |
18 </head> | |
19 <body> | |
20 <div id="top"><!-- do not remove this div! --> | |
21 | |
22 | |
23 <div id="titlearea"> | |
24 <table cellspacing="0" cellpadding="0"> | |
25 <tbody> | |
26 <tr style="height: 56px;"> | |
27 | |
28 | |
29 <td style="padding-left: 0.5em;"> | |
30 <div id="projectname">VampPluginSDK | |
31  <span id="projectnumber">2.1</span> | |
32 </div> | |
33 | |
34 </td> | |
35 | |
36 | |
37 | |
38 </tr> | |
39 </tbody> | |
40 </table> | |
41 </div> | |
42 | |
43 <!-- Generated by Doxygen 1.7.5.1 --> | |
44 <div id="navrow1" class="tabs"> | |
45 <ul class="tablist"> | |
46 <li><a href="index.html"><span>Main Page</span></a></li> | |
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> | 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> | 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
14 <li><a href="files.html"><span>Files</span></a></li> | 49 <li><a href="files.html"><span>Files</span></a></li> |
15 <li><a href="dirs.html"><span>Directories</span></a></li> | 50 <li><a href="dirs.html"><span>Directories</span></a></li> |
16 </ul> | 51 </ul> |
17 </div> | 52 </div> |
18 <div class="tabs"> | 53 <div id="navrow2" class="tabs2"> |
19 <ul> | 54 <ul class="tablist"> |
20 <li><a href="annotated.html"><span>Class List</span></a></li> | 55 <li><a href="annotated.html"><span>Class List</span></a></li> |
21 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> | 56 <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
22 <li><a href="functions.html"><span>Class Members</span></a></li> | 57 <li><a href="functions.html"><span>Class Members</span></a></li> |
23 </ul> | 58 </ul> |
24 </div> | 59 </div> |
25 </div> | 60 </div> |
61 <div id="side-nav" class="ui-resizable side-nav-resizable"> | |
62 <div id="nav-tree"> | |
63 <div id="nav-tree-contents"> | |
64 </div> | |
65 </div> | |
66 <div id="splitbar" style="-moz-user-select:none;" | |
67 class="ui-resizable-handle"> | |
68 </div> | |
69 </div> | |
70 <script type="text/javascript"> | |
71 initNavTree('classAmplitudeFollower.html',''); | |
72 </script> | |
73 <div id="doc-content"> | |
74 <div class="header"> | |
75 <div class="summary"> | |
76 <a href="#pub-types">Public Types</a> | | |
77 <a href="#pub-methods">Public Member Functions</a> | | |
78 <a href="#pro-attribs">Protected Attributes</a> </div> | |
79 <div class="headertitle"> | |
80 <div class="title">AmplitudeFollower Class Reference</div> </div> | |
81 </div> | |
26 <div class="contents"> | 82 <div class="contents"> |
27 <h1>AmplitudeFollower Class Reference</h1><!-- doxytag: class="AmplitudeFollower" --><!-- doxytag: inherits="Vamp::Plugin" -->Example plugin implementing the SuperCollider amplitude follower function. | 83 <!-- doxytag: class="AmplitudeFollower" --><!-- doxytag: inherits="Vamp::Plugin" --> |
28 <a href="#_details">More...</a> | 84 <p>Example plugin implementing the SuperCollider amplitude follower function. |
29 <p> | 85 <a href="classAmplitudeFollower.html#details">More...</a></p> |
30 <code>#include <<a class="el" href="AmplitudeFollower_8h-source.html">AmplitudeFollower.h</a>></code> | 86 |
31 <p> | 87 <p><code>#include <<a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>></code></p> |
32 <div class="dynheader"> | 88 <div class="dynheader"> |
33 Inheritance diagram for AmplitudeFollower:</div> | 89 Inheritance diagram for AmplitudeFollower:</div> |
34 <div class="dynsection"> | 90 <div class="dyncontent"> |
35 <p><center><img src="classAmplitudeFollower__inherit__graph.png" border="0" usemap="#AmplitudeFollower__inherit__map" alt="Inheritance graph"></center> | 91 <div class="center"><img src="classAmplitudeFollower__inherit__graph.png" border="0" usemap="#AmplitudeFollower_inherit__map" alt="Inheritance graph"/></div> |
36 <map name="AmplitudeFollower__inherit__map"> | 92 <map name="AmplitudeFollower_inherit__map" id="AmplitudeFollower_inherit__map"> |
37 <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="20,81,113,105"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="7,7,127,31"></map> | 93 <area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="21,81,112,106"/><area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="7,6,125,31"/></map> |
38 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> | 94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> |
39 | 95 |
40 <p> | 96 <p><a href="classAmplitudeFollower-members.html">List of all members.</a></p> |
41 <a href="classAmplitudeFollower-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> | 97 <table class="memberdecls"> |
42 <tr><td></td></tr> | 98 <tr><td colspan="2"><h2><a name="pub-types"></a> |
43 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> | 99 Public Types</h2></td></tr> |
44 <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>, | 100 <tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, |
45 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> | 101 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> |
46 }</td></tr> | 102 }</td></tr> |
47 | 103 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> |
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br class="typebreak"> | 104 < <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#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr> |
49 < <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> | 105 <tr><td class="memItemLeft" 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#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr> |
50 | 106 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map< int, <br class="typebreak"/> |
51 <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> | 107 <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr> |
52 | 108 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> |
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map< int, <br class="typebreak"> | 109 < <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#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr> |
54 <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> | 110 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> |
55 | 111 <tr><td colspan="2"><h2><a name="pub-methods"></a> |
56 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> | 112 Public Member Functions</h2></td></tr> |
57 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#29eaeffc353da2614ae508abcd0ab63f">AmplitudeFollower</a> (float inputSampleRate)</td></tr> | 113 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a29eaeffc353da2614ae508abcd0ab63f">AmplitudeFollower</a> (float inputSampleRate)</td></tr> |
58 | 114 <tr><td class="mdescLeft"> </td><td class="mdescRight">An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. <a href="#a29eaeffc353da2614ae508abcd0ab63f"></a><br/></td></tr> |
59 <tr><td class="mdescLeft"> </td><td class="mdescRight">An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. <a href="#29eaeffc353da2614ae508abcd0ab63f"></a><br></td></tr> | 115 <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aa78f98539ad3a1b08691a99b32035b2d">~AmplitudeFollower</a> ()</td></tr> |
60 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a78f98539ad3a1b08691a99b32035b2d">~AmplitudeFollower</a> ()</td></tr> | 116 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> |
61 | 117 <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="#aeb727e44ee8ad1aceb90964d20f8d90d"></a><br/></td></tr> |
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#eb727e44ee8ad1aceb90964d20f8d90d">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> | 118 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#acebd835e80e84669df078fbd7591d8f7">reset</a> ()</td></tr> |
63 | 119 <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#acebd835e80e84669df078fbd7591d8f7"></a><br/></td></tr> |
64 <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="#eb727e44ee8ad1aceb90964d20f8d90d"></a><br></td></tr> | 120 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#afc07a389b5f922b944b0350fd232d2eb">getInputDomain</a> () const </td></tr> |
65 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#cebd835e80e84669df078fbd7591d8f7">reset</a> ()</td></tr> | 121 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#afc07a389b5f922b944b0350fd232d2eb"></a><br/></td></tr> |
66 | 122 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#afe7576af95c8fcc7f5bad42eec9f9f29">getIdentifier</a> () const </td></tr> |
67 <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#cebd835e80e84669df078fbd7591d8f7"></a><br></td></tr> | 123 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#afe7576af95c8fcc7f5bad42eec9f9f29"></a><br/></td></tr> |
68 <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="classAmplitudeFollower.html#fc07a389b5f922b944b0350fd232d2eb">getInputDomain</a> () const </td></tr> | 124 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a7cfed00bc9d96ba6c709b69ab6a40594">getName</a> () const </td></tr> |
69 | 125 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a7cfed00bc9d96ba6c709b69ab6a40594"></a><br/></td></tr> |
70 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#fc07a389b5f922b944b0350fd232d2eb"></a><br></td></tr> | 126 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a6f0f2fea1fdb4b51e688edfe859d5062">getDescription</a> () const </td></tr> |
71 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#fe7576af95c8fcc7f5bad42eec9f9f29">getIdentifier</a> () const </td></tr> | 127 <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="#a6f0f2fea1fdb4b51e688edfe859d5062"></a><br/></td></tr> |
72 | 128 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a44fc43838f203f58bc2ce6e3cb2b03dd">getMaker</a> () const </td></tr> |
73 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#fe7576af95c8fcc7f5bad42eec9f9f29"></a><br></td></tr> | 129 <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="#a44fc43838f203f58bc2ce6e3cb2b03dd"></a><br/></td></tr> |
74 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#7cfed00bc9d96ba6c709b69ab6a40594">getName</a> () const </td></tr> | 130 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a8a5d7a834eb996d517c51f84b2a72250">getPluginVersion</a> () const </td></tr> |
75 | 131 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#a8a5d7a834eb996d517c51f84b2a72250"></a><br/></td></tr> |
76 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#7cfed00bc9d96ba6c709b69ab6a40594"></a><br></td></tr> | 132 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a0c197fc90f30d91cb4403115c83c9134">getCopyright</a> () const </td></tr> |
77 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#6f0f2fea1fdb4b51e688edfe859d5062">getDescription</a> () const </td></tr> | 133 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#a0c197fc90f30d91cb4403115c83c9134"></a><br/></td></tr> |
78 | 134 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a043e3c3db77d76267cd8069e1485bf26">getOutputDescriptors</a> () const </td></tr> |
79 <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="#6f0f2fea1fdb4b51e688edfe859d5062"></a><br></td></tr> | 135 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#a043e3c3db77d76267cd8069e1485bf26"></a><br/></td></tr> |
80 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#44fc43838f203f58bc2ce6e3cb2b03dd">getMaker</a> () const </td></tr> | 136 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">getParameterDescriptors</a> () const </td></tr> |
81 | 137 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9df01323a09e117bc12354ebe9244edf"></a><br/></td></tr> |
82 <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="#44fc43838f203f58bc2ce6e3cb2b03dd"></a><br></td></tr> | 138 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">getParameter</a> (std::string paramid) const </td></tr> |
83 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#8a5d7a834eb996d517c51f84b2a72250">getPluginVersion</a> () const </td></tr> | 139 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#ab278c4b6f2ca23248dc94ad775273f39"></a><br/></td></tr> |
84 | 140 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">setParameter</a> (std::string paramid, float newval)</td></tr> |
85 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#8a5d7a834eb996d517c51f84b2a72250"></a><br></td></tr> | 141 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#ae1fc37ece4d20e40f3066a3361a99340"></a><br/></td></tr> |
86 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#0c197fc90f30d91cb4403115c83c9134">getCopyright</a> () const </td></tr> | 142 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr> |
87 | 143 <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#a48d0f95cac31ffd190cff89b50a2a5bd"></a><br/></td></tr> |
88 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#0c197fc90f30d91cb4403115c83c9134"></a><br></td></tr> | 144 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a368606f643b88e0df0823d85e36f030c">getRemainingFeatures</a> ()</td></tr> |
89 <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="classAmplitudeFollower.html#043e3c3db77d76267cd8069e1485bf26">getOutputDescriptors</a> () const </td></tr> | 145 <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="#a368606f643b88e0df0823d85e36f030c"></a><br/></td></tr> |
90 | 146 <tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr> |
91 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#043e3c3db77d76267cd8069e1485bf26"></a><br></td></tr> | 147 <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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). <a href="#aa529adf83f87a603954eb31407602aac"></a><br/></td></tr> |
92 <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="classAmplitudeFollower.html#9df01323a09e117bc12354ebe9244edf">getParameterDescriptors</a> () const </td></tr> | 148 <tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr> |
93 | 149 <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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a514c716c22f81c055f19b56c3f882567"></a><br/></td></tr> |
94 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9df01323a09e117bc12354ebe9244edf"></a><br></td></tr> | 150 <tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr> |
95 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#b278c4b6f2ca23248dc94ad775273f39">getParameter</a> (std::string paramid) const </td></tr> | 151 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a267b42e866df3cf0d190893e8096f525"></a><br/></td></tr> |
96 | 152 <tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr> |
97 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#b278c4b6f2ca23248dc94ad775273f39"></a><br></td></tr> | 153 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br/></td></tr> |
98 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#e1fc37ece4d20e40f3066a3361a99340">setParameter</a> (std::string paramid, float newval)</td></tr> | 154 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> |
99 | 155 <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 from audio o...">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="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr> |
100 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#e1fc37ece4d20e40f3066a3361a99340"></a><br></td></tr> | 156 <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr> |
101 <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="classAmplitudeFollower.html#48d0f95cac31ffd190cff89b50a2a5bd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr> | 157 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr> |
102 | 158 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr> |
103 <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#48d0f95cac31ffd190cff89b50a2a5bd"></a><br></td></tr> | 159 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr> |
104 <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="classAmplitudeFollower.html#368606f643b88e0df0823d85e36f030c">getRemainingFeatures</a> ()</td></tr> | 160 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr> |
105 | 161 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr> |
106 <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="#368606f643b88e0df0823d85e36f030c"></a><br></td></tr> | 162 <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr> |
107 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr> | 163 <tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr> |
108 | 164 <tr><td colspan="2"><h2><a name="pro-attribs"></a> |
109 <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_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). <a href="#a529adf83f87a603954eb31407602aac"></a><br></td></tr> | 165 Protected Attributes</h2></td></tr> |
110 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr> | 166 <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">m_stepSize</a></td></tr> |
111 | 167 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">m_previn</a></td></tr> |
112 <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_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#514c716c22f81c055f19b56c3f882567"></a><br></td></tr> | 168 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a></td></tr> |
113 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr> | 169 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a></td></tr> |
114 | 170 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr> |
115 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#267b42e866df3cf0d190893e8096f525"></a><br></td></tr> | |
116 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr> | |
117 | |
118 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br></td></tr> | |
119 <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> | |
120 | |
121 <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> | |
122 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr> | |
123 | |
124 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#8fd2c48291c64b790f0efb8948508dcf"></a><br></td></tr> | |
125 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr> | |
126 | |
127 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#bb307c60bdb981d5f5af50c3c4ae84af"></a><br></td></tr> | |
128 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr> | |
129 | |
130 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#24e77eccf1bdfbbca3c79bb25e8799b3"></a><br></td></tr> | |
131 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr> | |
132 | |
133 <tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#add3a547ef140bae200473a9518e3353"></a><br></td></tr> | |
134 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> | |
135 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#959c2647fd3c5feea2591e3618774027">m_stepSize</a></td></tr> | |
136 | |
137 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#c95e8d2f334821c6c92c706bae29695a">m_previn</a></td></tr> | |
138 | |
139 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a></td></tr> | |
140 | |
141 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a></td></tr> | |
142 | |
143 <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> | |
144 | |
145 </table> | 171 </table> |
146 <hr><a name="_details"></a><h2>Detailed Description</h2> | 172 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> |
147 Example plugin implementing the SuperCollider amplitude follower function. | 173 <div class="textblock"><p>Example plugin implementing the SuperCollider amplitude follower function. </p> |
148 <p>Definition at line <a class="el" href="AmplitudeFollower_8h-source.html#l00047">47</a> of file <a class="el" href="AmplitudeFollower_8h-source.html">AmplitudeFollower.h</a>.</p> | 174 |
149 <hr><h2>Member Typedef Documentation</h2> | 175 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00047">47</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> |
150 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="AmplitudeFollower::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" --> | 176 </div><hr/><h2>Member Typedef Documentation</h2> |
151 <div class="memitem"> | 177 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="AmplitudeFollower::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" --> |
152 <div class="memproto"> | 178 <div class="memitem"> |
153 <table class="memname"> | 179 <div class="memproto"> |
154 <tr> | 180 <table class="memname"> |
155 <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> | 181 <tr> |
156 </tr> | 182 <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#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code></td> |
157 </table> | 183 </tr> |
158 </div> | 184 </table> |
159 <div class="memdoc"> | 185 </div> |
160 | 186 <div class="memdoc"> |
161 <p> | 187 |
162 | 188 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00327">327</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
163 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00327">327</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 189 |
164 | 190 </div> |
165 </div> | 191 </div> |
166 </div><p> | 192 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="AmplitudeFollower::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" --> |
167 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="AmplitudeFollower::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> | 193 <div class="memitem"> |
168 <div class="memitem"> | 194 <div class="memproto"> |
169 <div class="memproto"> | 195 <table class="memname"> |
170 <table class="memname"> | 196 <tr> |
171 <tr> | 197 <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#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code></td> |
172 <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> | 198 </tr> |
173 </tr> | 199 </table> |
174 </table> | 200 </div> |
175 </div> | 201 <div class="memdoc"> |
176 <div class="memdoc"> | 202 |
177 | 203 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00385">385</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
178 <p> | 204 |
179 | 205 </div> |
180 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00385">385</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 206 </div> |
181 | 207 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="AmplitudeFollower::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" --> |
182 </div> | 208 <div class="memitem"> |
183 </div><p> | 209 <div class="memproto"> |
184 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="AmplitudeFollower::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> | 210 <table class="memname"> |
185 <div class="memitem"> | 211 <tr> |
186 <div class="memproto"> | 212 <td class="memname">typedef std::map<int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>> <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code></td> |
187 <table class="memname"> | 213 </tr> |
188 <tr> | 214 </table> |
189 <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> | 215 </div> |
190 </tr> | 216 <div class="memdoc"> |
191 </table> | 217 |
192 </div> | 218 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
193 <div class="memdoc"> | 219 |
194 | 220 </div> |
195 <p> | 221 </div> |
196 | 222 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="AmplitudeFollower::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> |
197 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 223 <div class="memitem"> |
198 | 224 <div class="memproto"> |
199 </div> | 225 <table class="memname"> |
200 </div><p> | 226 <tr> |
201 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="AmplitudeFollower::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> | 227 <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#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code></td> |
202 <div class="memitem"> | 228 </tr> |
203 <div class="memproto"> | 229 </table> |
204 <table class="memname"> | 230 </div> |
205 <tr> | 231 <div class="memdoc"> |
206 <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> | 232 |
207 </tr> | 233 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> |
208 </table> | 234 |
209 </div> | 235 </div> |
210 <div class="memdoc"> | 236 </div> |
211 | 237 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="AmplitudeFollower::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" --> |
212 <p> | 238 <div class="memitem"> |
213 | 239 <div class="memproto"> |
214 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> | 240 <table class="memname"> |
215 | 241 <tr> |
216 </div> | 242 <td class="memname">typedef std::vector<std::string> <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code></td> |
217 </div><p> | 243 </tr> |
218 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="AmplitudeFollower::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" --> | 244 </table> |
219 <div class="memitem"> | 245 </div> |
220 <div class="memproto"> | 246 <div class="memdoc"> |
221 <table class="memname"> | 247 |
222 <tr> | 248 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> |
223 <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> | 249 |
224 </tr> | 250 </div> |
225 </table> | 251 </div> |
226 </div> | 252 <hr/><h2>Member Enumeration Documentation</h2> |
227 <div class="memdoc"> | 253 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="AmplitudeFollower::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" --> |
228 | 254 <div class="memitem"> |
229 <p> | 255 <div class="memproto"> |
230 | 256 <table class="memname"> |
231 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> | 257 <tr> |
232 | 258 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td> |
233 </div> | 259 </tr> |
234 </div><p> | 260 </table> |
235 <hr><h2>Member Enumeration Documentation</h2> | 261 </div> |
236 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="AmplitudeFollower::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> | 262 <div class="memdoc"> |
237 <div class="memitem"> | 263 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> |
238 <div class="memproto"> | 264 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em> </td><td> |
239 <table class="memname"> | |
240 <tr> | |
241 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td> | |
242 </tr> | |
243 </table> | |
244 </div> | |
245 <div class="memdoc"> | |
246 | |
247 <p> | |
248 <dl compact><dt><b>Enumerator: </b></dt><dd> | |
249 <table border="0" cellspacing="2" cellpadding="0"> | |
250 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em> </td><td> | |
251 </td></tr> | 265 </td></tr> |
252 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td> | 266 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td> |
253 </td></tr> | 267 </td></tr> |
254 </table> | 268 </table> |
269 </dd> | |
255 </dl> | 270 </dl> |
256 | 271 |
257 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 272 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
258 | 273 |
259 </div> | 274 </div> |
260 </div><p> | 275 </div> |
261 <hr><h2>Constructor & Destructor Documentation</h2> | 276 <hr/><h2>Constructor & Destructor Documentation</h2> |
262 <a class="anchor" name="29eaeffc353da2614ae508abcd0ab63f"></a><!-- doxytag: member="AmplitudeFollower::AmplitudeFollower" ref="29eaeffc353da2614ae508abcd0ab63f" args="(float inputSampleRate)" --> | 277 <a class="anchor" id="a29eaeffc353da2614ae508abcd0ab63f"></a><!-- doxytag: member="AmplitudeFollower::AmplitudeFollower" ref="a29eaeffc353da2614ae508abcd0ab63f" args="(float inputSampleRate)" --> |
263 <div class="memitem"> | 278 <div class="memitem"> |
264 <div class="memproto"> | 279 <div class="memproto"> |
265 <table class="memname"> | 280 <table class="memname"> |
266 <tr> | 281 <tr> |
267 <td class="memname">AmplitudeFollower::AmplitudeFollower </td> | 282 <td class="memname">AmplitudeFollower::AmplitudeFollower </td> |
268 <td>(</td> | 283 <td>(</td> |
269 <td class="paramtype">float </td> | 284 <td class="paramtype">float </td> |
270 <td class="paramname"> <em>inputSampleRate</em> </td> | 285 <td class="paramname"><em>inputSampleRate</em></td><td>)</td> |
271 <td> ) </td> | |
272 <td></td> | 286 <td></td> |
273 </tr> | 287 </tr> |
274 </table> | 288 </table> |
275 </div> | 289 </div> |
276 <div class="memdoc"> | 290 <div class="memdoc"> |
277 | 291 |
278 <p> | 292 <p>An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. </p> |
279 An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. | 293 |
280 <p> | 294 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00055">55</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
281 | 295 |
282 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00055">55</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 296 </div> |
283 | 297 </div> |
284 </div> | 298 <a class="anchor" id="aa78f98539ad3a1b08691a99b32035b2d"></a><!-- doxytag: member="AmplitudeFollower::~AmplitudeFollower" ref="aa78f98539ad3a1b08691a99b32035b2d" args="()" --> |
285 </div><p> | 299 <div class="memitem"> |
286 <a class="anchor" name="a78f98539ad3a1b08691a99b32035b2d"></a><!-- doxytag: member="AmplitudeFollower::~AmplitudeFollower" ref="a78f98539ad3a1b08691a99b32035b2d" args="()" --> | 300 <div class="memproto"> |
287 <div class="memitem"> | 301 <table class="memname"> |
288 <div class="memproto"> | 302 <tr> |
289 <table class="memname"> | 303 <td class="memname">AmplitudeFollower::~AmplitudeFollower </td> |
290 <tr> | 304 <td>(</td> |
291 <td class="memname">AmplitudeFollower::~AmplitudeFollower </td> | 305 <td class="paramname"></td><td>)</td> |
292 <td>(</td> | |
293 <td class="paramname"> </td> | |
294 <td> ) </td> | |
295 <td><code> [virtual]</code></td> | 306 <td><code> [virtual]</code></td> |
296 </tr> | 307 </tr> |
297 </table> | 308 </table> |
298 </div> | 309 </div> |
299 <div class="memdoc"> | 310 <div class="memdoc"> |
300 | 311 |
301 <p> | 312 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00064">64</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
302 | 313 |
303 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00064">64</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 314 </div> |
304 | 315 </div> |
305 </div> | 316 <hr/><h2>Member Function Documentation</h2> |
306 </div><p> | 317 <a class="anchor" id="aeb727e44ee8ad1aceb90964d20f8d90d"></a><!-- doxytag: member="AmplitudeFollower::initialise" ref="aeb727e44ee8ad1aceb90964d20f8d90d" args="(size_t channels, size_t stepSize, size_t blockSize)" --> |
307 <hr><h2>Member Function Documentation</h2> | 318 <div class="memitem"> |
308 <a class="anchor" name="eb727e44ee8ad1aceb90964d20f8d90d"></a><!-- doxytag: member="AmplitudeFollower::initialise" ref="eb727e44ee8ad1aceb90964d20f8d90d" args="(size_t channels, size_t stepSize, size_t blockSize)" --> | 319 <div class="memproto"> |
309 <div class="memitem"> | 320 <table class="memname"> |
310 <div class="memproto"> | 321 <tr> |
311 <table class="memname"> | 322 <td class="memname">bool AmplitudeFollower::initialise </td> |
312 <tr> | 323 <td>(</td> |
313 <td class="memname">bool AmplitudeFollower::initialise </td> | 324 <td class="paramtype">size_t </td> |
314 <td>(</td> | 325 <td class="paramname"><em>inputChannels</em>, </td> |
315 <td class="paramtype">size_t </td> | |
316 <td class="paramname"> <em>inputChannels</em>, </td> | |
317 </tr> | 326 </tr> |
318 <tr> | 327 <tr> |
319 <td class="paramkey"></td> | 328 <td class="paramkey"></td> |
320 <td></td> | 329 <td></td> |
321 <td class="paramtype">size_t </td> | 330 <td class="paramtype">size_t </td> |
322 <td class="paramname"> <em>stepSize</em>, </td> | 331 <td class="paramname"><em>stepSize</em>, </td> |
323 </tr> | 332 </tr> |
324 <tr> | 333 <tr> |
325 <td class="paramkey"></td> | 334 <td class="paramkey"></td> |
326 <td></td> | 335 <td></td> |
327 <td class="paramtype">size_t </td> | 336 <td class="paramtype">size_t </td> |
328 <td class="paramname"> <em>blockSize</em></td><td> </td> | 337 <td class="paramname"><em>blockSize</em> </td> |
329 </tr> | 338 </tr> |
330 <tr> | 339 <tr> |
331 <td></td> | 340 <td></td> |
332 <td>)</td> | 341 <td>)</td> |
333 <td></td><td></td><td><code> [virtual]</code></td> | 342 <td></td><td><code> [virtual]</code></td> |
334 </tr> | 343 </tr> |
335 </table> | 344 </table> |
336 </div> | 345 </div> |
337 <div class="memdoc"> | 346 <div class="memdoc"> |
338 | 347 |
339 <p> | 348 <p>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). </p> |
340 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). | 349 <p>The input sample rate should have been already specified at construction time.</p> |
341 <p> | 350 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p> |
342 The input sample rate should have been already specified at construction time.<p> | 351 |
343 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. | 352 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> |
344 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> | 353 |
345 | 354 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">105</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
346 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">105</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 355 |
347 | 356 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00077">m_stepSize</a>.</p> |
348 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00204">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00199">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="AmplitudeFollower_8h-source.html#l00079">m_clampcoef</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00436">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="AmplitudeFollower_8h-source.html#l00080">m_relaxcoef</a>, and <a class="el" href="AmplitudeFollower_8h-source.html#l00077">m_stepSize</a>.</p> | 357 |
349 | 358 </div> |
350 </div> | 359 </div> |
351 </div><p> | 360 <a class="anchor" id="acebd835e80e84669df078fbd7591d8f7"></a><!-- doxytag: member="AmplitudeFollower::reset" ref="acebd835e80e84669df078fbd7591d8f7" args="()" --> |
352 <a class="anchor" name="cebd835e80e84669df078fbd7591d8f7"></a><!-- doxytag: member="AmplitudeFollower::reset" ref="cebd835e80e84669df078fbd7591d8f7" args="()" --> | 361 <div class="memitem"> |
353 <div class="memitem"> | 362 <div class="memproto"> |
354 <div class="memproto"> | 363 <table class="memname"> |
355 <table class="memname"> | 364 <tr> |
356 <tr> | 365 <td class="memname">void AmplitudeFollower::reset </td> |
357 <td class="memname">void AmplitudeFollower::reset </td> | 366 <td>(</td> |
358 <td>(</td> | 367 <td class="paramname"></td><td>)</td> |
359 <td class="paramname"> </td> | |
360 <td> ) </td> | |
361 <td><code> [virtual]</code></td> | 368 <td><code> [virtual]</code></td> |
362 </tr> | 369 </tr> |
363 </table> | 370 </table> |
364 </div> | 371 </div> |
365 <div class="memdoc"> | 372 <div class="memdoc"> |
366 | 373 |
367 <p> | 374 <p>Reset the plugin after use, to prepare it for another clean run. </p> |
368 Reset the plugin after use, to prepare it for another clean run. | 375 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p> |
369 <p> | 376 |
370 Not called for the first initialisation (i.e. initialise must also do a reset). | 377 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p> |
371 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p> | 378 |
372 | 379 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00122">122</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
373 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00122">122</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 380 |
374 | 381 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>.</p> |
375 <p>References <a class="el" href="AmplitudeFollower_8h-source.html#l00078">m_previn</a>.</p> | 382 |
376 | 383 </div> |
377 </div> | 384 </div> |
378 </div><p> | 385 <a class="anchor" id="afc07a389b5f922b944b0350fd232d2eb"></a><!-- doxytag: member="AmplitudeFollower::getInputDomain" ref="afc07a389b5f922b944b0350fd232d2eb" args="() const " --> |
379 <a class="anchor" name="fc07a389b5f922b944b0350fd232d2eb"></a><!-- doxytag: member="AmplitudeFollower::getInputDomain" ref="fc07a389b5f922b944b0350fd232d2eb" args="() const " --> | 386 <div class="memitem"> |
380 <div class="memitem"> | 387 <div class="memproto"> |
381 <div class="memproto"> | 388 <table class="memname"> |
382 <table class="memname"> | 389 <tr> |
383 <tr> | 390 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> AmplitudeFollower::getInputDomain </td> |
384 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> AmplitudeFollower::getInputDomain </td> | 391 <td>(</td> |
385 <td>(</td> | 392 <td class="paramname"></td><td>)</td> |
386 <td class="paramname"> </td> | |
387 <td> ) </td> | |
388 <td> const<code> [inline, virtual]</code></td> | 393 <td> const<code> [inline, virtual]</code></td> |
389 </tr> | 394 </tr> |
390 </table> | 395 </table> |
391 </div> | 396 </div> |
392 <div class="memdoc"> | 397 <div class="memdoc"> |
393 | 398 |
394 <p> | 399 <p>Get the plugin's required input domain. </p> |
395 Get the plugin's required input domain. | 400 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" 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.</p> |
396 <p> | 401 <p>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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. 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. </p> |
397 If this is TimeDomain, the samples provided to the <a class="el" href="classAmplitudeFollower.html#48d0f95cac31ffd190cff89b50a2a5bd" 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.<p> | 402 |
398 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="classAmplitudeFollower.html#48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. 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. | 403 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> |
399 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> | 404 |
400 | 405 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00056">56</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> |
401 <p>Definition at line <a class="el" href="AmplitudeFollower_8h-source.html#l00056">56</a> of file <a class="el" href="AmplitudeFollower_8h-source.html">AmplitudeFollower.h</a>.</p> | 406 |
402 | 407 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p> |
403 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p> | 408 |
404 | 409 </div> |
405 </div> | 410 </div> |
406 </div><p> | 411 <a class="anchor" id="afe7576af95c8fcc7f5bad42eec9f9f29"></a><!-- doxytag: member="AmplitudeFollower::getIdentifier" ref="afe7576af95c8fcc7f5bad42eec9f9f29" args="() const " --> |
407 <a class="anchor" name="fe7576af95c8fcc7f5bad42eec9f9f29"></a><!-- doxytag: member="AmplitudeFollower::getIdentifier" ref="fe7576af95c8fcc7f5bad42eec9f9f29" args="() const " --> | 412 <div class="memitem"> |
408 <div class="memitem"> | 413 <div class="memproto"> |
409 <div class="memproto"> | 414 <table class="memname"> |
410 <table class="memname"> | 415 <tr> |
411 <tr> | 416 <td class="memname">string AmplitudeFollower::getIdentifier </td> |
412 <td class="memname">string AmplitudeFollower::getIdentifier </td> | 417 <td>(</td> |
413 <td>(</td> | 418 <td class="paramname"></td><td>)</td> |
414 <td class="paramname"> </td> | |
415 <td> ) </td> | |
416 <td> const<code> [virtual]</code></td> | 419 <td> const<code> [virtual]</code></td> |
417 </tr> | 420 </tr> |
418 </table> | 421 </table> |
419 </div> | 422 </div> |
420 <div class="memdoc"> | 423 <div class="memdoc"> |
421 | 424 |
422 <p> | 425 <p>Get the computer-usable name of the plugin. </p> |
423 Get the computer-usable name of the plugin. | 426 <p>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> |
424 <p> | 427 <p>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> |
425 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> | 428 <p>Example: "zero_crossings" </p> |
426 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> | 429 |
427 Example: "zero_crossings" | 430 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> |
428 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> | 431 |
429 | 432 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00069">69</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
430 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00069">69</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 433 |
431 | 434 </div> |
432 </div> | 435 </div> |
433 </div><p> | 436 <a class="anchor" id="a7cfed00bc9d96ba6c709b69ab6a40594"></a><!-- doxytag: member="AmplitudeFollower::getName" ref="a7cfed00bc9d96ba6c709b69ab6a40594" args="() const " --> |
434 <a class="anchor" name="7cfed00bc9d96ba6c709b69ab6a40594"></a><!-- doxytag: member="AmplitudeFollower::getName" ref="7cfed00bc9d96ba6c709b69ab6a40594" args="() const " --> | 437 <div class="memitem"> |
435 <div class="memitem"> | 438 <div class="memproto"> |
436 <div class="memproto"> | 439 <table class="memname"> |
437 <table class="memname"> | 440 <tr> |
438 <tr> | 441 <td class="memname">string AmplitudeFollower::getName </td> |
439 <td class="memname">string AmplitudeFollower::getName </td> | 442 <td>(</td> |
440 <td>(</td> | 443 <td class="paramname"></td><td>)</td> |
441 <td class="paramname"> </td> | |
442 <td> ) </td> | |
443 <td> const<code> [virtual]</code></td> | 444 <td> const<code> [virtual]</code></td> |
444 </tr> | 445 </tr> |
445 </table> | 446 </table> |
446 </div> | 447 </div> |
447 <div class="memdoc"> | 448 <div class="memdoc"> |
448 | 449 |
449 <p> | 450 <p>Get a human-readable name or title of the plugin. </p> |
450 Get a human-readable name or title of the plugin. | 451 <p>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> |
451 <p> | 452 <p>Example: "Zero Crossings" </p> |
452 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> | 453 |
453 Example: "Zero Crossings" | 454 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> |
454 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> | 455 |
455 | 456 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00075">75</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
456 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00075">75</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 457 |
457 | 458 </div> |
458 </div> | 459 </div> |
459 </div><p> | 460 <a class="anchor" id="a6f0f2fea1fdb4b51e688edfe859d5062"></a><!-- doxytag: member="AmplitudeFollower::getDescription" ref="a6f0f2fea1fdb4b51e688edfe859d5062" args="() const " --> |
460 <a class="anchor" name="6f0f2fea1fdb4b51e688edfe859d5062"></a><!-- doxytag: member="AmplitudeFollower::getDescription" ref="6f0f2fea1fdb4b51e688edfe859d5062" args="() const " --> | 461 <div class="memitem"> |
461 <div class="memitem"> | 462 <div class="memproto"> |
462 <div class="memproto"> | 463 <table class="memname"> |
463 <table class="memname"> | 464 <tr> |
464 <tr> | 465 <td class="memname">string AmplitudeFollower::getDescription </td> |
465 <td class="memname">string AmplitudeFollower::getDescription </td> | 466 <td>(</td> |
466 <td>(</td> | 467 <td class="paramname"></td><td>)</td> |
467 <td class="paramname"> </td> | |
468 <td> ) </td> | |
469 <td> const<code> [virtual]</code></td> | 468 <td> const<code> [virtual]</code></td> |
470 </tr> | 469 </tr> |
471 </table> | 470 </table> |
472 </div> | 471 </div> |
473 <div class="memdoc"> | 472 <div class="memdoc"> |
474 | 473 |
475 <p> | 474 <p>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". </p> |
476 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". | 475 <p>May be empty if the name has said it all already.</p> |
477 <p> | 476 <p>Example: "Detect and count zero crossing points" </p> |
478 May be empty if the name has said it all already.<p> | 477 |
479 Example: "Detect and count zero crossing points" | 478 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> |
480 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> | 479 |
481 | 480 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00081">81</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
482 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00081">81</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 481 |
483 | 482 </div> |
484 </div> | 483 </div> |
485 </div><p> | 484 <a class="anchor" id="a44fc43838f203f58bc2ce6e3cb2b03dd"></a><!-- doxytag: member="AmplitudeFollower::getMaker" ref="a44fc43838f203f58bc2ce6e3cb2b03dd" args="() const " --> |
486 <a class="anchor" name="44fc43838f203f58bc2ce6e3cb2b03dd"></a><!-- doxytag: member="AmplitudeFollower::getMaker" ref="44fc43838f203f58bc2ce6e3cb2b03dd" args="() const " --> | 485 <div class="memitem"> |
487 <div class="memitem"> | 486 <div class="memproto"> |
488 <div class="memproto"> | 487 <table class="memname"> |
489 <table class="memname"> | 488 <tr> |
490 <tr> | 489 <td class="memname">string AmplitudeFollower::getMaker </td> |
491 <td class="memname">string AmplitudeFollower::getMaker </td> | 490 <td>(</td> |
492 <td>(</td> | 491 <td class="paramname"></td><td>)</td> |
493 <td class="paramname"> </td> | |
494 <td> ) </td> | |
495 <td> const<code> [virtual]</code></td> | 492 <td> const<code> [virtual]</code></td> |
496 </tr> | 493 </tr> |
497 </table> | 494 </table> |
498 </div> | 495 </div> |
499 <div class="memdoc"> | 496 <div class="memdoc"> |
500 | 497 |
501 <p> | 498 <p>Get the name of the author or vendor of the plugin in human-readable form. </p> |
502 Get the name of the author or vendor of the plugin in human-readable form. | 499 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p> |
503 <p> | 500 |
504 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. | 501 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> |
505 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> | 502 |
506 | 503 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00087">87</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
507 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00087">87</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 504 |
508 | 505 </div> |
509 </div> | 506 </div> |
510 </div><p> | 507 <a class="anchor" id="a8a5d7a834eb996d517c51f84b2a72250"></a><!-- doxytag: member="AmplitudeFollower::getPluginVersion" ref="a8a5d7a834eb996d517c51f84b2a72250" args="() const " --> |
511 <a class="anchor" name="8a5d7a834eb996d517c51f84b2a72250"></a><!-- doxytag: member="AmplitudeFollower::getPluginVersion" ref="8a5d7a834eb996d517c51f84b2a72250" args="() const " --> | 508 <div class="memitem"> |
512 <div class="memitem"> | 509 <div class="memproto"> |
513 <div class="memproto"> | 510 <table class="memname"> |
514 <table class="memname"> | 511 <tr> |
515 <tr> | 512 <td class="memname">int AmplitudeFollower::getPluginVersion </td> |
516 <td class="memname">int AmplitudeFollower::getPluginVersion </td> | 513 <td>(</td> |
517 <td>(</td> | 514 <td class="paramname"></td><td>)</td> |
518 <td class="paramname"> </td> | |
519 <td> ) </td> | |
520 <td> const<code> [virtual]</code></td> | 515 <td> const<code> [virtual]</code></td> |
521 </tr> | 516 </tr> |
522 </table> | 517 </table> |
523 </div> | 518 </div> |
524 <div class="memdoc"> | 519 <div class="memdoc"> |
525 | 520 |
526 <p> | 521 <p>Get the version number of the plugin. </p> |
527 Get the version number of the plugin. | 522 |
528 <p> | 523 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> |
529 | 524 |
530 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> | 525 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00093">93</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
531 | 526 |
532 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00093">93</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 527 </div> |
533 | 528 </div> |
534 </div> | 529 <a class="anchor" id="a0c197fc90f30d91cb4403115c83c9134"></a><!-- doxytag: member="AmplitudeFollower::getCopyright" ref="a0c197fc90f30d91cb4403115c83c9134" args="() const " --> |
535 </div><p> | 530 <div class="memitem"> |
536 <a class="anchor" name="0c197fc90f30d91cb4403115c83c9134"></a><!-- doxytag: member="AmplitudeFollower::getCopyright" ref="0c197fc90f30d91cb4403115c83c9134" args="() const " --> | 531 <div class="memproto"> |
537 <div class="memitem"> | 532 <table class="memname"> |
538 <div class="memproto"> | 533 <tr> |
539 <table class="memname"> | 534 <td class="memname">string AmplitudeFollower::getCopyright </td> |
540 <tr> | 535 <td>(</td> |
541 <td class="memname">string AmplitudeFollower::getCopyright </td> | 536 <td class="paramname"></td><td>)</td> |
542 <td>(</td> | |
543 <td class="paramname"> </td> | |
544 <td> ) </td> | |
545 <td> const<code> [virtual]</code></td> | 537 <td> const<code> [virtual]</code></td> |
546 </tr> | 538 </tr> |
547 </table> | 539 </table> |
548 </div> | 540 </div> |
549 <div class="memdoc"> | 541 <div class="memdoc"> |
550 | 542 |
551 <p> | 543 <p>Get the copyright statement or licensing summary for the plugin. </p> |
552 Get the copyright statement or licensing summary for the plugin. | 544 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p> |
553 <p> | 545 |
554 This can be an informative text, without the same presentation constraints as mentioned for getMaker above. | 546 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> |
555 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> | 547 |
556 | 548 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00099">99</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
557 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00099">99</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 549 |
558 | 550 </div> |
559 </div> | 551 </div> |
560 </div><p> | 552 <a class="anchor" id="a043e3c3db77d76267cd8069e1485bf26"></a><!-- doxytag: member="AmplitudeFollower::getOutputDescriptors" ref="a043e3c3db77d76267cd8069e1485bf26" args="() const " --> |
561 <a class="anchor" name="043e3c3db77d76267cd8069e1485bf26"></a><!-- doxytag: member="AmplitudeFollower::getOutputDescriptors" ref="043e3c3db77d76267cd8069e1485bf26" args="() const " --> | 553 <div class="memitem"> |
562 <div class="memitem"> | 554 <div class="memproto"> |
563 <div class="memproto"> | 555 <table class="memname"> |
564 <table class="memname"> | 556 <tr> |
565 <tr> | 557 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">AmplitudeFollower::OutputList</a> AmplitudeFollower::getOutputDescriptors </td> |
566 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">AmplitudeFollower::OutputList</a> AmplitudeFollower::getOutputDescriptors </td> | 558 <td>(</td> |
567 <td>(</td> | 559 <td class="paramname"></td><td>)</td> |
568 <td class="paramname"> </td> | |
569 <td> ) </td> | |
570 <td> const<code> [virtual]</code></td> | 560 <td> const<code> [virtual]</code></td> |
571 </tr> | 561 </tr> |
572 </table> | 562 </table> |
573 </div> | 563 </div> |
574 <div class="memdoc"> | 564 <div class="memdoc"> |
575 | 565 |
576 <p> | 566 <p>Get the outputs of this plugin. </p> |
577 Get the outputs of this plugin. | 567 <p>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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">process()</a> call. </p> |
578 <p> | 568 |
579 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="classAmplitudeFollower.html#48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">process()</a> call. | 569 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> |
580 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> | 570 |
581 | 571 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">128</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
582 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">128</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 572 |
583 | 573 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00247">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00227">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00239">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00260">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00214">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00278">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00220">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00290">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">Vamp::Plugin::OutputDescriptor::sampleType</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">Vamp::Plugin::OutputDescriptor::unit</a>.</p> |
584 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00247">Vamp::Plugin::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00227">Vamp::Plugin::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00239">Vamp::Plugin::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00260">Vamp::Plugin::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00214">Vamp::Plugin::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00278">Vamp::Plugin::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00220">Vamp::Plugin::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00290">Vamp::Plugin::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00302">Vamp::Plugin::Plugin::OutputDescriptor::sampleType</a>, and <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00232">Vamp::Plugin::Plugin::OutputDescriptor::unit</a>.</p> | 574 |
585 | 575 </div> |
586 </div> | 576 </div> |
587 </div><p> | 577 <a class="anchor" id="a9df01323a09e117bc12354ebe9244edf"></a><!-- doxytag: member="AmplitudeFollower::getParameterDescriptors" ref="a9df01323a09e117bc12354ebe9244edf" args="() const " --> |
588 <a class="anchor" name="9df01323a09e117bc12354ebe9244edf"></a><!-- doxytag: member="AmplitudeFollower::getParameterDescriptors" ref="9df01323a09e117bc12354ebe9244edf" args="() const " --> | 578 <div class="memitem"> |
589 <div class="memitem"> | 579 <div class="memproto"> |
590 <div class="memproto"> | 580 <table class="memname"> |
591 <table class="memname"> | 581 <tr> |
592 <tr> | 582 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">AmplitudeFollower::ParameterList</a> AmplitudeFollower::getParameterDescriptors </td> |
593 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">AmplitudeFollower::ParameterList</a> AmplitudeFollower::getParameterDescriptors </td> | 583 <td>(</td> |
594 <td>(</td> | 584 <td class="paramname"></td><td>)</td> |
595 <td class="paramname"> </td> | |
596 <td> ) </td> | |
597 <td> const<code> [virtual]</code></td> | 585 <td> const<code> [virtual]</code></td> |
598 </tr> | 586 </tr> |
599 </table> | 587 </table> |
600 </div> | 588 </div> |
601 <div class="memdoc"> | 589 <div class="memdoc"> |
602 | 590 |
603 <p> | 591 <p>Get the controllable parameters of this plugin. </p> |
604 Get the controllable parameters of this plugin. | 592 |
605 <p> | 593 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> |
606 | 594 |
607 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> | 595 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">148</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
608 | 596 |
609 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">148</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 597 <p>References <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00171">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00148">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00137">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00177">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00163">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00158">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00142">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00153">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p> |
610 | 598 |
611 <p>References <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00171">Vamp::PluginBase::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00148">Vamp::PluginBase::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00137">Vamp::PluginBase::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00177">Vamp::PluginBase::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00163">Vamp::PluginBase::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00158">Vamp::PluginBase::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00142">Vamp::PluginBase::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00153">Vamp::PluginBase::PluginBase::ParameterDescriptor::unit</a>.</p> | 599 </div> |
612 | 600 </div> |
613 </div> | 601 <a class="anchor" id="ab278c4b6f2ca23248dc94ad775273f39"></a><!-- doxytag: member="AmplitudeFollower::getParameter" ref="ab278c4b6f2ca23248dc94ad775273f39" args="(std::string paramid) const " --> |
614 </div><p> | 602 <div class="memitem"> |
615 <a class="anchor" name="b278c4b6f2ca23248dc94ad775273f39"></a><!-- doxytag: member="AmplitudeFollower::getParameter" ref="b278c4b6f2ca23248dc94ad775273f39" args="(std::string paramid) const " --> | 603 <div class="memproto"> |
616 <div class="memitem"> | 604 <table class="memname"> |
617 <div class="memproto"> | 605 <tr> |
618 <table class="memname"> | 606 <td class="memname">float AmplitudeFollower::getParameter </td> |
619 <tr> | 607 <td>(</td> |
620 <td class="memname">float AmplitudeFollower::getParameter </td> | 608 <td class="paramtype">std::string </td> |
621 <td>(</td> | 609 <td class="paramname"></td><td>)</td> |
622 <td class="paramtype">std::string </td> | |
623 <td class="paramname"> </td> | |
624 <td> ) </td> | |
625 <td> const<code> [virtual]</code></td> | 610 <td> const<code> [virtual]</code></td> |
626 </tr> | 611 </tr> |
627 </table> | 612 </table> |
628 </div> | 613 </div> |
629 <div class="memdoc"> | 614 <div class="memdoc"> |
630 | 615 |
631 <p> | 616 <p>Get the value of a named parameter. </p> |
632 Get the value of a named parameter. | 617 <p>The argument is the identifier field from that parameter's descriptor. </p> |
633 <p> | 618 |
634 The argument is the identifier field from that parameter's descriptor. | 619 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> |
635 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> | 620 |
636 | 621 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">188</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
637 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00188">188</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 622 |
638 | 623 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>.</p> |
639 <p>References <a class="el" href="AmplitudeFollower_8h-source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h-source.html#l00080">m_relaxcoef</a>.</p> | 624 |
640 | 625 </div> |
641 </div> | 626 </div> |
642 </div><p> | 627 <a class="anchor" id="ae1fc37ece4d20e40f3066a3361a99340"></a><!-- doxytag: member="AmplitudeFollower::setParameter" ref="ae1fc37ece4d20e40f3066a3361a99340" args="(std::string paramid, float newval)" --> |
643 <a class="anchor" name="e1fc37ece4d20e40f3066a3361a99340"></a><!-- doxytag: member="AmplitudeFollower::setParameter" ref="e1fc37ece4d20e40f3066a3361a99340" args="(std::string paramid, float newval)" --> | 628 <div class="memitem"> |
644 <div class="memitem"> | 629 <div class="memproto"> |
645 <div class="memproto"> | 630 <table class="memname"> |
646 <table class="memname"> | 631 <tr> |
647 <tr> | 632 <td class="memname">void AmplitudeFollower::setParameter </td> |
648 <td class="memname">void AmplitudeFollower::setParameter </td> | 633 <td>(</td> |
649 <td>(</td> | 634 <td class="paramtype">std::string </td> |
650 <td class="paramtype">std::string </td> | |
651 <td class="paramname">, </td> | 635 <td class="paramname">, </td> |
652 </tr> | 636 </tr> |
653 <tr> | 637 <tr> |
654 <td class="paramkey"></td> | 638 <td class="paramkey"></td> |
655 <td></td> | 639 <td></td> |
656 <td class="paramtype">float </td> | 640 <td class="paramtype">float </td> |
657 <td class="paramname"></td><td> </td> | 641 <td class="paramname"> </td> |
658 </tr> | 642 </tr> |
659 <tr> | 643 <tr> |
660 <td></td> | 644 <td></td> |
661 <td>)</td> | 645 <td>)</td> |
662 <td></td><td></td><td><code> [virtual]</code></td> | 646 <td></td><td><code> [virtual]</code></td> |
663 </tr> | 647 </tr> |
664 </table> | 648 </table> |
665 </div> | 649 </div> |
666 <div class="memdoc"> | 650 <div class="memdoc"> |
667 | 651 |
668 <p> | 652 <p>Set a named parameter. </p> |
669 Set a named parameter. | 653 <p>The first argument is the identifier field from that parameter's descriptor. </p> |
670 <p> | 654 |
671 The first argument is the identifier field from that parameter's descriptor. | 655 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> |
672 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> | 656 |
673 | 657 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">179</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
674 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00179">179</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 658 |
675 | 659 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>.</p> |
676 <p>References <a class="el" href="AmplitudeFollower_8h-source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h-source.html#l00080">m_relaxcoef</a>.</p> | 660 |
677 | 661 </div> |
678 </div> | 662 </div> |
679 </div><p> | 663 <a class="anchor" id="a48d0f95cac31ffd190cff89b50a2a5bd"></a><!-- doxytag: member="AmplitudeFollower::process" ref="a48d0f95cac31ffd190cff89b50a2a5bd" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" --> |
680 <a class="anchor" name="48d0f95cac31ffd190cff89b50a2a5bd"></a><!-- doxytag: member="AmplitudeFollower::process" ref="48d0f95cac31ffd190cff89b50a2a5bd" args="(const float *const *inputBuffers, Vamp::RealTime timestamp)" --> | 664 <div class="memitem"> |
681 <div class="memitem"> | 665 <div class="memproto"> |
682 <div class="memproto"> | 666 <table class="memname"> |
683 <table class="memname"> | 667 <tr> |
684 <tr> | 668 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::process </td> |
685 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::process </td> | 669 <td>(</td> |
686 <td>(</td> | 670 <td class="paramtype">const float *const * </td> |
687 <td class="paramtype">const float *const * </td> | 671 <td class="paramname"><em>inputBuffers</em>, </td> |
688 <td class="paramname"> <em>inputBuffers</em>, </td> | |
689 </tr> | 672 </tr> |
690 <tr> | 673 <tr> |
691 <td class="paramkey"></td> | 674 <td class="paramkey"></td> |
692 <td></td> | 675 <td></td> |
693 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> </td> | 676 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> </td> |
694 <td class="paramname"> <em>timestamp</em></td><td> </td> | 677 <td class="paramname"><em>timestamp</em> </td> |
695 </tr> | 678 </tr> |
696 <tr> | 679 <tr> |
697 <td></td> | 680 <td></td> |
698 <td>)</td> | 681 <td>)</td> |
699 <td></td><td></td><td><code> [virtual]</code></td> | 682 <td></td><td><code> [virtual]</code></td> |
700 </tr> | 683 </tr> |
701 </table> | 684 </table> |
702 </div> | 685 </div> |
703 <div class="memdoc"> | 686 <div class="memdoc"> |
704 | 687 |
705 <p> | 688 <p>Process a single block of input data. </p> |
706 Process a single block of input data. | 689 <p>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 in this case will be the real time in seconds of the start of the supplied block of samples.</p> |
707 <p> | 690 <p>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> |
708 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 in this case will be the real time in seconds of the start of the supplied block of samples.<p> | 691 <p>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.) </p> |
709 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> | 692 |
710 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.) | 693 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> |
711 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> | 694 |
712 | 695 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">200</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
713 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">200</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 696 |
714 | 697 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00077">m_stepSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00374">Vamp::Plugin::Feature::values</a>.</p> |
715 <p>References <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00344">Vamp::Plugin::Plugin::Feature::hasTimestamp</a>, <a class="el" href="AmplitudeFollower_8h-source.html#l00079">m_clampcoef</a>, <a class="el" href="AmplitudeFollower_8h-source.html#l00078">m_previn</a>, <a class="el" href="AmplitudeFollower_8h-source.html#l00080">m_relaxcoef</a>, <a class="el" href="AmplitudeFollower_8h-source.html#l00077">m_stepSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00374">Vamp::Plugin::Plugin::Feature::values</a>.</p> | 698 |
716 | 699 </div> |
717 </div> | 700 </div> |
718 </div><p> | 701 <a class="anchor" id="a368606f643b88e0df0823d85e36f030c"></a><!-- doxytag: member="AmplitudeFollower::getRemainingFeatures" ref="a368606f643b88e0df0823d85e36f030c" args="()" --> |
719 <a class="anchor" name="368606f643b88e0df0823d85e36f030c"></a><!-- doxytag: member="AmplitudeFollower::getRemainingFeatures" ref="368606f643b88e0df0823d85e36f030c" args="()" --> | 702 <div class="memitem"> |
720 <div class="memitem"> | 703 <div class="memproto"> |
721 <div class="memproto"> | 704 <table class="memname"> |
722 <table class="memname"> | 705 <tr> |
723 <tr> | 706 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::getRemainingFeatures </td> |
724 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::getRemainingFeatures </td> | 707 <td>(</td> |
725 <td>(</td> | 708 <td class="paramname"></td><td>)</td> |
726 <td class="paramname"> </td> | |
727 <td> ) </td> | |
728 <td><code> [virtual]</code></td> | 709 <td><code> [virtual]</code></td> |
729 </tr> | 710 </tr> |
730 </table> | 711 </table> |
731 </div> | 712 </div> |
732 <div class="memdoc"> | 713 <div class="memdoc"> |
733 | 714 |
734 <p> | 715 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p> |
735 After all blocks have been processed, calculate and return any remaining features derived from the complete input. | 716 |
736 <p> | 717 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> |
737 | 718 |
738 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> | 719 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00243">243</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> |
739 | 720 |
740 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp-source.html#l00243">243</a> of file <a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a>.</p> | 721 </div> |
741 | 722 </div> |
742 </div> | 723 <a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="AmplitudeFollower::getPreferredBlockSize" ref="aa529adf83f87a603954eb31407602aac" args="() const " --> |
743 </div><p> | 724 <div class="memitem"> |
744 <a class="anchor" name="a529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="AmplitudeFollower::getPreferredBlockSize" ref="a529adf83f87a603954eb31407602aac" args="() const " --> | 725 <div class="memproto"> |
745 <div class="memitem"> | 726 <table class="memname"> |
746 <div class="memproto"> | 727 <tr> |
747 <table class="memname"> | 728 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td> |
748 <tr> | 729 <td>(</td> |
749 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td> | 730 <td class="paramname"></td><td>)</td> |
750 <td>(</td> | |
751 <td class="paramname"> </td> | |
752 <td> ) </td> | |
753 <td> const<code> [inline, virtual, inherited]</code></td> | 731 <td> const<code> [inline, virtual, inherited]</code></td> |
754 </tr> | 732 </tr> |
755 </table> | 733 </table> |
756 </div> | 734 </div> |
757 <div class="memdoc"> | 735 <div class="memdoc"> |
758 | 736 |
759 <p> | 737 <p>Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). </p> |
760 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). | 738 <p>This should be called before <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="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).">initialise()</a>.</p> |
761 <p> | 739 <p>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_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="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).">initialise()</a> call. </p> |
762 This should be called before <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> | 740 |
763 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_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. | 741 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#ad5e0ea8042bdec4dd18428991117e07a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#a68b8569b71504a0478caf990dbe30683">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0">PercussionOnsetDetector</a>.</p> |
764 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#d5e0ea8042bdec4dd18428991117e07a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#68b8569b71504a0478caf990dbe30683">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#410c0b47c6c849d7ed9b726b84402ad0">PercussionOnsetDetector</a>.</p> | 742 |
765 | 743 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00179">179</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
766 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00179">179</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 744 |
767 | 745 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> |
768 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> | 746 |
769 | 747 </div> |
770 </div> | 748 </div> |
771 </div><p> | 749 <a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="AmplitudeFollower::getPreferredStepSize" ref="a514c716c22f81c055f19b56c3f882567" args="() const " --> |
772 <a class="anchor" name="514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="AmplitudeFollower::getPreferredStepSize" ref="514c716c22f81c055f19b56c3f882567" args="() const " --> | 750 <div class="memitem"> |
773 <div class="memitem"> | 751 <div class="memproto"> |
774 <div class="memproto"> | 752 <table class="memname"> |
775 <table class="memname"> | 753 <tr> |
776 <tr> | 754 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td> |
777 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td> | 755 <td>(</td> |
778 <td>(</td> | 756 <td class="paramname"></td><td>)</td> |
779 <td class="paramname"> </td> | |
780 <td> ) </td> | |
781 <td> const<code> [inline, virtual, inherited]</code></td> | 757 <td> const<code> [inline, virtual, inherited]</code></td> |
782 </tr> | 758 </tr> |
783 </table> | 759 </table> |
784 </div> | 760 </div> |
785 <div class="memdoc"> | 761 <div class="memdoc"> |
786 | 762 |
787 <p> | 763 <p>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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. </p> |
788 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_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. | 764 <p>This should be called before <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="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).">initialise()</a>.</p> |
789 <p> | 765 <p>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_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="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).">initialise()</a> call. </p> |
790 This should be called before <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> | 766 |
791 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_1Plugin.html#f26212cf5fc511b603a8b48034247822" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. | 767 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ad979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a859ad5d59402691daed3cf1af1899ebe">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#ad450bb7e7df559ae3d68dfbfb085676f">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968">PercussionOnsetDetector</a>.</p> |
792 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#859ad5d59402691daed3cf1af1899ebe">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#d450bb7e7df559ae3d68dfbfb085676f">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#733824891e11c306a7a678534b89b968">PercussionOnsetDetector</a>.</p> | 768 |
793 | 769 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00194">194</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
794 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00194">194</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 770 |
795 | 771 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> |
796 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> | 772 |
797 | 773 </div> |
798 </div> | 774 </div> |
799 </div><p> | 775 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="AmplitudeFollower::getMinChannelCount" ref="a267b42e866df3cf0d190893e8096f525" args="() const " --> |
800 <a class="anchor" name="267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="AmplitudeFollower::getMinChannelCount" ref="267b42e866df3cf0d190893e8096f525" args="() const " --> | 776 <div class="memitem"> |
801 <div class="memitem"> | 777 <div class="memproto"> |
802 <div class="memproto"> | 778 <table class="memname"> |
803 <table class="memname"> | 779 <tr> |
804 <tr> | 780 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td> |
805 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td> | 781 <td>(</td> |
806 <td>(</td> | 782 <td class="paramname"></td><td>)</td> |
807 <td class="paramname"> </td> | |
808 <td> ) </td> | |
809 <td> const<code> [inline, virtual, inherited]</code></td> | 783 <td> const<code> [inline, virtual, inherited]</code></td> |
810 </tr> | 784 </tr> |
811 </table> | 785 </table> |
812 </div> | 786 </div> |
813 <div class="memdoc"> | 787 <div class="memdoc"> |
814 | 788 |
815 <p> | 789 <p>Get the minimum supported number of input channels. </p> |
816 Get the minimum supported number of input channels. | 790 |
817 <p> | 791 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p> |
818 | 792 |
819 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p> | 793 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
820 | 794 |
821 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 795 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> |
822 | 796 |
823 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">PowerSpectrum::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00676">FixedTempoEstimator::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> | 797 </div> |
824 | 798 </div> |
825 </div> | 799 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="AmplitudeFollower::getMaxChannelCount" ref="a2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " --> |
826 </div><p> | 800 <div class="memitem"> |
827 <a class="anchor" name="2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="AmplitudeFollower::getMaxChannelCount" ref="2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " --> | 801 <div class="memproto"> |
828 <div class="memitem"> | 802 <table class="memname"> |
829 <div class="memproto"> | 803 <tr> |
830 <table class="memname"> | 804 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td> |
831 <tr> | 805 <td>(</td> |
832 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td> | 806 <td class="paramname"></td><td>)</td> |
833 <td>(</td> | |
834 <td class="paramname"> </td> | |
835 <td> ) </td> | |
836 <td> const<code> [inline, virtual, inherited]</code></td> | 807 <td> const<code> [inline, virtual, inherited]</code></td> |
837 </tr> | 808 </tr> |
838 </table> | 809 </table> |
839 </div> | 810 </div> |
840 <div class="memdoc"> | 811 <div class="memdoc"> |
841 | 812 |
842 <p> | 813 <p>Get the maximum supported number of input channels. </p> |
843 Get the maximum supported number of input channels. | 814 |
844 <p> | 815 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p> |
845 | 816 |
846 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p> | 817 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
847 | 818 |
848 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 819 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> |
849 | 820 |
850 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00092">PowerSpectrum::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00676">FixedTempoEstimator::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> | 821 </div> |
851 | 822 </div> |
852 </div> | 823 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="AmplitudeFollower::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " --> |
853 </div><p> | 824 <div class="memitem"> |
854 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="AmplitudeFollower::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " --> | 825 <div class="memproto"> |
855 <div class="memitem"> | 826 <table class="memname"> |
856 <div class="memproto"> | 827 <tr> |
857 <table class="memname"> | 828 <td class="memname">virtual std::string Vamp::Plugin::getType </td> |
858 <tr> | 829 <td>(</td> |
859 <td class="memname">virtual std::string Vamp::Plugin::getType </td> | 830 <td class="paramname"></td><td>)</td> |
860 <td>(</td> | |
861 <td class="paramname"> </td> | |
862 <td> ) </td> | |
863 <td> const<code> [inline, virtual, inherited]</code></td> | 831 <td> const<code> [inline, virtual, inherited]</code></td> |
864 </tr> | 832 </tr> |
865 </table> | 833 </table> |
866 </div> | 834 </div> |
867 <div class="memdoc"> | 835 <div class="memdoc"> |
868 | 836 |
869 <p> | 837 <p>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 from audio o...">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>. </p> |
870 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>. | 838 <p>Do not reimplement this function in your subclass. </p> |
871 <p> | 839 |
872 Do not reimplement this function in your subclass. | 840 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> |
873 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> | 841 |
874 | 842 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00430">430</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
875 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00430">430</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 843 |
876 | 844 </div> |
877 </div> | 845 </div> |
878 </div><p> | 846 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="AmplitudeFollower::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " --> |
879 <a class="anchor" name="8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="AmplitudeFollower::getVampApiVersion" ref="8fd2c48291c64b790f0efb8948508dcf" args="() const " --> | 847 <div class="memitem"> |
880 <div class="memitem"> | 848 <div class="memproto"> |
881 <div class="memproto"> | 849 <table class="memname"> |
882 <table class="memname"> | 850 <tr> |
883 <tr> | 851 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td> |
884 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td> | 852 <td>(</td> |
885 <td>(</td> | 853 <td class="paramname"></td><td>)</td> |
886 <td class="paramname"> </td> | |
887 <td> ) </td> | |
888 <td> const<code> [inline, virtual, inherited]</code></td> | 854 <td> const<code> [inline, virtual, inherited]</code></td> |
889 </tr> | 855 </tr> |
890 </table> | 856 </table> |
891 </div> | 857 </div> |
892 <div class="memdoc"> | 858 <div class="memdoc"> |
893 | 859 |
894 <p> | 860 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> |
895 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. | 861 |
896 <p> | 862 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p> |
897 | 863 |
898 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p> | 864 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00072">72</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> |
899 | 865 |
900 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00072">72</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> | 866 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> |
901 | 867 |
902 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p> | 868 </div> |
903 | 869 </div> |
904 </div> | 870 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="AmplitudeFollower::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " --> |
905 </div><p> | 871 <div class="memitem"> |
906 <a class="anchor" name="bb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="AmplitudeFollower::getPrograms" ref="bb307c60bdb981d5f5af50c3c4ae84af" args="() const " --> | 872 <div class="memproto"> |
907 <div class="memitem"> | 873 <table class="memname"> |
908 <div class="memproto"> | 874 <tr> |
909 <table class="memname"> | 875 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td> |
910 <tr> | 876 <td>(</td> |
911 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td> | 877 <td class="paramname"></td><td>)</td> |
912 <td>(</td> | |
913 <td class="paramname"> </td> | |
914 <td> ) </td> | |
915 <td> const<code> [inline, virtual, inherited]</code></td> | 878 <td> const<code> [inline, virtual, inherited]</code></td> |
916 </tr> | 879 </tr> |
917 </table> | 880 </table> |
918 </div> | 881 </div> |
919 <div class="memdoc"> | 882 <div class="memdoc"> |
920 | 883 |
921 <p> | 884 <p>Get the program settings available in this plugin. </p> |
922 Get the program settings available in this plugin. | 885 <p>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> |
923 <p> | 886 <p>The programs must have unique names. </p> |
924 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> | 887 |
925 The programs must have unique names. | 888 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p> |
926 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#e0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p> | 889 |
927 | 890 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00237">237</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> |
928 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00237">237</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> | 891 |
929 | 892 </div> |
930 </div> | 893 </div> |
931 </div><p> | 894 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="AmplitudeFollower::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " --> |
932 <a class="anchor" name="24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="AmplitudeFollower::getCurrentProgram" ref="24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " --> | 895 <div class="memitem"> |
933 <div class="memitem"> | 896 <div class="memproto"> |
934 <div class="memproto"> | 897 <table class="memname"> |
935 <table class="memname"> | 898 <tr> |
936 <tr> | 899 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td> |
937 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td> | 900 <td>(</td> |
938 <td>(</td> | 901 <td class="paramname"></td><td>)</td> |
939 <td class="paramname"> </td> | |
940 <td> ) </td> | |
941 <td> const<code> [inline, virtual, inherited]</code></td> | 902 <td> const<code> [inline, virtual, inherited]</code></td> |
942 </tr> | 903 </tr> |
943 </table> | 904 </table> |
944 </div> | 905 </div> |
945 <div class="memdoc"> | 906 <div class="memdoc"> |
946 | 907 |
947 <p> | 908 <p>Get the current program. </p> |
948 Get the current program. | 909 |
949 <p> | 910 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p> |
950 | 911 |
951 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p> | 912 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00242">242</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> |
952 | 913 |
953 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00242">242</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> | 914 </div> |
954 | 915 </div> |
955 </div> | 916 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="AmplitudeFollower::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" --> |
956 </div><p> | 917 <div class="memitem"> |
957 <a class="anchor" name="add3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="AmplitudeFollower::selectProgram" ref="add3a547ef140bae200473a9518e3353" args="(std::string)" --> | 918 <div class="memproto"> |
958 <div class="memitem"> | 919 <table class="memname"> |
959 <div class="memproto"> | 920 <tr> |
960 <table class="memname"> | 921 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td> |
961 <tr> | 922 <td>(</td> |
962 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td> | 923 <td class="paramtype">std::string </td> |
963 <td>(</td> | 924 <td class="paramname"></td><td>)</td> |
964 <td class="paramtype">std::string </td> | |
965 <td class="paramname"> </td> | |
966 <td> ) </td> | |
967 <td><code> [inline, virtual, inherited]</code></td> | 925 <td><code> [inline, virtual, inherited]</code></td> |
968 </tr> | 926 </tr> |
969 </table> | 927 </table> |
970 </div> | 928 </div> |
971 <div class="memdoc"> | 929 <div class="memdoc"> |
972 | 930 |
973 <p> | 931 <p>Select a program. </p> |
974 Select a program. | 932 <p>(If the given program name is not one of the available programs, do nothing.) </p> |
975 <p> | 933 |
976 (If the given program name is not one of the available programs, do nothing.) | 934 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> |
977 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> | 935 |
978 | 936 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00248">248</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> |
979 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00248">248</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> | 937 |
980 | 938 </div> |
981 </div> | 939 </div> |
982 </div><p> | 940 <hr/><h2>Member Data Documentation</h2> |
983 <hr><h2>Member Data Documentation</h2> | 941 <a class="anchor" id="a959c2647fd3c5feea2591e3618774027"></a><!-- doxytag: member="AmplitudeFollower::m_stepSize" ref="a959c2647fd3c5feea2591e3618774027" args="" --> |
984 <a class="anchor" name="959c2647fd3c5feea2591e3618774027"></a><!-- doxytag: member="AmplitudeFollower::m_stepSize" ref="959c2647fd3c5feea2591e3618774027" args="" --> | 942 <div class="memitem"> |
985 <div class="memitem"> | 943 <div class="memproto"> |
986 <div class="memproto"> | 944 <table class="memname"> |
987 <table class="memname"> | 945 <tr> |
988 <tr> | 946 <td class="memname">size_t <a class="el" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">AmplitudeFollower::m_stepSize</a><code> [protected]</code></td> |
989 <td class="memname">size_t <a class="el" href="classAmplitudeFollower.html#959c2647fd3c5feea2591e3618774027">AmplitudeFollower::m_stepSize</a><code> [protected]</code> </td> | 947 </tr> |
990 </tr> | 948 </table> |
991 </table> | 949 </div> |
992 </div> | 950 <div class="memdoc"> |
993 <div class="memdoc"> | 951 |
994 | 952 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00077">77</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> |
995 <p> | 953 |
996 | 954 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>.</p> |
997 <p>Definition at line <a class="el" href="AmplitudeFollower_8h-source.html#l00077">77</a> of file <a class="el" href="AmplitudeFollower_8h-source.html">AmplitudeFollower.h</a>.</p> | 955 |
998 | 956 </div> |
999 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">initialise()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">process()</a>.</p> | 957 </div> |
1000 | 958 <a class="anchor" id="ac95e8d2f334821c6c92c706bae29695a"></a><!-- doxytag: member="AmplitudeFollower::m_previn" ref="ac95e8d2f334821c6c92c706bae29695a" args="" --> |
1001 </div> | 959 <div class="memitem"> |
1002 </div><p> | 960 <div class="memproto"> |
1003 <a class="anchor" name="c95e8d2f334821c6c92c706bae29695a"></a><!-- doxytag: member="AmplitudeFollower::m_previn" ref="c95e8d2f334821c6c92c706bae29695a" args="" --> | 961 <table class="memname"> |
1004 <div class="memitem"> | 962 <tr> |
1005 <div class="memproto"> | 963 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">AmplitudeFollower::m_previn</a><code> [protected]</code></td> |
1006 <table class="memname"> | 964 </tr> |
1007 <tr> | 965 </table> |
1008 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#c95e8d2f334821c6c92c706bae29695a">AmplitudeFollower::m_previn</a><code> [protected]</code> </td> | 966 </div> |
1009 </tr> | 967 <div class="memdoc"> |
1010 </table> | 968 |
1011 </div> | 969 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00078">78</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> |
1012 <div class="memdoc"> | 970 |
1013 | 971 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00122">reset()</a>.</p> |
1014 <p> | 972 |
1015 | 973 </div> |
1016 <p>Definition at line <a class="el" href="AmplitudeFollower_8h-source.html#l00078">78</a> of file <a class="el" href="AmplitudeFollower_8h-source.html">AmplitudeFollower.h</a>.</p> | 974 </div> |
1017 | 975 <a class="anchor" id="a1cb205b08cfe2ce94a4af05b18f72876"></a><!-- doxytag: member="AmplitudeFollower::m_clampcoef" ref="a1cb205b08cfe2ce94a4af05b18f72876" args="" --> |
1018 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00122">reset()</a>.</p> | 976 <div class="memitem"> |
1019 | 977 <div class="memproto"> |
1020 </div> | 978 <table class="memname"> |
1021 </div><p> | 979 <tr> |
1022 <a class="anchor" name="1cb205b08cfe2ce94a4af05b18f72876"></a><!-- doxytag: member="AmplitudeFollower::m_clampcoef" ref="1cb205b08cfe2ce94a4af05b18f72876" args="" --> | 980 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">AmplitudeFollower::m_clampcoef</a><code> [protected]</code></td> |
1023 <div class="memitem"> | 981 </tr> |
1024 <div class="memproto"> | 982 </table> |
1025 <table class="memname"> | 983 </div> |
1026 <tr> | 984 <div class="memdoc"> |
1027 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#1cb205b08cfe2ce94a4af05b18f72876">AmplitudeFollower::m_clampcoef</a><code> [protected]</code> </td> | 985 |
1028 </tr> | 986 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00079">79</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> |
1029 </table> | 987 |
1030 </div> | 988 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">setParameter()</a>.</p> |
1031 <div class="memdoc"> | 989 |
1032 | 990 </div> |
1033 <p> | 991 </div> |
1034 | 992 <a class="anchor" id="aceecd3b3879f32eb4a2e597c32c41cfc"></a><!-- doxytag: member="AmplitudeFollower::m_relaxcoef" ref="aceecd3b3879f32eb4a2e597c32c41cfc" args="" --> |
1035 <p>Definition at line <a class="el" href="AmplitudeFollower_8h-source.html#l00079">79</a> of file <a class="el" href="AmplitudeFollower_8h-source.html">AmplitudeFollower.h</a>.</p> | 993 <div class="memitem"> |
1036 | 994 <div class="memproto"> |
1037 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp-source.html#l00188">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00179">setParameter()</a>.</p> | 995 <table class="memname"> |
1038 | 996 <tr> |
1039 </div> | 997 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">AmplitudeFollower::m_relaxcoef</a><code> [protected]</code></td> |
1040 </div><p> | 998 </tr> |
1041 <a class="anchor" name="ceecd3b3879f32eb4a2e597c32c41cfc"></a><!-- doxytag: member="AmplitudeFollower::m_relaxcoef" ref="ceecd3b3879f32eb4a2e597c32c41cfc" args="" --> | 999 </table> |
1042 <div class="memitem"> | 1000 </div> |
1043 <div class="memproto"> | 1001 <div class="memdoc"> |
1044 <table class="memname"> | 1002 |
1045 <tr> | 1003 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00080">80</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> |
1046 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#ceecd3b3879f32eb4a2e597c32c41cfc">AmplitudeFollower::m_relaxcoef</a><code> [protected]</code> </td> | 1004 |
1047 </tr> | 1005 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">setParameter()</a>.</p> |
1048 </table> | 1006 |
1049 </div> | 1007 </div> |
1050 <div class="memdoc"> | 1008 </div> |
1051 | 1009 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="AmplitudeFollower::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" --> |
1052 <p> | 1010 <div class="memitem"> |
1053 | 1011 <div class="memproto"> |
1054 <p>Definition at line <a class="el" href="AmplitudeFollower_8h-source.html#l00080">80</a> of file <a class="el" href="AmplitudeFollower_8h-source.html">AmplitudeFollower.h</a>.</p> | 1012 <table class="memname"> |
1055 | 1013 <tr> |
1056 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp-source.html#l00188">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00179">setParameter()</a>.</p> | 1014 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td> |
1057 | 1015 </tr> |
1058 </div> | 1016 </table> |
1059 </div><p> | 1017 </div> |
1060 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="AmplitudeFollower::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" --> | 1018 <div class="memdoc"> |
1061 <div class="memitem"> | 1019 |
1062 <div class="memproto"> | 1020 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">436</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> |
1063 <table class="memname"> | 1021 |
1064 <tr> | 1022 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00375">FixedTempoEstimator::D::calculate()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p> |
1065 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td> | 1023 |
1066 </tr> | 1024 </div> |
1067 </table> | 1025 </div> |
1068 </div> | 1026 <hr/>The documentation for this class was generated from the following files:<ul> |
1069 <div class="memdoc"> | 1027 <li><a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a></li> |
1070 | 1028 <li><a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a></li> |
1071 <p> | 1029 </ul> |
1072 | 1030 </div> |
1073 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00436">436</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> | 1031 </div> |
1074 | 1032 <div id="nav-path" class="navpath"> |
1075 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">initialise()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00146">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p> | 1033 <ul> |
1076 | 1034 <li class="navelem"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> </li> |
1077 </div> | 1035 |
1078 </div><p> | 1036 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by |
1079 <hr>The documentation for this class was generated from the following files:<ul> | 1037 <a href="http://www.doxygen.org/index.html"> |
1080 <li><a class="el" href="AmplitudeFollower_8h-source.html">AmplitudeFollower.h</a><li><a class="el" href="AmplitudeFollower_8cpp-source.html">AmplitudeFollower.cpp</a></ul> | 1038 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> |
1081 </div> | 1039 </ul> |
1082 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by | 1040 </div> |
1083 <a href="http://www.doxygen.org/index.html"> | 1041 |
1084 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> | 1042 |
1085 </body> | 1043 </body> |
1086 </html> | 1044 </html> |