# HG changeset patch # User Chris Cannam # Date 1342182627 -3600 # Node ID 5c2683745b33bee82bee07e2e0b56f0f3f010063 # Parent 52d16fb98e801a0a54f96bdc5827689a25b51f08 Update for 2.4 diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/AmplitudeFollower_8cpp.html --- a/code-docs/AmplitudeFollower_8cpp.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/AmplitudeFollower_8cpp.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: AmplitudeFollower.cpp File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +

Go to the source code of this file.

-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/AmplitudeFollower_8cpp_source.html --- a/code-docs/AmplitudeFollower_8cpp_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/AmplitudeFollower_8cpp_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: AmplitudeFollower.cpp Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -317,15 +318,15 @@
 00245     return FeatureSet();
 00246 }
 00247 
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/AmplitudeFollower_8h.html --- a/code-docs/AmplitudeFollower_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/AmplitudeFollower_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: AmplitudeFollower.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
AmplitudeFollower.h File Reference
- +

Go to the source code of this file.

- - + +

Classes

class  AmplitudeFollower
 Example plugin implementing the SuperCollider amplitude follower function. More...
class  AmplitudeFollower
 Example plugin implementing the SuperCollider amplitude follower function. More...
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/AmplitudeFollower_8h_source.html --- a/code-docs/AmplitudeFollower_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/AmplitudeFollower_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: AmplitudeFollower.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -116,7 +117,7 @@
 00039 
 00040 #include "vamp-sdk/Plugin.h"
 00041 
-00047 class AmplitudeFollower : public Vamp::Plugin
+00047 class AmplitudeFollower : public Vamp::Plugin
 00048 {
 00049 public:
 00050     AmplitudeFollower(float inputSampleRate);
@@ -154,15 +155,15 @@
 00082 
 00083 
 00084 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/FFT_8h.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/FFT_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,107 @@ + + + + + +VampPluginSDK: FFT.h File Reference + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + +
+
VampPluginSDK +  2.4 +
+ +
+
+ + + + +
+
+ +
+
+
+ +
+
+
+Classes | +Namespaces
+
+
FFT.h File Reference
+
+
+ +

Go to the source code of this file.

+ + + + + + +

+Classes

class  Vamp::FFT
 A simple FFT implementation provided for convenience of plugin authors. More...

+Namespaces

namespace  Vamp
+
+
+ + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/FFT_8h_source.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/FFT_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,154 @@ + + + + + +VampPluginSDK: FFT.h Source File + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + +
+
VampPluginSDK +  2.4 +
+ +
+
+ + + + +
+
+ +
+
+
+ +
+
+
+
FFT.h
+
+
+Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+00002 
+00003 /*
+00004     Vamp
+00005 
+00006     An API for audio analysis and feature extraction plugins.
+00007 
+00008     Centre for Digital Music, Queen Mary, University of London.
+00009     Copyright 2006-2012 Chris Cannam and QMUL.
+00010   
+00011     Permission is hereby granted, free of charge, to any person
+00012     obtaining a copy of this software and associated documentation
+00013     files (the "Software"), to deal in the Software without
+00014     restriction, including without limitation the rights to use, copy,
+00015     modify, merge, publish, distribute, sublicense, and/or sell copies
+00016     of the Software, and to permit persons to whom the Software is
+00017     furnished to do so, subject to the following conditions:
+00018 
+00019     The above copyright notice and this permission notice shall be
+00020     included in all copies or substantial portions of the Software.
+00021 
+00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+00029 
+00030     Except as contained in this notice, the names of the Centre for
+00031     Digital Music; Queen Mary, University of London; and Chris Cannam
+00032     shall not be used in advertising or otherwise to promote the sale,
+00033     use or other dealings in this Software without prior written
+00034     authorization.
+00035 */
+00036 
+00037 #ifndef _VAMP_FFT_H_
+00038 #define _VAMP_FFT_H_
+00039 
+00040 #include "plugguard.h"
+00041 _VAMP_SDK_PLUGSPACE_BEGIN(FFT.h)
+00042 
+00043 namespace Vamp {
+00044 
+00058 class FFT
+00059 {
+00060 public:
+00072     static void forward(unsigned int n,
+00073                         const double *ri, const double *ii,
+00074                         double *ro, double *io);
+00075 
+00089     static void inverse(unsigned int n,
+00090                         const double *ri, const double *ii,
+00091                         double *ro, double *io);
+00092 };
+00093 
+00094 }
+00095 
+00096 _VAMP_SDK_PLUGSPACE_END(FFT.h)
+00097 
+00098 #endif
+
+
+ + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/FixedTempoEstimator_8cpp.html --- a/code-docs/FixedTempoEstimator_8cpp.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/FixedTempoEstimator_8cpp.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: FixedTempoEstimator.cpp File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
FixedTempoEstimator.cpp File Reference
- +

Go to the source code of this file.

- + - - - - - + + + + +

Classes

class  FixedTempoEstimator::D
class  FixedTempoEstimator::D

Variables

static int TempoOutput = 0
static int CandidatesOutput = 1
static int DFOutput = 2
static int ACFOutput = 3
static int FilteredACFOutput = 4
static int TempoOutput = 0
static int CandidatesOutput = 1
static int DFOutput = 2
static int ACFOutput = 3
static int FilteredACFOutput = 4

Variable Documentation

- +
@@ -110,7 +111,7 @@ - +
@@ -127,7 +128,7 @@ - +
@@ -144,7 +145,7 @@ - +
@@ -161,7 +162,7 @@ - +
@@ -178,15 +179,15 @@ - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/FixedTempoEstimator_8cpp.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/FixedTempoEstimator_8cpp.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,8 @@ +var FixedTempoEstimator_8cpp = +[ + [ "TempoOutput", "FixedTempoEstimator_8cpp.html#a7a8511e62dffb5334ad3b70d57b2fcee", null ], + [ "CandidatesOutput", "FixedTempoEstimator_8cpp.html#a554b16c6b7516530e52c65318bfe08eb", null ], + [ "DFOutput", "FixedTempoEstimator_8cpp.html#acaa4524f29afce03c812a88ff31159c1", null ], + [ "ACFOutput", "FixedTempoEstimator_8cpp.html#a382c1fe740ac8911c6078cfbceffc870", null ], + [ "FilteredACFOutput", "FixedTempoEstimator_8cpp.html#a5b284021783d79785d46b043b458368d", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/FixedTempoEstimator_8cpp_source.html --- a/code-docs/FixedTempoEstimator_8cpp_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/FixedTempoEstimator_8cpp_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: FixedTempoEstimator.cpp Source File @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
VampPluginSDK -  2.1 +  2.4
- +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -800,15 +801,15 @@
 00723 {
 00724     return m_d->getRemainingFeatures();
 00725 }
-
+
diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/FixedTempoEstimator_8h.html --- a/code-docs/FixedTempoEstimator_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/FixedTempoEstimator_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: FixedTempoEstimator.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
FixedTempoEstimator.h File Reference
- +

Go to the source code of this file.

- - + +

Classes

class  FixedTempoEstimator
 Example plugin that estimates the tempo of a short fixed-tempo sample. More...
class  FixedTempoEstimator
 Example plugin that estimates the tempo of a short fixed-tempo sample. More...
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/FixedTempoEstimator_8h_source.html --- a/code-docs/FixedTempoEstimator_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/FixedTempoEstimator_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: FixedTempoEstimator.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -116,7 +117,7 @@
 00039 
 00040 #include "vamp-sdk/Plugin.h"
 00041 
-00046 class FixedTempoEstimator : public Vamp::Plugin
+00046 class FixedTempoEstimator : public Vamp::Plugin
 00047 {
 00048 public:
 00049     FixedTempoEstimator(float inputSampleRate);
@@ -155,15 +156,15 @@
 00082 
 00083 
 00084 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PercussionOnsetDetector_8cpp.html --- a/code-docs/PercussionOnsetDetector_8cpp.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PercussionOnsetDetector_8cpp.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PercussionOnsetDetector.cpp File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +

Go to the source code of this file.

-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PercussionOnsetDetector_8cpp_source.html --- a/code-docs/PercussionOnsetDetector_8cpp_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PercussionOnsetDetector_8cpp_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PercussionOnsetDetector.cpp Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -362,15 +363,15 @@
 00285     return FeatureSet();
 00286 }
 00287 
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PercussionOnsetDetector_8h.html --- a/code-docs/PercussionOnsetDetector_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PercussionOnsetDetector_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PercussionOnsetDetector.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PercussionOnsetDetector.h File Reference
- +

Go to the source code of this file.

- - + +

Classes

class  PercussionOnsetDetector
 Example plugin that detects percussive events. More...
class  PercussionOnsetDetector
 Example plugin that detects percussive events. More...
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PercussionOnsetDetector_8h_source.html --- a/code-docs/PercussionOnsetDetector_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PercussionOnsetDetector_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PercussionOnsetDetector.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -116,7 +117,7 @@
 00039 
 00040 #include "vamp-sdk/Plugin.h"
 00041 
-00046 class PercussionOnsetDetector : public Vamp::Plugin
+00046 class PercussionOnsetDetector : public Vamp::Plugin
 00047 {
 00048 public:
 00049     PercussionOnsetDetector(float inputSampleRate);
@@ -161,15 +162,15 @@
 00088 
 00089 
 00090 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginAdapter_8h.html --- a/code-docs/PluginAdapter_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginAdapter_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginAdapter.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PluginAdapter.h File Reference
- +

Go to the source code of this file.

- - - - + + + + - +

Classes

class  Vamp::PluginAdapterBase
 PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its C++ Vamp::Plugin objects available through the Vamp C API. More...
class  Vamp::PluginAdapter< P >
 PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementation. More...
class  Vamp::PluginAdapterBase
 PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its C++ Vamp::Plugin objects available through the Vamp C API. More...
class  Vamp::PluginAdapter< P >
 PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementation. More...

Namespaces

namespace  Vamp
namespace  Vamp
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginAdapter_8h_source.html --- a/code-docs/PluginAdapter_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginAdapter_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginAdapter.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -168,15 +169,15 @@
 00119 
 00120 #endif
 00121 
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginBufferingAdapter_8h.html --- a/code-docs/PluginBufferingAdapter_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginBufferingAdapter_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginBufferingAdapter.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PluginBufferingAdapter.h File Reference
- +

Go to the source code of this file.

- - + + - - + +

Classes

class  Vamp::HostExt::PluginBufferingAdapter
 PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size. More...
class  Vamp::HostExt::PluginBufferingAdapter
 PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size. More...

Namespaces

namespace  Vamp
namespace  Vamp::HostExt
namespace  Vamp
namespace  Vamp::HostExt
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginBufferingAdapter_8h_source.html --- a/code-docs/PluginBufferingAdapter_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginBufferingAdapter_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginBufferingAdapter.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -169,15 +170,15 @@
 00192 _VAMP_SDK_HOSTSPACE_END(PluginBufferingAdapter.h)
 00193 
 00194 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginChannelAdapter_8h.html --- a/code-docs/PluginChannelAdapter_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginChannelAdapter_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginChannelAdapter.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PluginChannelAdapter.h File Reference
- +

Go to the source code of this file.

- - + + - - + +

Classes

class  Vamp::HostExt::PluginChannelAdapter
 PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data. More...
class  Vamp::HostExt::PluginChannelAdapter
 PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data. More...

Namespaces

namespace  Vamp
namespace  Vamp::HostExt
namespace  Vamp
namespace  Vamp::HostExt
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginChannelAdapter_8h_source.html --- a/code-docs/PluginChannelAdapter_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginChannelAdapter_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginChannelAdapter.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -147,15 +148,15 @@
 00147 _VAMP_SDK_HOSTSPACE_END(PluginChannelAdapter.h)
 00148 
 00149 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginHostAdapter_8h.html --- a/code-docs/PluginHostAdapter_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginHostAdapter_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginHostAdapter.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PluginHostAdapter.h File Reference
- +

Go to the source code of this file.

- - + + - +

Classes

class  Vamp::PluginHostAdapter
 PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescriptor object appear as a C++ Vamp::Plugin object. More...
class  Vamp::PluginHostAdapter
 PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescriptor object appear as a C++ Vamp::Plugin object. More...

Namespaces

namespace  Vamp
namespace  Vamp
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginHostAdapter_8h_source.html --- a/code-docs/PluginHostAdapter_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginHostAdapter_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginHostAdapter.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -181,15 +182,15 @@
 00121 #endif
 00122 
 00123 
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginInputDomainAdapter_8h.html --- a/code-docs/PluginInputDomainAdapter_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginInputDomainAdapter_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginInputDomainAdapter.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PluginInputDomainAdapter.h File Reference
- +

Go to the source code of this file.

- - + + - - + +

Classes

class  Vamp::HostExt::PluginInputDomainAdapter
 PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-domain input for plugins that need it. More...
class  Vamp::HostExt::PluginInputDomainAdapter
 PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-domain input for plugins that need it. More...

Namespaces

namespace  Vamp
namespace  Vamp::HostExt
namespace  Vamp
namespace  Vamp::HostExt
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginInputDomainAdapter_8h_source.html --- a/code-docs/PluginInputDomainAdapter_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginInputDomainAdapter_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginInputDomainAdapter.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -187,15 +188,15 @@
 00234 _VAMP_SDK_HOSTSPACE_END(PluginInputDomainAdapter.h)
 00235 
 00236 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginLoader_8h.html --- a/code-docs/PluginLoader_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginLoader_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginLoader.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PluginLoader.h File Reference
- +

Go to the source code of this file.

- - + + - - + +

Classes

class  Vamp::HostExt::PluginLoader
 Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the typical plugin-path, library naming, and categorisation conventions described in the Vamp SDK documentation. More...
class  Vamp::HostExt::PluginLoader
 Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the typical plugin-path, library naming, and categorisation conventions described in the Vamp SDK documentation. More...

Namespaces

namespace  Vamp
namespace  Vamp::HostExt
namespace  Vamp
namespace  Vamp::HostExt
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginLoader_8h_source.html --- a/code-docs/PluginLoader_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginLoader_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginLoader.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -182,15 +183,15 @@
 00241 
 00242 #endif
 00243 
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginSummarisingAdapter_8h.html --- a/code-docs/PluginSummarisingAdapter_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginSummarisingAdapter_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginSummarisingAdapter.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PluginSummarisingAdapter.h File Reference
- +

Go to the source code of this file.

- - + + - - + +

Classes

class  Vamp::HostExt::PluginSummarisingAdapter
 PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean and median averages of output features, for use in any context where an available plugin produces individual values but the result that is actually needed is some sort of aggregate. More...
class  Vamp::HostExt::PluginSummarisingAdapter
 PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean and median averages of output features, for use in any context where an available plugin produces individual values but the result that is actually needed is some sort of aggregate. More...

Namespaces

namespace  Vamp
namespace  Vamp::HostExt
namespace  Vamp
namespace  Vamp::HostExt
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginSummarisingAdapter_8h_source.html --- a/code-docs/PluginSummarisingAdapter_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginSummarisingAdapter_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginSummarisingAdapter.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -180,15 +181,15 @@
 00195 _VAMP_SDK_HOSTSPACE_END(PluginSummarisingAdapter.h)
 00196 
 00197 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginWrapper_8h.html --- a/code-docs/PluginWrapper_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginWrapper_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginWrapper.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PluginWrapper.h File Reference
- +

Go to the source code of this file.

- - + + - - + +

Classes

class  Vamp::HostExt::PluginWrapper
 PluginWrapper is a simple base class for adapter plugins. More...
class  Vamp::HostExt::PluginWrapper
 PluginWrapper is a simple base class for adapter plugins. More...

Namespaces

namespace  Vamp
namespace  Vamp::HostExt
namespace  Vamp
namespace  Vamp::HostExt
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PluginWrapper_8h_source.html --- a/code-docs/PluginWrapper_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PluginWrapper_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PluginWrapper.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -182,15 +183,15 @@
 00133 _VAMP_SDK_HOSTSPACE_END(PluginWrapper.h)
 00134 
 00135 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PowerSpectrum_8cpp.html --- a/code-docs/PowerSpectrum_8cpp.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PowerSpectrum_8cpp.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PowerSpectrum.cpp File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +

Go to the source code of this file.

-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PowerSpectrum_8cpp_source.html --- a/code-docs/PowerSpectrum_8cpp_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PowerSpectrum_8cpp_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PowerSpectrum.cpp Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -245,15 +246,15 @@
 00168     return FeatureSet();
 00169 }
 00170 
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PowerSpectrum_8h.html --- a/code-docs/PowerSpectrum_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PowerSpectrum_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PowerSpectrum.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
PowerSpectrum.h File Reference
- +

Go to the source code of this file.

- - + +

Classes

class  PowerSpectrum
 Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio. More...
class  PowerSpectrum
 Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio. More...
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/PowerSpectrum_8h_source.html --- a/code-docs/PowerSpectrum_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/PowerSpectrum_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PowerSpectrum.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -116,7 +117,7 @@
 00039 
 00040 #include "vamp-sdk/Plugin.h"
 00041 
-00050 class PowerSpectrum : public Vamp::Plugin
+00050 class PowerSpectrum : public Vamp::Plugin
 00051 {
 00052 public:
 00053     PowerSpectrum(float inputSampleRate);
@@ -147,15 +148,15 @@
 00078 
 00079 
 00080 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/SpectralCentroid_8cpp.html --- a/code-docs/SpectralCentroid_8cpp.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/SpectralCentroid_8cpp.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: SpectralCentroid.cpp File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +

Go to the source code of this file.

-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/SpectralCentroid_8cpp_source.html --- a/code-docs/SpectralCentroid_8cpp_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/SpectralCentroid_8cpp_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: SpectralCentroid.cpp Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -271,15 +272,15 @@
 00194     return FeatureSet();
 00195 }
 00196 
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/SpectralCentroid_8h.html --- a/code-docs/SpectralCentroid_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/SpectralCentroid_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: SpectralCentroid.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
SpectralCentroid.h File Reference
- +

Go to the source code of this file.

- - + +

Classes

class  SpectralCentroid
 Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio. More...
class  SpectralCentroid
 Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio. More...
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/SpectralCentroid_8h_source.html --- a/code-docs/SpectralCentroid_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/SpectralCentroid_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: SpectralCentroid.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -116,7 +117,7 @@
 00039 
 00040 #include "vamp-sdk/Plugin.h"
 00041 
-00047 class SpectralCentroid : public Vamp::Plugin
+00047 class SpectralCentroid : public Vamp::Plugin
 00048 {
 00049 public:
 00050     SpectralCentroid(float inputSampleRate);
@@ -148,15 +149,15 @@
 00076 
 00077 
 00078 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/ZeroCrossing_8cpp.html --- a/code-docs/ZeroCrossing_8cpp.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/ZeroCrossing_8cpp.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: ZeroCrossing.cpp File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +

Go to the source code of this file.

-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/ZeroCrossing_8cpp_source.html --- a/code-docs/ZeroCrossing_8cpp_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/ZeroCrossing_8cpp_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: ZeroCrossing.cpp Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -270,15 +271,15 @@
 00193     return FeatureSet();
 00194 }
 00195 
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/ZeroCrossing_8h.html --- a/code-docs/ZeroCrossing_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/ZeroCrossing_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: ZeroCrossing.h File Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
ZeroCrossing.h File Reference
- +

Go to the source code of this file.

- - + +

Classes

class  ZeroCrossing
 Example plugin that calculates the positions and density of zero-crossing points in an audio waveform. More...
class  ZeroCrossing
 Example plugin that calculates the positions and density of zero-crossing points in an audio waveform. More...
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/ZeroCrossing_8h_source.html --- a/code-docs/ZeroCrossing_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/ZeroCrossing_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: ZeroCrossing.h Source File @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -116,7 +117,7 @@
 00039 
 00040 #include "vamp-sdk/Plugin.h"
 00041 
-00047 class ZeroCrossing : public Vamp::Plugin
+00047 class ZeroCrossing : public Vamp::Plugin
 00048 {
 00049 public:
 00050     ZeroCrossing(float inputSampleRate);
@@ -148,15 +149,15 @@
 00076 
 00077 
 00078 #endif
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/annotated.html --- a/code-docs/annotated.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/annotated.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class List @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
Here are the classes, structs, unions and interfaces with brief descriptions:
@@ -87,6 +88,7 @@ + @@ -107,14 +109,14 @@
_VampFeature
AmplitudeFollowerExample plugin implementing the SuperCollider amplitude follower function
FixedTempoEstimator::D
Vamp::Plugin::Feature
Vamp::FFTA simple FFT implementation provided for convenience of plugin authors
FixedTempoEstimatorExample plugin that estimates the tempo of a short fixed-tempo sample
Vamp::Plugin::OutputDescriptor
Vamp::PluginBase::ParameterDescriptor
SpectralCentroidExample plugin that calculates the centre of gravity of the frequency domain representation of each block of audio
ZeroCrossingExample plugin that calculates the positions and density of zero-crossing points in an audio waveform
-
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/annotated.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/annotated.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,33 @@ +var annotated = +[ + [ "_VampFeature", "struct__VampFeature.html", "struct__VampFeature" ], + [ "_VampFeatureList", "struct__VampFeatureList.html", "struct__VampFeatureList" ], + [ "_VampFeatureUnion", "union__VampFeatureUnion.html", "union__VampFeatureUnion" ], + [ "_VampFeatureV2", "struct__VampFeatureV2.html", "struct__VampFeatureV2" ], + [ "_VampOutputDescriptor", "struct__VampOutputDescriptor.html", "struct__VampOutputDescriptor" ], + [ "_VampParameterDescriptor", "struct__VampParameterDescriptor.html", "struct__VampParameterDescriptor" ], + [ "_VampPluginDescriptor", "struct__VampPluginDescriptor.html", "struct__VampPluginDescriptor" ], + [ "AmplitudeFollower", "classAmplitudeFollower.html", "classAmplitudeFollower" ], + [ "FixedTempoEstimator::D", "classFixedTempoEstimator_1_1D.html", "classFixedTempoEstimator_1_1D" ], + [ "Vamp::Plugin::Feature", "structVamp_1_1Plugin_1_1Feature.html", "structVamp_1_1Plugin_1_1Feature" ], + [ "Vamp::FFT", "classVamp_1_1FFT.html", "classVamp_1_1FFT" ], + [ "FixedTempoEstimator", "classFixedTempoEstimator.html", "classFixedTempoEstimator" ], + [ "Vamp::Plugin::OutputDescriptor", "structVamp_1_1Plugin_1_1OutputDescriptor.html", "structVamp_1_1Plugin_1_1OutputDescriptor" ], + [ "Vamp::PluginBase::ParameterDescriptor", "structVamp_1_1PluginBase_1_1ParameterDescriptor.html", "structVamp_1_1PluginBase_1_1ParameterDescriptor" ], + [ "PercussionOnsetDetector", "classPercussionOnsetDetector.html", "classPercussionOnsetDetector" ], + [ "Vamp::Plugin", "classVamp_1_1Plugin.html", "classVamp_1_1Plugin" ], + [ "Vamp::PluginAdapter< P >", "classVamp_1_1PluginAdapter.html", "classVamp_1_1PluginAdapter" ], + [ "Vamp::PluginAdapterBase", "classVamp_1_1PluginAdapterBase.html", "classVamp_1_1PluginAdapterBase" ], + [ "Vamp::PluginBase", "classVamp_1_1PluginBase.html", "classVamp_1_1PluginBase" ], + [ "Vamp::HostExt::PluginBufferingAdapter", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html", "classVamp_1_1HostExt_1_1PluginBufferingAdapter" ], + [ "Vamp::HostExt::PluginChannelAdapter", "classVamp_1_1HostExt_1_1PluginChannelAdapter.html", "classVamp_1_1HostExt_1_1PluginChannelAdapter" ], + [ "Vamp::PluginHostAdapter", "classVamp_1_1PluginHostAdapter.html", "classVamp_1_1PluginHostAdapter" ], + [ "Vamp::HostExt::PluginInputDomainAdapter", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter" ], + [ "Vamp::HostExt::PluginLoader", "classVamp_1_1HostExt_1_1PluginLoader.html", "classVamp_1_1HostExt_1_1PluginLoader" ], + [ "Vamp::HostExt::PluginSummarisingAdapter", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter" ], + [ "Vamp::HostExt::PluginWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html", "classVamp_1_1HostExt_1_1PluginWrapper" ], + [ "PowerSpectrum", "classPowerSpectrum.html", "classPowerSpectrum" ], + [ "Vamp::RealTime", "structVamp_1_1RealTime.html", "structVamp_1_1RealTime" ], + [ "SpectralCentroid", "classSpectralCentroid.html", "classSpectralCentroid" ], + [ "ZeroCrossing", "classZeroCrossing.html", "classZeroCrossing" ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/bdwn.png Binary file code-docs/bdwn.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classAmplitudeFollower-members.html --- a/code-docs/classAmplitudeFollower-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classAmplitudeFollower-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Member List @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
This is the complete list of members for AmplitudeFollower, including all inherited members. @@ -119,14 +120,14 @@ -
AmplitudeFollower(float inputSampleRate)AmplitudeFollower
~AmplitudeFollower()AmplitudeFollower [virtual]
~Plugin()Vamp::Plugin [inline, virtual]
~PluginBase()Vamp::PluginBase [inline, virtual]
+ diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classAmplitudeFollower.html --- a/code-docs/classAmplitudeFollower.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classAmplitudeFollower.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: AmplitudeFollower Class Reference @@ -28,7 +29,7 @@
VampPluginSDK -  2.1 +  2.4
@@ -40,7 +41,7 @@ - +
AmplitudeFollower Class Reference
- +
- +

Example plugin implementing the SuperCollider amplitude follower function. More...

@@ -97,84 +98,84 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + + +

Public Types

enum  InputDomain { TimeDomain, +
enum  InputDomain { TimeDomain, FrequencyDomain }
typedef std::vector
+
typedef std::vector
< OutputDescriptor > 		OutputList
typedef std::vector< Feature > FeatureList
typedef std::map< int,
+
typedef std::vector< Feature > FeatureList
typedef std::map< int,
FeatureList > 		FeatureSet
typedef std::vector
+
typedef std::vector
< ParameterDescriptor > 		ParameterList
typedef std::vector< std::string > ProgramList
typedef std::vector< std::string > ProgramList

Public Member Functions

 AmplitudeFollower (float inputSampleRate)
 An implementation of SuperCollider's amplitude-follower algorithm as a simple Vamp plugin.
virtual ~AmplitudeFollower ()
bool initialise (size_t channels, size_t stepSize, size_t blockSize)
 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).
void reset ()
 Reset the plugin after use, to prepare it for another clean run.
InputDomain getInputDomain () const
 Get the plugin's required input domain.
std::string getIdentifier () const
 Get the computer-usable name of the plugin.
std::string getName () const
 Get a human-readable name or title of the plugin.
std::string getDescription () const
 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".
std::string getMaker () const
 Get the name of the author or vendor of the plugin in human-readable form.
int getPluginVersion () const
 Get the version number of the plugin.
std::string getCopyright () const
 Get the copyright statement or licensing summary for the plugin.
OutputList getOutputDescriptors () const
 Get the outputs of this plugin.
ParameterList getParameterDescriptors () const
 Get the controllable parameters of this plugin.
float getParameter (std::string paramid) const
 Get the value of a named parameter.
void setParameter (std::string paramid, float newval)
 Set a named parameter.
FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
 Process a single block of input data.
FeatureSet getRemainingFeatures ()
 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
virtual size_t getPreferredBlockSize () const
 Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
virtual size_t getPreferredStepSize () const
 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
virtual size_t getMinChannelCount () const
 Get the minimum supported number of input channels.
virtual size_t getMaxChannelCount () const
 Get the maximum supported number of input channels.
virtual std::string getType () const
 Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
virtual unsigned int getVampApiVersion () const
 Get the Vamp API compatibility level of the plugin.
virtual ProgramList getPrograms () const
 Get the program settings available in this plugin.
virtual std::string getCurrentProgram () const
 Get the current program.
virtual void selectProgram (std::string)
 Select a program.
 AmplitudeFollower (float inputSampleRate)
 An implementation of SuperCollider's amplitude-follower algorithm as a simple Vamp plugin.
virtual ~AmplitudeFollower ()
bool initialise (size_t channels, size_t stepSize, size_t blockSize)
 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).
void reset ()
 Reset the plugin after use, to prepare it for another clean run.
InputDomain getInputDomain () const
 Get the plugin's required input domain.
std::string getIdentifier () const
 Get the computer-usable name of the plugin.
std::string getName () const
 Get a human-readable name or title of the plugin.
std::string getDescription () const
 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".
std::string getMaker () const
 Get the name of the author or vendor of the plugin in human-readable form.
int getPluginVersion () const
 Get the version number of the plugin.
std::string getCopyright () const
 Get the copyright statement or licensing summary for the plugin.
OutputList getOutputDescriptors () const
 Get the outputs of this plugin.
ParameterList getParameterDescriptors () const
 Get the controllable parameters of this plugin.
float getParameter (std::string paramid) const
 Get the value of a named parameter.
void setParameter (std::string paramid, float newval)
 Set a named parameter.
FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
 Process a single block of input data.
FeatureSet getRemainingFeatures ()
 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
virtual size_t getPreferredBlockSize () const
 Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
virtual size_t getPreferredStepSize () const
 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
virtual size_t getMinChannelCount () const
 Get the minimum supported number of input channels.
virtual size_t getMaxChannelCount () const
 Get the maximum supported number of input channels.
virtual std::string getType () const
 Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
virtual unsigned int getVampApiVersion () const
 Get the Vamp API compatibility level of the plugin.
virtual ProgramList getPrograms () const
 Get the program settings available in this plugin.
virtual std::string getCurrentProgram () const
 Get the current program.
virtual void selectProgram (std::string)
 Select a program.

Protected Attributes

size_t m_stepSize
float m_previn
float m_clampcoef
float m_relaxcoef
float m_inputSampleRate
size_t m_stepSize
float m_previn
float m_clampcoef
float m_relaxcoef
float m_inputSampleRate

Detailed Description

Example plugin implementing the SuperCollider amplitude follower function.

Definition at line 47 of file AmplitudeFollower.h.

Member Typedef Documentation

- +
@@ -189,7 +190,7 @@ - +
@@ -204,7 +205,7 @@ - +
@@ -219,7 +220,7 @@ - +
@@ -230,11 +231,11 @@
-

Definition at line 203 of file vamp-sdk/PluginBase.h.

+

Definition at line 199 of file vamp-sdk/PluginBase.h.

- +
@@ -245,12 +246,12 @@
-

Definition at line 225 of file vamp-sdk/PluginBase.h.

+

Definition at line 221 of file vamp-sdk/PluginBase.h.

Member Enumeration Documentation

- +
@@ -261,9 +262,9 @@
Enumerator:
- -
TimeDomain  +
TimeDomain 
FrequencyDomain  +
FrequencyDomain 
@@ -274,12 +275,12 @@

Constructor & Destructor Documentation

- +
- + @@ -295,12 +296,12 @@ - +
AmplitudeFollower::AmplitudeFollower AmplitudeFollower::AmplitudeFollower ( float  inputSampleRate)
- + @@ -314,12 +315,12 @@

Member Function Documentation

- +
AmplitudeFollower::~AmplitudeFollower AmplitudeFollower::~AmplitudeFollower ( ) [virtual]
- + @@ -357,12 +358,12 @@ - +
bool AmplitudeFollower::initialise bool AmplitudeFollower::initialise ( size_t  inputChannels,
- + @@ -382,12 +383,12 @@ - +
void AmplitudeFollower::reset void AmplitudeFollower::reset ( ) [virtual]
- + @@ -408,12 +409,12 @@ - +
InputDomain AmplitudeFollower::getInputDomain InputDomain AmplitudeFollower::getInputDomain ( ) const [inline, virtual]
- + @@ -433,12 +434,12 @@ - +
string AmplitudeFollower::getIdentifier string AmplitudeFollower::getIdentifier ( ) const [virtual]
- + @@ -457,12 +458,12 @@ - +
string AmplitudeFollower::getName string AmplitudeFollower::getName ( ) const [virtual]
- + @@ -481,12 +482,12 @@ - +
string AmplitudeFollower::getDescription string AmplitudeFollower::getDescription ( ) const [virtual]
- + @@ -504,12 +505,12 @@ - +
string AmplitudeFollower::getMaker string AmplitudeFollower::getMaker ( ) const [virtual]
- + @@ -526,12 +527,12 @@ - +
int AmplitudeFollower::getPluginVersion int AmplitudeFollower::getPluginVersion ( ) const [virtual]
- + @@ -549,12 +550,12 @@ - +
string AmplitudeFollower::getCopyright string AmplitudeFollower::getCopyright ( ) const [virtual]
- + @@ -574,12 +575,12 @@ - +
AmplitudeFollower::OutputList AmplitudeFollower::getOutputDescriptors AmplitudeFollower::OutputList AmplitudeFollower::getOutputDescriptors ( ) const [virtual]
- + @@ -594,16 +595,16 @@

Definition at line 148 of file AmplitudeFollower.cpp.

-

References Vamp::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::ParameterDescriptor::unit.

+

References Vamp::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::ParameterDescriptor::unit.

- +
AmplitudeFollower::ParameterList AmplitudeFollower::getParameterDescriptors AmplitudeFollower::ParameterList AmplitudeFollower::getParameterDescriptors ( ) const [virtual]
- + @@ -624,12 +625,12 @@ - +
float AmplitudeFollower::getParameter float AmplitudeFollower::getParameter ( std::string  )
- + @@ -660,12 +661,12 @@ - +
void AmplitudeFollower::setParameter void AmplitudeFollower::setParameter ( std::string  ,
- + @@ -698,12 +699,12 @@ - +
AmplitudeFollower::FeatureSet AmplitudeFollower::process AmplitudeFollower::FeatureSet AmplitudeFollower::process ( const float *const *  inputBuffers,
- + @@ -720,12 +721,12 @@ - +
AmplitudeFollower::FeatureSet AmplitudeFollower::getRemainingFeatures AmplitudeFollower::FeatureSet AmplitudeFollower::getRemainingFeatures ( ) [virtual]
- + @@ -746,12 +747,12 @@ - +
virtual size_t Vamp::Plugin::getPreferredBlockSize virtual size_t Vamp::Plugin::getPreferredBlockSize ( ) const [inline, virtual, inherited]
- + @@ -772,12 +773,12 @@ - +
virtual size_t Vamp::Plugin::getPreferredStepSize virtual size_t Vamp::Plugin::getPreferredStepSize ( ) const [inline, virtual, inherited]
- + @@ -796,12 +797,12 @@ - +
virtual size_t Vamp::Plugin::getMinChannelCount virtual size_t Vamp::Plugin::getMinChannelCount ( ) const [inline, virtual, inherited]
- + @@ -820,12 +821,12 @@ - +
virtual size_t Vamp::Plugin::getMaxChannelCount virtual size_t Vamp::Plugin::getMaxChannelCount ( ) const [inline, virtual, inherited]
- + @@ -843,12 +844,12 @@ - +
virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
- + @@ -861,18 +862,18 @@

Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

-

Definition at line 72 of file vamp-sdk/PluginBase.h.

+

Definition at line 68 of file vamp-sdk/PluginBase.h.

Referenced by enumeratePlugins().

- +
virtual unsigned int Vamp::PluginBase::getVampApiVersion virtual unsigned int Vamp::PluginBase::getVampApiVersion ( ) const [inline, virtual, inherited]
- + @@ -887,16 +888,16 @@

Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

-

Definition at line 237 of file vamp-sdk/PluginBase.h.

+

Definition at line 233 of file vamp-sdk/PluginBase.h.

- +
virtual ProgramList Vamp::PluginBase::getPrograms virtual ProgramList Vamp::PluginBase::getPrograms ( ) const [inline, virtual, inherited]
- + @@ -909,16 +910,16 @@

Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

-

Definition at line 242 of file vamp-sdk/PluginBase.h.

+

Definition at line 238 of file vamp-sdk/PluginBase.h.

- +
virtual std::string Vamp::PluginBase::getCurrentProgram virtual std::string Vamp::PluginBase::getCurrentProgram ( ) const [inline, virtual, inherited]
- + @@ -933,12 +934,12 @@

Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

-

Definition at line 248 of file vamp-sdk/PluginBase.h.

+

Definition at line 244 of file vamp-sdk/PluginBase.h.

Member Data Documentation

- +
virtual void Vamp::PluginBase::selectProgram virtual void Vamp::PluginBase::selectProgram ( std::string  )
@@ -955,7 +956,7 @@ - +
@@ -972,7 +973,7 @@ - +
@@ -989,7 +990,7 @@ - +
@@ -1006,7 +1007,7 @@ - +
@@ -1027,15 +1028,15 @@
  • AmplitudeFollower.h
  • AmplitudeFollower.cpp
    • - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classAmplitudeFollower.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classAmplitudeFollower.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,40 @@ +var classAmplitudeFollower = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "AmplitudeFollower", "classAmplitudeFollower.html#a29eaeffc353da2614ae508abcd0ab63f", null ], + [ "~AmplitudeFollower", "classAmplitudeFollower.html#aa78f98539ad3a1b08691a99b32035b2d", null ], + [ "initialise", "classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d", null ], + [ "reset", "classAmplitudeFollower.html#acebd835e80e84669df078fbd7591d8f7", null ], + [ "getInputDomain", "classAmplitudeFollower.html#afc07a389b5f922b944b0350fd232d2eb", null ], + [ "getIdentifier", "classAmplitudeFollower.html#afe7576af95c8fcc7f5bad42eec9f9f29", null ], + [ "getName", "classAmplitudeFollower.html#a7cfed00bc9d96ba6c709b69ab6a40594", null ], + [ "getDescription", "classAmplitudeFollower.html#a6f0f2fea1fdb4b51e688edfe859d5062", null ], + [ "getMaker", "classAmplitudeFollower.html#a44fc43838f203f58bc2ce6e3cb2b03dd", null ], + [ "getPluginVersion", "classAmplitudeFollower.html#a8a5d7a834eb996d517c51f84b2a72250", null ], + [ "getCopyright", "classAmplitudeFollower.html#a0c197fc90f30d91cb4403115c83c9134", null ], + [ "getOutputDescriptors", "classAmplitudeFollower.html#a043e3c3db77d76267cd8069e1485bf26", null ], + [ "getParameterDescriptors", "classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf", null ], + [ "getParameter", "classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39", null ], + [ "setParameter", "classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340", null ], + [ "process", "classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd", null ], + [ "getRemainingFeatures", "classAmplitudeFollower.html#a368606f643b88e0df0823d85e36f030c", null ], + [ "getPreferredBlockSize", "classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac", null ], + [ "getPreferredStepSize", "classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567", null ], + [ "getMinChannelCount", "classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525", null ], + [ "getMaxChannelCount", "classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "getVampApiVersion", "classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf", null ], + [ "getPrograms", "classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af", null ], + [ "getCurrentProgram", "classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3", null ], + [ "selectProgram", "classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353", null ], + [ "m_stepSize", "classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027", null ], + [ "m_previn", "classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a", null ], + [ "m_clampcoef", "classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876", null ], + [ "m_relaxcoef", "classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classAmplitudeFollower__inherit__graph.png Binary file code-docs/classAmplitudeFollower__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classFixedTempoEstimator-members.html --- a/code-docs/classFixedTempoEstimator-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classFixedTempoEstimator-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for FixedTempoEstimator, including all inherited members. @@ -116,14 +117,14 @@ -
    FeatureList typedefVamp::Plugin
    ~FixedTempoEstimator()FixedTempoEstimator [virtual]
    ~Plugin()Vamp::Plugin [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classFixedTempoEstimator.html --- a/code-docs/classFixedTempoEstimator.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classFixedTempoEstimator.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: FixedTempoEstimator Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    FixedTempoEstimator Class Reference
    - +
    - +

    Example plugin that estimates the tempo of a short fixed-tempo sample. More...

    @@ -98,83 +99,83 @@ - + - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + +

    Classes

    class  D
    class  D

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     FixedTempoEstimator (float inputSampleRate)
    virtual ~FixedTempoEstimator ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string id) const
     Get the value of a named parameter.
    void setParameter (std::string id, float value)
     Set a named parameter.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.
     FixedTempoEstimator (float inputSampleRate)
    virtual ~FixedTempoEstimator ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string id) const
     Get the value of a named parameter.
    void setParameter (std::string id, float value)
     Set a named parameter.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.

    Protected Attributes

    D * m_d
    float m_inputSampleRate
    D * m_d
    float m_inputSampleRate

    Detailed Description

    Example plugin that estimates the tempo of a short fixed-tempo sample.

    Definition at line 46 of file FixedTempoEstimator.h.

    Member Typedef Documentation

    - +
    @@ -189,7 +190,7 @@ - +
    @@ -204,7 +205,7 @@ - +
    @@ -219,7 +220,7 @@ - +
    @@ -230,11 +231,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -245,12 +246,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -261,9 +262,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -274,12 +275,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -293,12 +294,12 @@ - +
    FixedTempoEstimator::FixedTempoEstimator FixedTempoEstimator::FixedTempoEstimator ( float  inputSampleRate)
    - + @@ -314,12 +315,12 @@

    Member Function Documentation

    - +
    FixedTempoEstimator::~FixedTempoEstimator FixedTempoEstimator::~FixedTempoEstimator ( ) [virtual]
    - + @@ -357,12 +358,12 @@ - +
    bool FixedTempoEstimator::initialise bool FixedTempoEstimator::initialise ( size_t  inputChannels,
    - + @@ -382,12 +383,12 @@ - +
    void FixedTempoEstimator::reset void FixedTempoEstimator::reset ( ) [virtual]
    - + @@ -408,12 +409,12 @@ - +
    InputDomain FixedTempoEstimator::getInputDomain InputDomain FixedTempoEstimator::getInputDomain ( ) const [inline, virtual]
    - + @@ -433,12 +434,12 @@ - +
    string FixedTempoEstimator::getIdentifier string FixedTempoEstimator::getIdentifier ( ) const [virtual]
    - + @@ -457,12 +458,12 @@ - +
    string FixedTempoEstimator::getName string FixedTempoEstimator::getName ( ) const [virtual]
    - + @@ -481,12 +482,12 @@ - +
    string FixedTempoEstimator::getDescription string FixedTempoEstimator::getDescription ( ) const [virtual]
    - + @@ -504,12 +505,12 @@ - +
    string FixedTempoEstimator::getMaker string FixedTempoEstimator::getMaker ( ) const [virtual]
    - + @@ -526,12 +527,12 @@ - +
    int FixedTempoEstimator::getPluginVersion int FixedTempoEstimator::getPluginVersion ( ) const [virtual]
    - + @@ -549,12 +550,12 @@ - +
    string FixedTempoEstimator::getCopyright string FixedTempoEstimator::getCopyright ( ) const [virtual]
    - + @@ -575,12 +576,12 @@ - +
    size_t FixedTempoEstimator::getPreferredStepSize size_t FixedTempoEstimator::getPreferredStepSize ( ) const [virtual]
    - + @@ -603,12 +604,12 @@ - +
    size_t FixedTempoEstimator::getPreferredBlockSize size_t FixedTempoEstimator::getPreferredBlockSize ( ) const [virtual]
    - + @@ -627,12 +628,12 @@ - +
    FixedTempoEstimator::ParameterList FixedTempoEstimator::getParameterDescriptors FixedTempoEstimator::ParameterList FixedTempoEstimator::getParameterDescriptors ( ) const [virtual]
    - + @@ -653,12 +654,12 @@ - +
    float FixedTempoEstimator::getParameter float FixedTempoEstimator::getParameter ( std::string  )
    - + @@ -689,12 +690,12 @@ - +
    void FixedTempoEstimator::setParameter void FixedTempoEstimator::setParameter ( std::string  ,
    - + @@ -714,12 +715,12 @@ - +
    FixedTempoEstimator::OutputList FixedTempoEstimator::getOutputDescriptors FixedTempoEstimator::OutputList FixedTempoEstimator::getOutputDescriptors ( ) const [virtual]
    - + @@ -752,12 +753,12 @@ - +
    FixedTempoEstimator::FeatureSet FixedTempoEstimator::process FixedTempoEstimator::FeatureSet FixedTempoEstimator::process ( const float *const *  inputBuffers,
    - + @@ -776,12 +777,12 @@ - +
    FixedTempoEstimator::FeatureSet FixedTempoEstimator::getRemainingFeatures FixedTempoEstimator::FeatureSet FixedTempoEstimator::getRemainingFeatures ( ) [virtual]
    - + @@ -800,12 +801,12 @@ - +
    virtual size_t Vamp::Plugin::getMinChannelCount virtual size_t Vamp::Plugin::getMinChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -824,12 +825,12 @@ - +
    virtual size_t Vamp::Plugin::getMaxChannelCount virtual size_t Vamp::Plugin::getMaxChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -847,12 +848,12 @@ - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    - + @@ -865,18 +866,18 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 72 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 68 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual unsigned int Vamp::PluginBase::getVampApiVersion virtual unsigned int Vamp::PluginBase::getVampApiVersion ( ) const [inline, virtual, inherited]
    - + @@ -891,16 +892,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 237 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 233 of file vamp-sdk/PluginBase.h.

    - +
    virtual ProgramList Vamp::PluginBase::getPrograms virtual ProgramList Vamp::PluginBase::getPrograms ( ) const [inline, virtual, inherited]
    - + @@ -913,16 +914,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 242 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 238 of file vamp-sdk/PluginBase.h.

    - +
    virtual std::string Vamp::PluginBase::getCurrentProgram virtual std::string Vamp::PluginBase::getCurrentProgram ( ) const [inline, virtual, inherited]
    - + @@ -937,12 +938,12 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 248 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 244 of file vamp-sdk/PluginBase.h.

    Member Data Documentation

    - +
    virtual void Vamp::PluginBase::selectProgram virtual void Vamp::PluginBase::selectProgram ( std::string  )
    @@ -959,7 +960,7 @@ - +
    @@ -980,15 +981,15 @@
  • FixedTempoEstimator.h
  • FixedTempoEstimator.cpp
    • - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classFixedTempoEstimator.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classFixedTempoEstimator.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,37 @@ +var classFixedTempoEstimator = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "FixedTempoEstimator", "classFixedTempoEstimator.html#a3967c189f054f864639837c2519bd64d", null ], + [ "~FixedTempoEstimator", "classFixedTempoEstimator.html#a0302c4bfdc163a3d34478cde93c96a53", null ], + [ "initialise", "classFixedTempoEstimator.html#aa7500a4ffbc4653baaf5101defdb37f5", null ], + [ "reset", "classFixedTempoEstimator.html#ac41708397255400c6682fee6c1b3d45f", null ], + [ "getInputDomain", "classFixedTempoEstimator.html#a055689c9b41b0945e8d3cdbc3b8c3a2e", null ], + [ "getIdentifier", "classFixedTempoEstimator.html#ab818edcf1555177d10260e197e3a5e7a", null ], + [ "getName", "classFixedTempoEstimator.html#af9eb6fa8a98aa66b55e64e1795f9405f", null ], + [ "getDescription", "classFixedTempoEstimator.html#a06b00853f00c2e78d490697fcd7d1920", null ], + [ "getMaker", "classFixedTempoEstimator.html#ae910d1b9250b11097fd6b51cd8285b68", null ], + [ "getPluginVersion", "classFixedTempoEstimator.html#ad002fddb3735c2dd7e31e6a9def9949f", null ], + [ "getCopyright", "classFixedTempoEstimator.html#a50c6b64530c84c0707ba3936c5022a48", null ], + [ "getPreferredStepSize", "classFixedTempoEstimator.html#ad450bb7e7df559ae3d68dfbfb085676f", null ], + [ "getPreferredBlockSize", "classFixedTempoEstimator.html#a68b8569b71504a0478caf990dbe30683", null ], + [ "getParameterDescriptors", "classFixedTempoEstimator.html#ae157465a4e07d180bab05b5c3a4d8987", null ], + [ "getParameter", "classFixedTempoEstimator.html#a2030b05fb1228b30ace16200780c9152", null ], + [ "setParameter", "classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75", null ], + [ "getOutputDescriptors", "classFixedTempoEstimator.html#a83121c205a723fe6297e2bf8870622a4", null ], + [ "process", "classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c", null ], + [ "getRemainingFeatures", "classFixedTempoEstimator.html#a4965cf99be77fc4d1de51e11d83936b0", null ], + [ "getMinChannelCount", "classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525", null ], + [ "getMaxChannelCount", "classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "getVampApiVersion", "classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf", null ], + [ "getPrograms", "classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af", null ], + [ "getCurrentProgram", "classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3", null ], + [ "selectProgram", "classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353", null ], + [ "m_d", "classFixedTempoEstimator.html#a5e1c9abaf33e9f48eb7d3b48f8af3308", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classFixedTempoEstimator_1_1D-members.html --- a/code-docs/classFixedTempoEstimator_1_1D-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classFixedTempoEstimator_1_1D-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for FixedTempoEstimator::D, including all inherited members. @@ -108,14 +109,14 @@ -
    assembleFeatures()FixedTempoEstimator::D [private]
    setParameter(string id, float value)FixedTempoEstimator::D
    tempo2lag(float)FixedTempoEstimator::D [private]
    ~D()FixedTempoEstimator::D
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classFixedTempoEstimator_1_1D.html --- a/code-docs/classFixedTempoEstimator_1_1D.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classFixedTempoEstimator_1_1D.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: FixedTempoEstimator::D Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    FixedTempoEstimator::D Class Reference
    - +
    - +

    List of all members.

    - - - - - - - - - - - - + + + + + + + + + + + + - - - - + + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +

    Public Member Functions

     D (float inputSampleRate)
     ~D ()
    size_t getPreferredStepSize () const
    size_t getPreferredBlockSize () const
    ParameterList getParameterDescriptors () const
    float getParameter (string id) const
    void setParameter (string id, float value)
    OutputList getOutputDescriptors () const
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
    void reset ()
    FeatureSet process (const float *const *, RealTime)
    FeatureSet getRemainingFeatures ()
     D (float inputSampleRate)
     ~D ()
    size_t getPreferredStepSize () const
    size_t getPreferredBlockSize () const
    ParameterList getParameterDescriptors () const
    float getParameter (string id) const
    void setParameter (string id, float value)
    OutputList getOutputDescriptors () const
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
    void reset ()
    FeatureSet process (const float *const *, RealTime)
    FeatureSet getRemainingFeatures ()

    Private Member Functions

    void calculate ()
    FeatureSet assembleFeatures ()
    float lag2tempo (int)
    int tempo2lag (float)
    void calculate ()
    FeatureSet assembleFeatures ()
    float lag2tempo (int)
    int tempo2lag (float)

    Private Attributes

    float m_inputSampleRate
    size_t m_stepSize
    size_t m_blockSize
    float m_minbpm
    float m_maxbpm
    float m_maxdflen
    float * m_priorMagnitudes
    size_t m_dfsize
    float * m_df
    float * m_r
    float * m_fr
    float * m_t
    size_t m_n
    Vamp::RealTime m_start
    Vamp::RealTime m_lasttime
    float m_inputSampleRate
    size_t m_stepSize
    size_t m_blockSize
    float m_minbpm
    float m_maxbpm
    float m_maxdflen
    float * m_priorMagnitudes
    size_t m_dfsize
    float * m_df
    float * m_r
    float * m_fr
    float * m_t
    size_t m_n
    Vamp::RealTime m_start
    Vamp::RealTime m_lasttime

    Detailed Description

    Definition at line 50 of file FixedTempoEstimator.cpp.

    Constructor & Destructor Documentation

    - +
    - + @@ -144,12 +145,12 @@ - +
    FixedTempoEstimator::D::D FixedTempoEstimator::D::D ( float  inputSampleRate)
    - + @@ -163,12 +164,12 @@

    Member Function Documentation

    - +
    FixedTempoEstimator::D::~D FixedTempoEstimator::D::~D ( )
    - + @@ -183,12 +184,12 @@ - +
    size_t FixedTempoEstimator::D::getPreferredStepSize size_t FixedTempoEstimator::D::getPreferredStepSize ( ) const [inline]
    - + @@ -203,12 +204,12 @@ - +
    size_t FixedTempoEstimator::D::getPreferredBlockSize size_t FixedTempoEstimator::D::getPreferredBlockSize ( ) const [inline]
    - + @@ -219,18 +220,18 @@

    Definition at line 125 of file FixedTempoEstimator.cpp.

    -

    References Vamp::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::ParameterDescriptor::unit.

    +

    References Vamp::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::ParameterDescriptor::unit.

    Referenced by FixedTempoEstimator::getParameterDescriptors().

    - +
    FixedTempoEstimator::ParameterList FixedTempoEstimator::D::getParameterDescriptors FixedTempoEstimator::ParameterList FixedTempoEstimator::D::getParameterDescriptors ( ) const
    - + @@ -246,12 +247,12 @@ - +
    float FixedTempoEstimator::D::getParameter float FixedTempoEstimator::D::getParameter ( string  id)
    - + @@ -277,12 +278,12 @@ - +
    void FixedTempoEstimator::D::setParameter void FixedTempoEstimator::D::setParameter ( string  id,
    - + @@ -299,12 +300,12 @@ - +
    FixedTempoEstimator::OutputList FixedTempoEstimator::D::getOutputDescriptors FixedTempoEstimator::OutputList FixedTempoEstimator::D::getOutputDescriptors ( ) const
    - + @@ -338,12 +339,12 @@ - +
    bool FixedTempoEstimator::D::initialise bool FixedTempoEstimator::D::initialise ( size_t  channels,
    - + @@ -358,12 +359,12 @@ - +
    void FixedTempoEstimator::D::reset void FixedTempoEstimator::D::reset ( )
    - + @@ -389,12 +390,12 @@ - +
    FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::process FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::process ( const float *const *  inputBuffers,
    - + @@ -409,12 +410,12 @@ - +
    FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::getRemainingFeatures FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::getRemainingFeatures ( )
    - + @@ -429,12 +430,12 @@ - +
    void FixedTempoEstimator::D::calculate void FixedTempoEstimator::D::calculate ( ) [private]
    - + @@ -449,12 +450,12 @@ - +
    FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::assembleFeatures FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::assembleFeatures ( ) [private]
    - + @@ -470,12 +471,12 @@ - +
    float FixedTempoEstimator::D::lag2tempo float FixedTempoEstimator::D::lag2tempo ( int  lag)
    - + @@ -492,7 +493,7 @@

    Member Data Documentation

    - +
    int FixedTempoEstimator::D::tempo2lag int FixedTempoEstimator::D::tempo2lag ( float  tempo)
    @@ -507,7 +508,7 @@ - +
    @@ -522,7 +523,7 @@ - +
    @@ -537,7 +538,7 @@ - +
    @@ -552,7 +553,7 @@ - +
    @@ -567,7 +568,7 @@ - +
    @@ -582,7 +583,7 @@ - +
    @@ -597,7 +598,7 @@ - +
    @@ -612,7 +613,7 @@ - +
    @@ -627,7 +628,7 @@ - +
    @@ -642,7 +643,7 @@ - +
    @@ -657,7 +658,7 @@ - +
    @@ -672,7 +673,7 @@ - +
    @@ -687,7 +688,7 @@ - +
    @@ -702,7 +703,7 @@ - +
    @@ -720,16 +721,16 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classFixedTempoEstimator_1_1D.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classFixedTempoEstimator_1_1D.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,34 @@ +var classFixedTempoEstimator_1_1D = +[ + [ "D", "classFixedTempoEstimator_1_1D.html#a104a9b64d47eca678844584f69ca0b9d", null ], + [ "~D", "classFixedTempoEstimator_1_1D.html#a78a63ac8bbf342cb0405747871adf4cc", null ], + [ "getPreferredStepSize", "classFixedTempoEstimator_1_1D.html#add749be18355ab1ae5c1ccbacfd2e192", null ], + [ "getPreferredBlockSize", "classFixedTempoEstimator_1_1D.html#ac02826f981736fc2aa5d835fa14e174d", null ], + [ "getParameterDescriptors", "classFixedTempoEstimator_1_1D.html#a06fcf80a9a22c4b90abbc88eb592621a", null ], + [ "getParameter", "classFixedTempoEstimator_1_1D.html#a968ef2e555c81e4a3bde89d19fafb31a", null ], + [ "setParameter", "classFixedTempoEstimator_1_1D.html#a6cafa64d4cc8aa3556bc0ce6b0c49bc4", null ], + [ "getOutputDescriptors", "classFixedTempoEstimator_1_1D.html#a7ce98af800f36045a0dae4b1dbed943f", null ], + [ "initialise", "classFixedTempoEstimator_1_1D.html#af0fcad4493650728babb7e341963c91d", null ], + [ "reset", "classFixedTempoEstimator_1_1D.html#af5ac8147bfe79371d00aba8a19c2f8fd", null ], + [ "process", "classFixedTempoEstimator_1_1D.html#a7fac74fc9fc54f436408705d1e125e20", null ], + [ "getRemainingFeatures", "classFixedTempoEstimator_1_1D.html#a7f9c3603bb3374d6936885010dbdd82b", null ], + [ "calculate", "classFixedTempoEstimator_1_1D.html#a4f2cbc11fba5bc8af3fd2a0078156091", null ], + [ "assembleFeatures", "classFixedTempoEstimator_1_1D.html#a20389ba1515f6ce4181d3f41e5c4f347", null ], + [ "lag2tempo", "classFixedTempoEstimator_1_1D.html#a0a7cb0705938097ab23a6f9187e6bae5", null ], + [ "tempo2lag", "classFixedTempoEstimator_1_1D.html#ac6a75212293fc855de6ed0c6581a0fb9", null ], + [ "m_inputSampleRate", "classFixedTempoEstimator_1_1D.html#a072a0fc30b3912a54858eefdd47f4d4f", null ], + [ "m_stepSize", "classFixedTempoEstimator_1_1D.html#a837da9722c63fe3c66c738255990c45f", null ], + [ "m_blockSize", "classFixedTempoEstimator_1_1D.html#a0b9bf37e600f0564b9f305f73a9517c8", null ], + [ "m_minbpm", "classFixedTempoEstimator_1_1D.html#a768fdbb62e4b21a39897963fdbd486ed", null ], + [ "m_maxbpm", "classFixedTempoEstimator_1_1D.html#a33e8d045b222addc6173b50df2553ba8", null ], + [ "m_maxdflen", "classFixedTempoEstimator_1_1D.html#aca506973452865d436e07462eabdebad", null ], + [ "m_priorMagnitudes", "classFixedTempoEstimator_1_1D.html#aa59cf1cb5640a910c70884579e5d99ad", null ], + [ "m_dfsize", "classFixedTempoEstimator_1_1D.html#ae739e006f2d10ef2b13677770b23e663", null ], + [ "m_df", "classFixedTempoEstimator_1_1D.html#a8e2312120e87ad9a48fedeebbaefa396", null ], + [ "m_r", "classFixedTempoEstimator_1_1D.html#a7a8c8658ecfeec98962078df89fcd538", null ], + [ "m_fr", "classFixedTempoEstimator_1_1D.html#ab255006072672653e645fc315eea6167", null ], + [ "m_t", "classFixedTempoEstimator_1_1D.html#a698446aad2c0f737732a392fb86a612c", null ], + [ "m_n", "classFixedTempoEstimator_1_1D.html#ab73af7f1943b76388de04cbb4696a983", null ], + [ "m_start", "classFixedTempoEstimator_1_1D.html#a3a3a0b4a4c259087f02d0046241674d0", null ], + [ "m_lasttime", "classFixedTempoEstimator_1_1D.html#abacd5ff19c301020efb99c03136b849a", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classFixedTempoEstimator__inherit__graph.png Binary file code-docs/classFixedTempoEstimator__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classPercussionOnsetDetector-members.html --- a/code-docs/classPercussionOnsetDetector-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classPercussionOnsetDetector-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for PercussionOnsetDetector, including all inherited members. @@ -122,14 +123,14 @@ -
    FeatureList typedefVamp::Plugin
    ~PercussionOnsetDetector()PercussionOnsetDetector [virtual]
    ~Plugin()Vamp::Plugin [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classPercussionOnsetDetector.html --- a/code-docs/classPercussionOnsetDetector.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classPercussionOnsetDetector.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PercussionOnsetDetector Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    PercussionOnsetDetector Class Reference
    - +
    - +

    Example plugin that detects percussive events. More...

    @@ -97,86 +98,86 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - + + + + + + + +

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     PercussionOnsetDetector (float inputSampleRate)
    virtual ~PercussionOnsetDetector ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string id) const
     Get the value of a named parameter.
    void setParameter (std::string id, float value)
     Set a named parameter.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.
     PercussionOnsetDetector (float inputSampleRate)
    virtual ~PercussionOnsetDetector ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string id) const
     Get the value of a named parameter.
    void setParameter (std::string id, float value)
     Set a named parameter.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.

    Protected Attributes

    size_t m_stepSize
    size_t m_blockSize
    float m_threshold
    float m_sensitivity
    float * m_priorMagnitudes
    float m_dfMinus1
    float m_dfMinus2
    float m_inputSampleRate
    size_t m_stepSize
    size_t m_blockSize
    float m_threshold
    float m_sensitivity
    float * m_priorMagnitudes
    float m_dfMinus1
    float m_dfMinus2
    float m_inputSampleRate

    Detailed Description

    Example plugin that detects percussive events.

    Definition at line 46 of file PercussionOnsetDetector.h.

    Member Typedef Documentation

    - +
    @@ -191,7 +192,7 @@ - +
    @@ -206,7 +207,7 @@ - +
    @@ -221,7 +222,7 @@ - +
    @@ -232,11 +233,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -247,12 +248,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -263,9 +264,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -276,12 +277,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -295,12 +296,12 @@ - +
    PercussionOnsetDetector::PercussionOnsetDetector PercussionOnsetDetector::PercussionOnsetDetector ( float  inputSampleRate)
    - + @@ -316,12 +317,12 @@

    Member Function Documentation

    - +
    PercussionOnsetDetector::~PercussionOnsetDetector PercussionOnsetDetector::~PercussionOnsetDetector ( ) [virtual]
    - + @@ -359,12 +360,12 @@ - +
    bool PercussionOnsetDetector::initialise bool PercussionOnsetDetector::initialise ( size_t  inputChannels,
    - + @@ -384,12 +385,12 @@ - +
    void PercussionOnsetDetector::reset void PercussionOnsetDetector::reset ( ) [virtual]
    - + @@ -410,12 +411,12 @@ - +
    InputDomain PercussionOnsetDetector::getInputDomain InputDomain PercussionOnsetDetector::getInputDomain ( ) const [inline, virtual]
    - + @@ -435,12 +436,12 @@ - +
    string PercussionOnsetDetector::getIdentifier string PercussionOnsetDetector::getIdentifier ( ) const [virtual]
    - + @@ -459,12 +460,12 @@ - +
    string PercussionOnsetDetector::getName string PercussionOnsetDetector::getName ( ) const [virtual]
    - + @@ -483,12 +484,12 @@ - +
    string PercussionOnsetDetector::getDescription string PercussionOnsetDetector::getDescription ( ) const [virtual]
    - + @@ -506,12 +507,12 @@ - +
    string PercussionOnsetDetector::getMaker string PercussionOnsetDetector::getMaker ( ) const [virtual]
    - + @@ -528,12 +529,12 @@ - +
    int PercussionOnsetDetector::getPluginVersion int PercussionOnsetDetector::getPluginVersion ( ) const [virtual]
    - + @@ -551,12 +552,12 @@ - +
    string PercussionOnsetDetector::getCopyright string PercussionOnsetDetector::getCopyright ( ) const [virtual]
    - + @@ -575,12 +576,12 @@ - +
    size_t PercussionOnsetDetector::getPreferredStepSize size_t PercussionOnsetDetector::getPreferredStepSize ( ) const [virtual]
    - + @@ -599,12 +600,12 @@ - +
    size_t PercussionOnsetDetector::getPreferredBlockSize size_t PercussionOnsetDetector::getPreferredBlockSize ( ) const [virtual]
    - + @@ -619,16 +620,16 @@

    Definition at line 145 of file PercussionOnsetDetector.cpp.

    -

    References Vamp::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::ParameterDescriptor::unit.

    +

    References Vamp::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::ParameterDescriptor::unit.

    - +
    PercussionOnsetDetector::ParameterList PercussionOnsetDetector::getParameterDescriptors PercussionOnsetDetector::ParameterList PercussionOnsetDetector::getParameterDescriptors ( ) const [virtual]
    - + @@ -649,12 +650,12 @@ - +
    float PercussionOnsetDetector::getParameter float PercussionOnsetDetector::getParameter ( std::string  )
    - + @@ -685,12 +686,12 @@ - +
    void PercussionOnsetDetector::setParameter void PercussionOnsetDetector::setParameter ( std::string  ,
    - + @@ -710,12 +711,12 @@ - +
    PercussionOnsetDetector::OutputList PercussionOnsetDetector::getOutputDescriptors PercussionOnsetDetector::OutputList PercussionOnsetDetector::getOutputDescriptors ( ) const [virtual]
    - + @@ -748,12 +749,12 @@ - +
    PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::process PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::process ( const float *const *  inputBuffers,
    - + @@ -770,12 +771,12 @@ - +
    PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::getRemainingFeatures PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::getRemainingFeatures ( ) [virtual]
    - + @@ -794,12 +795,12 @@ - +
    virtual size_t Vamp::Plugin::getMinChannelCount virtual size_t Vamp::Plugin::getMinChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -818,12 +819,12 @@ - +
    virtual size_t Vamp::Plugin::getMaxChannelCount virtual size_t Vamp::Plugin::getMaxChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -841,12 +842,12 @@ - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    - + @@ -859,18 +860,18 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 72 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 68 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual unsigned int Vamp::PluginBase::getVampApiVersion virtual unsigned int Vamp::PluginBase::getVampApiVersion ( ) const [inline, virtual, inherited]
    - + @@ -885,16 +886,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 237 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 233 of file vamp-sdk/PluginBase.h.

    - +
    virtual ProgramList Vamp::PluginBase::getPrograms virtual ProgramList Vamp::PluginBase::getPrograms ( ) const [inline, virtual, inherited]
    - + @@ -907,16 +908,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 242 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 238 of file vamp-sdk/PluginBase.h.

    - +
    virtual std::string Vamp::PluginBase::getCurrentProgram virtual std::string Vamp::PluginBase::getCurrentProgram ( ) const [inline, virtual, inherited]
    - + @@ -931,12 +932,12 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 248 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 244 of file vamp-sdk/PluginBase.h.

    Member Data Documentation

    - +
    virtual void Vamp::PluginBase::selectProgram virtual void Vamp::PluginBase::selectProgram ( std::string  )
    @@ -953,7 +954,7 @@ - +
    @@ -970,7 +971,7 @@ - +
    @@ -987,7 +988,7 @@ - +
    @@ -1004,7 +1005,7 @@ - +
    @@ -1021,7 +1022,7 @@ - +
    @@ -1038,7 +1039,7 @@ - +
    @@ -1055,7 +1056,7 @@ - +
    @@ -1076,15 +1077,15 @@
  • PercussionOnsetDetector.h
  • PercussionOnsetDetector.cpp
    • - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classPercussionOnsetDetector.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classPercussionOnsetDetector.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,43 @@ +var classPercussionOnsetDetector = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "PercussionOnsetDetector", "classPercussionOnsetDetector.html#a9f700579805ee5105758d847baab3511", null ], + [ "~PercussionOnsetDetector", "classPercussionOnsetDetector.html#a99f833667cf8185e879d735216c7642b", null ], + [ "initialise", "classPercussionOnsetDetector.html#a349c528260622308f3850bcda8a448ab", null ], + [ "reset", "classPercussionOnsetDetector.html#a9b1075e992cd9599764ef3881fb91d1a", null ], + [ "getInputDomain", "classPercussionOnsetDetector.html#a4f6954267696ee5bfa7dd1c4a6cfa92a", null ], + [ "getIdentifier", "classPercussionOnsetDetector.html#a267c83a7533146c127e2c3be310e0154", null ], + [ "getName", "classPercussionOnsetDetector.html#aa98f1ad061a11af98c054011a8844e6f", null ], + [ "getDescription", "classPercussionOnsetDetector.html#a9061d189705802a48973a7ccab6360db", null ], + [ "getMaker", "classPercussionOnsetDetector.html#a63d63f2cb7ea8d8b09d58cc13b541375", null ], + [ "getPluginVersion", "classPercussionOnsetDetector.html#ad6b818dbd81867ce7be71c99cae861be", null ], + [ "getCopyright", "classPercussionOnsetDetector.html#a1a22ece271330c94cc08798a77416351", null ], + [ "getPreferredStepSize", "classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968", null ], + [ "getPreferredBlockSize", "classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0", null ], + [ "getParameterDescriptors", "classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815", null ], + [ "getParameter", "classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527", null ], + [ "setParameter", "classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01", null ], + [ "getOutputDescriptors", "classPercussionOnsetDetector.html#aa4537aa0eb58a67d6e824d46924cf782", null ], + [ "process", "classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614", null ], + [ "getRemainingFeatures", "classPercussionOnsetDetector.html#ad3d6767ed137783e84f842b4d4732ffa", null ], + [ "getMinChannelCount", "classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525", null ], + [ "getMaxChannelCount", "classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "getVampApiVersion", "classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf", null ], + [ "getPrograms", "classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af", null ], + [ "getCurrentProgram", "classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3", null ], + [ "selectProgram", "classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353", null ], + [ "m_stepSize", "classPercussionOnsetDetector.html#aabac0cf7e961482b075777e5f0686e6c", null ], + [ "m_blockSize", "classPercussionOnsetDetector.html#a920de543dbcf70a2edd80b5b31313285", null ], + [ "m_threshold", "classPercussionOnsetDetector.html#ab04119adad56d87f2e633de289aab507", null ], + [ "m_sensitivity", "classPercussionOnsetDetector.html#a4e9770f246ba3bc75e7fc2cb8f9010af", null ], + [ "m_priorMagnitudes", "classPercussionOnsetDetector.html#a30daa717267251a9d49afe57c328e989", null ], + [ "m_dfMinus1", "classPercussionOnsetDetector.html#acd80162c65212be7fa91251263fb9c3d", null ], + [ "m_dfMinus2", "classPercussionOnsetDetector.html#a6ad7d8353cc681ff42a63b127cca5779", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classPercussionOnsetDetector__inherit__graph.png Binary file code-docs/classPercussionOnsetDetector__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classPowerSpectrum-members.html --- a/code-docs/classPowerSpectrum-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classPowerSpectrum-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for PowerSpectrum, including all inherited members. @@ -116,14 +117,14 @@ -
    FeatureList typedefVamp::Plugin
    ~Plugin()Vamp::Plugin [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~PowerSpectrum()PowerSpectrum [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classPowerSpectrum.html --- a/code-docs/classPowerSpectrum.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classPowerSpectrum.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: PowerSpectrum Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    PowerSpectrum Class Reference
    - +
    - +

    Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio. More...

    @@ -97,73 +98,73 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + +

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     PowerSpectrum (float inputSampleRate)
    virtual ~PowerSpectrum ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    virtual size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.
     PowerSpectrum (float inputSampleRate)
    virtual ~PowerSpectrum ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    virtual size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.

    Protected Attributes

    size_t m_blockSize
    float m_inputSampleRate
    size_t m_blockSize
    float m_inputSampleRate

    Detailed Description

    Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio.

    @@ -171,7 +172,7 @@

    Definition at line 50 of file PowerSpectrum.h.

    Member Typedef Documentation

    - +
    @@ -186,7 +187,7 @@ - +
    @@ -201,7 +202,7 @@ - +
    @@ -216,7 +217,7 @@ - +
    @@ -227,11 +228,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -242,12 +243,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -258,9 +259,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -271,12 +272,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -290,12 +291,12 @@ - +
    PowerSpectrum::PowerSpectrum PowerSpectrum::PowerSpectrum ( float  inputSampleRate)
    - + @@ -309,12 +310,12 @@

    Member Function Documentation

    - +
    PowerSpectrum::~PowerSpectrum PowerSpectrum::~PowerSpectrum ( ) [virtual]
    - + @@ -352,12 +353,12 @@ - +
    bool PowerSpectrum::initialise bool PowerSpectrum::initialise ( size_t  inputChannels,
    - + @@ -375,12 +376,12 @@ - +
    void PowerSpectrum::reset void PowerSpectrum::reset ( ) [virtual]
    - + @@ -401,12 +402,12 @@ - +
    InputDomain PowerSpectrum::getInputDomain InputDomain PowerSpectrum::getInputDomain ( ) const [inline, virtual]
    - + @@ -426,12 +427,12 @@ - +
    string PowerSpectrum::getIdentifier string PowerSpectrum::getIdentifier ( ) const [virtual]
    - + @@ -450,12 +451,12 @@ - +
    string PowerSpectrum::getName string PowerSpectrum::getName ( ) const [virtual]
    - + @@ -474,12 +475,12 @@ - +
    string PowerSpectrum::getDescription string PowerSpectrum::getDescription ( ) const [virtual]
    - + @@ -497,12 +498,12 @@ - +
    string PowerSpectrum::getMaker string PowerSpectrum::getMaker ( ) const [virtual]
    - + @@ -519,12 +520,12 @@ - +
    int PowerSpectrum::getPluginVersion int PowerSpectrum::getPluginVersion ( ) const [virtual]
    - + @@ -542,12 +543,12 @@ - +
    string PowerSpectrum::getCopyright string PowerSpectrum::getCopyright ( ) const [virtual]
    - + @@ -567,12 +568,12 @@ - +
    PowerSpectrum::OutputList PowerSpectrum::getOutputDescriptors PowerSpectrum::OutputList PowerSpectrum::getOutputDescriptors ( ) const [virtual]
    - + @@ -605,12 +606,12 @@ - +
    PowerSpectrum::FeatureSet PowerSpectrum::process PowerSpectrum::FeatureSet PowerSpectrum::process ( const float *const *  inputBuffers,
    - + @@ -627,12 +628,12 @@ - +
    PowerSpectrum::FeatureSet PowerSpectrum::getRemainingFeatures PowerSpectrum::FeatureSet PowerSpectrum::getRemainingFeatures ( ) [virtual]
    - + @@ -653,12 +654,12 @@ - +
    virtual size_t Vamp::Plugin::getPreferredBlockSize virtual size_t Vamp::Plugin::getPreferredBlockSize ( ) const [inline, virtual, inherited]
    - + @@ -679,12 +680,12 @@ - +
    virtual size_t Vamp::Plugin::getPreferredStepSize virtual size_t Vamp::Plugin::getPreferredStepSize ( ) const [inline, virtual, inherited]
    - + @@ -703,12 +704,12 @@ - +
    virtual size_t Vamp::Plugin::getMinChannelCount virtual size_t Vamp::Plugin::getMinChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -727,12 +728,12 @@ - +
    virtual size_t Vamp::Plugin::getMaxChannelCount virtual size_t Vamp::Plugin::getMaxChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -750,12 +751,12 @@ - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    - + @@ -768,18 +769,18 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 72 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 68 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual unsigned int Vamp::PluginBase::getVampApiVersion virtual unsigned int Vamp::PluginBase::getVampApiVersion ( ) const [inline, virtual, inherited]
    - + @@ -792,18 +793,18 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 208 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 204 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual ParameterList Vamp::PluginBase::getParameterDescriptors virtual ParameterList Vamp::PluginBase::getParameterDescriptors ( ) const [inline, virtual, inherited]
    - + @@ -818,16 +819,16 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 216 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 212 of file vamp-sdk/PluginBase.h.

    - +
    virtual float Vamp::PluginBase::getParameter virtual float Vamp::PluginBase::getParameter ( std::string  )
    - + @@ -852,16 +853,16 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 222 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 218 of file vamp-sdk/PluginBase.h.

    - +
    virtual void Vamp::PluginBase::setParameter virtual void Vamp::PluginBase::setParameter ( std::string  ,
    - + @@ -876,16 +877,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 237 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 233 of file vamp-sdk/PluginBase.h.

    - +
    virtual ProgramList Vamp::PluginBase::getPrograms virtual ProgramList Vamp::PluginBase::getPrograms ( ) const [inline, virtual, inherited]
    - + @@ -898,16 +899,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 242 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 238 of file vamp-sdk/PluginBase.h.

    - +
    virtual std::string Vamp::PluginBase::getCurrentProgram virtual std::string Vamp::PluginBase::getCurrentProgram ( ) const [inline, virtual, inherited]
    - + @@ -922,12 +923,12 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 248 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 244 of file vamp-sdk/PluginBase.h.

    Member Data Documentation

    - +
    virtual void Vamp::PluginBase::selectProgram virtual void Vamp::PluginBase::selectProgram ( std::string  )
    @@ -944,7 +945,7 @@ - +
    @@ -965,15 +966,15 @@
  • PowerSpectrum.h
  • PowerSpectrum.cpp
    • - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classPowerSpectrum.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classPowerSpectrum.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,37 @@ +var classPowerSpectrum = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "PowerSpectrum", "classPowerSpectrum.html#aa2550486513a4abcf7b52869002947e7", null ], + [ "~PowerSpectrum", "classPowerSpectrum.html#ae7081e159ad1da5da1721b3048075306", null ], + [ "initialise", "classPowerSpectrum.html#ae2d046334c4bede5be72a0d97e4dfb29", null ], + [ "reset", "classPowerSpectrum.html#a091ba21e1697ea4208f42e8295c389d9", null ], + [ "getInputDomain", "classPowerSpectrum.html#ae04e0e34847a93f3444d04c802ee56ef", null ], + [ "getIdentifier", "classPowerSpectrum.html#a9e9d8349461cbb88d7565a5e8c51b64e", null ], + [ "getName", "classPowerSpectrum.html#ac9214f9cafeeed3fca549c90aef57623", null ], + [ "getDescription", "classPowerSpectrum.html#a7b48d56dc954f3af344f7e4dcd8993e5", null ], + [ "getMaker", "classPowerSpectrum.html#a9f3e3f759e2b67c771a41f1c276984b2", null ], + [ "getPluginVersion", "classPowerSpectrum.html#ad23d27e4e82f10404a37b933f6a72c33", null ], + [ "getCopyright", "classPowerSpectrum.html#a708b4d335c57643d5ef2b2e1caf43bd9", null ], + [ "getOutputDescriptors", "classPowerSpectrum.html#a6aac5f93e3a8c033026d739fed427242", null ], + [ "process", "classPowerSpectrum.html#aa5664ffc2b37a16db471fae791c1f55f", null ], + [ "getRemainingFeatures", "classPowerSpectrum.html#ac8a9661a785d38f4c5ce8ca2d53e69f9", null ], + [ "getPreferredBlockSize", "classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac", null ], + [ "getPreferredStepSize", "classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567", null ], + [ "getMinChannelCount", "classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525", null ], + [ "getMaxChannelCount", "classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "getVampApiVersion", "classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf", null ], + [ "getParameterDescriptors", "classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21", null ], + [ "getParameter", "classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7", null ], + [ "setParameter", "classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366", null ], + [ "getPrograms", "classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af", null ], + [ "getCurrentProgram", "classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3", null ], + [ "selectProgram", "classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353", null ], + [ "m_blockSize", "classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classPowerSpectrum__inherit__graph.png Binary file code-docs/classPowerSpectrum__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classSpectralCentroid-members.html --- a/code-docs/classSpectralCentroid-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classSpectralCentroid-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for SpectralCentroid, including all inherited members. @@ -117,14 +118,14 @@ -
    FeatureList typedefVamp::Plugin
    ~Plugin()Vamp::Plugin [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~SpectralCentroid()SpectralCentroid [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classSpectralCentroid.html --- a/code-docs/classSpectralCentroid.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classSpectralCentroid.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: SpectralCentroid Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    SpectralCentroid Class Reference
    - +
    - +

    Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio. More...

    @@ -97,81 +98,81 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + +

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     SpectralCentroid (float inputSampleRate)
    virtual ~SpectralCentroid ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    virtual size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.
     SpectralCentroid (float inputSampleRate)
    virtual ~SpectralCentroid ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    virtual size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.

    Protected Attributes

    size_t m_stepSize
    size_t m_blockSize
    float m_inputSampleRate
    size_t m_stepSize
    size_t m_blockSize
    float m_inputSampleRate

    Detailed Description

    Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio.

    Definition at line 47 of file SpectralCentroid.h.

    Member Typedef Documentation

    - +
    @@ -186,7 +187,7 @@ - +
    @@ -201,7 +202,7 @@ - +
    @@ -216,7 +217,7 @@ - +
    @@ -227,11 +228,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -242,12 +243,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -258,9 +259,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -271,12 +272,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -290,12 +291,12 @@ - +
    SpectralCentroid::SpectralCentroid SpectralCentroid::SpectralCentroid ( float  inputSampleRate)
    - + @@ -309,12 +310,12 @@

    Member Function Documentation

    - +
    SpectralCentroid::~SpectralCentroid SpectralCentroid::~SpectralCentroid ( ) [virtual]
    - + @@ -352,12 +353,12 @@ - +
    bool SpectralCentroid::initialise bool SpectralCentroid::initialise ( size_t  inputChannels,
    - + @@ -375,12 +376,12 @@ - +
    void SpectralCentroid::reset void SpectralCentroid::reset ( ) [virtual]
    - + @@ -401,12 +402,12 @@ - +
    InputDomain SpectralCentroid::getInputDomain InputDomain SpectralCentroid::getInputDomain ( ) const [inline, virtual]
    - + @@ -426,12 +427,12 @@ - +
    string SpectralCentroid::getIdentifier string SpectralCentroid::getIdentifier ( ) const [virtual]
    - + @@ -450,12 +451,12 @@ - +
    string SpectralCentroid::getName string SpectralCentroid::getName ( ) const [virtual]
    - + @@ -474,12 +475,12 @@ - +
    string SpectralCentroid::getDescription string SpectralCentroid::getDescription ( ) const [virtual]
    - + @@ -497,12 +498,12 @@ - +
    string SpectralCentroid::getMaker string SpectralCentroid::getMaker ( ) const [virtual]
    - + @@ -519,12 +520,12 @@ - +
    int SpectralCentroid::getPluginVersion int SpectralCentroid::getPluginVersion ( ) const [virtual]
    - + @@ -542,12 +543,12 @@ - +
    string SpectralCentroid::getCopyright string SpectralCentroid::getCopyright ( ) const [virtual]
    - + @@ -567,12 +568,12 @@ - +
    SpectralCentroid::OutputList SpectralCentroid::getOutputDescriptors SpectralCentroid::OutputList SpectralCentroid::getOutputDescriptors ( ) const [virtual]
    - + @@ -605,12 +606,12 @@ - +
    SpectralCentroid::FeatureSet SpectralCentroid::process SpectralCentroid::FeatureSet SpectralCentroid::process ( const float *const *  inputBuffers,
    - + @@ -627,12 +628,12 @@ - +
    SpectralCentroid::FeatureSet SpectralCentroid::getRemainingFeatures SpectralCentroid::FeatureSet SpectralCentroid::getRemainingFeatures ( ) [virtual]
    - + @@ -653,12 +654,12 @@ - +
    virtual size_t Vamp::Plugin::getPreferredBlockSize virtual size_t Vamp::Plugin::getPreferredBlockSize ( ) const [inline, virtual, inherited]
    - + @@ -679,12 +680,12 @@ - +
    virtual size_t Vamp::Plugin::getPreferredStepSize virtual size_t Vamp::Plugin::getPreferredStepSize ( ) const [inline, virtual, inherited]
    - + @@ -703,12 +704,12 @@ - +
    virtual size_t Vamp::Plugin::getMinChannelCount virtual size_t Vamp::Plugin::getMinChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -727,12 +728,12 @@ - +
    virtual size_t Vamp::Plugin::getMaxChannelCount virtual size_t Vamp::Plugin::getMaxChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -750,12 +751,12 @@ - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    - + @@ -768,18 +769,18 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 72 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 68 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual unsigned int Vamp::PluginBase::getVampApiVersion virtual unsigned int Vamp::PluginBase::getVampApiVersion ( ) const [inline, virtual, inherited]
    - + @@ -792,18 +793,18 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 208 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 204 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual ParameterList Vamp::PluginBase::getParameterDescriptors virtual ParameterList Vamp::PluginBase::getParameterDescriptors ( ) const [inline, virtual, inherited]
    - + @@ -818,16 +819,16 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 216 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 212 of file vamp-sdk/PluginBase.h.

    - +
    virtual float Vamp::PluginBase::getParameter virtual float Vamp::PluginBase::getParameter ( std::string  )
    - + @@ -852,16 +853,16 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 222 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 218 of file vamp-sdk/PluginBase.h.

    - +
    virtual void Vamp::PluginBase::setParameter virtual void Vamp::PluginBase::setParameter ( std::string  ,
    - + @@ -876,16 +877,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 237 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 233 of file vamp-sdk/PluginBase.h.

    - +
    virtual ProgramList Vamp::PluginBase::getPrograms virtual ProgramList Vamp::PluginBase::getPrograms ( ) const [inline, virtual, inherited]
    - + @@ -898,16 +899,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 242 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 238 of file vamp-sdk/PluginBase.h.

    - +
    virtual std::string Vamp::PluginBase::getCurrentProgram virtual std::string Vamp::PluginBase::getCurrentProgram ( ) const [inline, virtual, inherited]
    - + @@ -922,12 +923,12 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 248 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 244 of file vamp-sdk/PluginBase.h.

    Member Data Documentation

    - +
    virtual void Vamp::PluginBase::selectProgram virtual void Vamp::PluginBase::selectProgram ( std::string  )
    @@ -944,7 +945,7 @@ - +
    @@ -961,7 +962,7 @@ - +
    @@ -982,15 +983,15 @@
  • SpectralCentroid.h
  • SpectralCentroid.cpp
    • - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classSpectralCentroid.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classSpectralCentroid.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,38 @@ +var classSpectralCentroid = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "SpectralCentroid", "classSpectralCentroid.html#a2cd801ad72f262eceb95ab0d22e7dbcd", null ], + [ "~SpectralCentroid", "classSpectralCentroid.html#a483e0d6757bc3dcf61e8066f764f45c6", null ], + [ "initialise", "classSpectralCentroid.html#aab1ae16f5c68e2b319668f447908cedb", null ], + [ "reset", "classSpectralCentroid.html#a9b5f5581691ff8f46bb7674d8d74395c", null ], + [ "getInputDomain", "classSpectralCentroid.html#a0ec2cb74c1c5f6e57d0bd9dcf7c8f469", null ], + [ "getIdentifier", "classSpectralCentroid.html#a1b2c4c8440c024c4c635fcef5697949f", null ], + [ "getName", "classSpectralCentroid.html#ab7e6a620fea568af431be3cfd9dd5a41", null ], + [ "getDescription", "classSpectralCentroid.html#a8fbb74a46283057d9a0b0e4718ee943c", null ], + [ "getMaker", "classSpectralCentroid.html#ac01ff858bf67e2e93ad5d24a6ba8c8c8", null ], + [ "getPluginVersion", "classSpectralCentroid.html#af64622e66bf678ac2b0b58aa832ca2b3", null ], + [ "getCopyright", "classSpectralCentroid.html#a925747d513d598e0fa21ed0ed6520980", null ], + [ "getOutputDescriptors", "classSpectralCentroid.html#a894ca9740927102bb80b56b5e9e95877", null ], + [ "process", "classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c", null ], + [ "getRemainingFeatures", "classSpectralCentroid.html#a83ba39f0870a2f86837605a958dfab1a", null ], + [ "getPreferredBlockSize", "classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac", null ], + [ "getPreferredStepSize", "classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567", null ], + [ "getMinChannelCount", "classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525", null ], + [ "getMaxChannelCount", "classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "getVampApiVersion", "classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf", null ], + [ "getParameterDescriptors", "classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21", null ], + [ "getParameter", "classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7", null ], + [ "setParameter", "classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366", null ], + [ "getPrograms", "classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af", null ], + [ "getCurrentProgram", "classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3", null ], + [ "selectProgram", "classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353", null ], + [ "m_stepSize", "classSpectralCentroid.html#a49805a090ba58477da4adbefea4392a7", null ], + [ "m_blockSize", "classSpectralCentroid.html#a262f583d71b442bb2d80023e7c85aa4e", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classSpectralCentroid__inherit__graph.png Binary file code-docs/classSpectralCentroid__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1FFT-members.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1FFT-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,96 @@ + + + + + +VampPluginSDK: Member List + + + + + + + + + + + + +
    + + +
    +
    + + + + + + + + + + +
    +
    VampPluginSDK +  2.4 +
    + +
    +
    + + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    Vamp::FFT Member List
    +
    +
    +This is the complete list of members for Vamp::FFT, including all inherited members. + + +
    forward(unsigned int n, const double *ri, const double *ii, double *ro, double *io)Vamp::FFT [static]
    inverse(unsigned int n, const double *ri, const double *ii, double *ro, double *io)Vamp::FFT [static]
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1FFT.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1FFT.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,223 @@ + + + + + +VampPluginSDK: Vamp::FFT Class Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.4 +
    + +
    +
    + + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +Static Public Member Functions
    +
    +
    Vamp::FFT Class Reference
    +
    +
    + +

    A simple FFT implementation provided for convenience of plugin authors. + More...

    + +

    #include <FFT.h>

    + +

    List of all members.

    + + + + + + +

    +Static Public Member Functions

    static void forward (unsigned int n, const double *ri, const double *ii, double *ro, double *io)
     Calculate a forward transform of size n.
    static void inverse (unsigned int n, const double *ri, const double *ii, double *ro, double *io)
     Calculate an inverse transform of size n.
    +

    Detailed Description

    +

    A simple FFT implementation provided for convenience of plugin authors.

    +

    This class provides double-precision FFTs in power-of-two sizes only. It is slower than more sophisticated library implementations. If these requirements aren't suitable, make other arrangements.

    +

    The inverse transform is scaled by 1/n.

    +

    The implementation is from Don Cross's public domain FFT code.

    + +

    Definition at line 58 of file FFT.h.

    +

    Member Function Documentation

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    static void Vamp::FFT::forward (unsigned int n,
    const double * ri,
    const double * ii,
    double * ro,
    double * io 
    ) [static]
    +
    +
    + +

    Calculate a forward transform of size n.

    +

    ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.

    +

    ro and io must point to enough space to receive the real and imaginary component arrays of the output.

    +

    All input and output arrays are of size n.

    + +
    +
    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    static void Vamp::FFT::inverse (unsigned int n,
    const double * ri,
    const double * ii,
    double * ro,
    double * io 
    ) [static]
    +
    +
    + +

    Calculate an inverse transform of size n.

    +

    ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.

    +

    ro and io must point to enough space to receive the real and imaginary component arrays of the output. The output is scaled by 1/n. The output pointers may not be NULL, even if the output is expected to be real.

    +

    All input and output arrays are of size n.

    + +
    +
    +
    The documentation for this class was generated from the following file: +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1FFT.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1FFT.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,5 @@ +var classVamp_1_1FFT = +[ + [ "forward", "classVamp_1_1FFT.html#a219e3f6f0392dbdacad4a47d912f9aca", null ], + [ "inverse", "classVamp_1_1FFT.html#aff98a3610275024cd3cb421e6283ee7f", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Member List @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@
    - +
    This is the complete list of members for Vamp::HostExt::PluginBufferingAdapter, including all inherited members. @@ -125,14 +126,14 @@ -
    FeatureList typedefVamp::Plugin
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~PluginBufferingAdapter()Vamp::HostExt::PluginBufferingAdapter [virtual]
    ~PluginWrapper()Vamp::HostExt::PluginWrapper [virtual]
    + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::HostExt::PluginBufferingAdapter Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::HostExt::PluginBufferingAdapter Class Reference
    - +
    - +

    PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size. More...

    @@ -97,88 +98,88 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + +

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     PluginBufferingAdapter (Plugin *plugin)
     Construct a PluginBufferingAdapter wrapping the given plugin.
    virtual ~PluginBufferingAdapter ()
    size_t getPreferredStepSize () const
     Return the preferred step size for this adapter.
    size_t getPreferredBlockSize () const
     Return the preferred block size for this adapter.
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     Initialise the adapter (and therefore the plugin) for the given number of channels.
    size_t getPluginPreferredStepSize () const
     Return the preferred step size of the plugin wrapped by this adapter.
    size_t getPluginPreferredBlockSize () const
     Return the preferred block size of the plugin wrapped by this adapter.
    void setPluginStepSize (size_t stepSize)
     Set the step size that will be used for the underlying plugin when initialise() is called.
    void setPluginBlockSize (size_t blockSize)
     Set the block size that will be used for the underlying plugin when initialise() is called.
    void getActualStepAndBlockSizes (size_t &stepSize, size_t &blockSize)
     Return the step and block sizes that were actually used when initialising the underlying plugin.
    void setParameter (std::string, float)
     Set a named parameter.
    void selectProgram (std::string)
     Select a program.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
     PluginBufferingAdapter (Plugin *plugin)
     Construct a PluginBufferingAdapter wrapping the given plugin.
    virtual ~PluginBufferingAdapter ()
    size_t getPreferredStepSize () const
     Return the preferred step size for this adapter.
    size_t getPreferredBlockSize () const
     Return the preferred block size for this adapter.
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     Initialise the adapter (and therefore the plugin) for the given number of channels.
    size_t getPluginPreferredStepSize () const
     Return the preferred step size of the plugin wrapped by this adapter.
    size_t getPluginPreferredBlockSize () const
     Return the preferred block size of the plugin wrapped by this adapter.
    void setPluginStepSize (size_t stepSize)
     Set the step size that will be used for the underlying plugin when initialise() is called.
    void setPluginBlockSize (size_t blockSize)
     Set the block size that will be used for the underlying plugin when initialise() is called.
    void getActualStepAndBlockSizes (size_t &stepSize, size_t &blockSize)
     Return the step and block sizes that were actually used when initialising the underlying plugin.
    void setParameter (std::string, float)
     Set a named parameter.
    void selectProgram (std::string)
     Select a program.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.

    Protected Attributes

    Impl * m_impl
    Plugin * m_plugin
    float m_inputSampleRate
    Impl * m_impl
    Plugin * m_plugin
    float m_inputSampleRate

    Detailed Description

    PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size.

    @@ -188,7 +189,7 @@

    Definition at line 75 of file PluginBufferingAdapter.h.

    Member Typedef Documentation

    - +
    @@ -203,7 +204,7 @@ - +
    @@ -218,7 +219,7 @@ - +
    @@ -233,7 +234,7 @@ - +
    @@ -244,11 +245,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -259,12 +260,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -275,9 +276,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -288,12 +289,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -308,12 +309,12 @@ - +
    Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter ( Plugin *  plugin)
    - + @@ -325,12 +326,12 @@

    Member Function Documentation

    - +
    virtual Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter virtual Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter ( ) [virtual]
    - + @@ -346,12 +347,12 @@ - +
    size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize ( ) const [virtual]
    - + @@ -368,12 +369,12 @@ - +
    size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize ( ) const [virtual]
    - + @@ -407,12 +408,12 @@ - +
    bool Vamp::HostExt::PluginBufferingAdapter::initialise bool Vamp::HostExt::PluginBufferingAdapter::initialise ( size_t  channels,
    - + @@ -426,12 +427,12 @@ - +
    size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize ( ) const
    - + @@ -445,12 +446,12 @@ - +
    size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize ( ) const
    - + @@ -465,12 +466,12 @@ - +
    void Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize void Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize ( size_t  stepSize)
    - + @@ -485,12 +486,12 @@ - +
    void Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize void Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize ( size_t  blockSize)
    - + @@ -515,12 +516,12 @@ - +
    void Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes void Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes ( size_t &  stepSize,
    - + @@ -547,12 +548,12 @@ - +
    void Vamp::HostExt::PluginBufferingAdapter::setParameter void Vamp::HostExt::PluginBufferingAdapter::setParameter ( std::string  ,
    - + @@ -569,12 +570,12 @@ - +
    void Vamp::HostExt::PluginBufferingAdapter::selectProgram void Vamp::HostExt::PluginBufferingAdapter::selectProgram ( std::string  )
    - + @@ -590,12 +591,12 @@ - +
    OutputList Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors OutputList Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors ( ) const [virtual]
    - + @@ -611,12 +612,12 @@ - +
    void Vamp::HostExt::PluginBufferingAdapter::reset void Vamp::HostExt::PluginBufferingAdapter::reset ( ) [virtual]
    - + @@ -638,19 +639,19 @@

    Process a single block of input data.

    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.

    -

    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).

    +

    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).

    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.)

    Reimplemented from Vamp::HostExt::PluginWrapper.

    - +
    FeatureSet Vamp::HostExt::PluginBufferingAdapter::process FeatureSet Vamp::HostExt::PluginBufferingAdapter::process ( const float *const *  inputBuffers,
    - + @@ -665,12 +666,12 @@ - +
    FeatureSet Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures FeatureSet Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures ( ) [virtual]
    - + @@ -681,7 +682,7 @@

    Get the plugin's required input domain.

    If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin.

    -

    If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). 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.

    +

    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 process(). 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.

    Implements Vamp::Plugin.

    @@ -689,12 +690,12 @@ - +
    InputDomain Vamp::HostExt::PluginWrapper::getInputDomain InputDomain Vamp::HostExt::PluginWrapper::getInputDomain ( ) const [virtual, inherited]
    - + @@ -709,12 +710,12 @@ - +
    unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion ( ) const [virtual, inherited]
    - + @@ -732,12 +733,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getIdentifier std::string Vamp::HostExt::PluginWrapper::getIdentifier ( ) const [virtual, inherited]
    - + @@ -754,12 +755,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getName std::string Vamp::HostExt::PluginWrapper::getName ( ) const [virtual, inherited]
    - + @@ -776,12 +777,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getDescription std::string Vamp::HostExt::PluginWrapper::getDescription ( ) const [virtual, inherited]
    - + @@ -797,12 +798,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getMaker std::string Vamp::HostExt::PluginWrapper::getMaker ( ) const [virtual, inherited]
    - + @@ -817,12 +818,12 @@ - +
    int Vamp::HostExt::PluginWrapper::getPluginVersion int Vamp::HostExt::PluginWrapper::getPluginVersion ( ) const [virtual, inherited]
    - + @@ -838,12 +839,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCopyright std::string Vamp::HostExt::PluginWrapper::getCopyright ( ) const [virtual, inherited]
    - + @@ -858,12 +859,12 @@ - +
    ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ( ) const [virtual, inherited]
    - + @@ -880,12 +881,12 @@ - +
    float Vamp::HostExt::PluginWrapper::getParameter float Vamp::HostExt::PluginWrapper::getParameter ( std::string  )
    - + @@ -902,12 +903,12 @@ - +
    ProgramList Vamp::HostExt::PluginWrapper::getPrograms ProgramList Vamp::HostExt::PluginWrapper::getPrograms ( ) const [virtual, inherited]
    - + @@ -922,12 +923,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCurrentProgram std::string Vamp::HostExt::PluginWrapper::getCurrentProgram ( ) const [virtual, inherited]
    - + @@ -942,12 +943,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMinChannelCount size_t Vamp::HostExt::PluginWrapper::getMinChannelCount ( ) const [virtual, inherited]
    - + @@ -962,14 +963,14 @@ - +
    template<typename WrapperType >
    size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount ( ) const [virtual, inherited]
    - + @@ -989,12 +990,12 @@ - +
    WrapperType* Vamp::HostExt::PluginWrapper::getWrapper WrapperType* Vamp::HostExt::PluginWrapper::getWrapper ( ) [inline, inherited]
    - + @@ -1013,7 +1014,7 @@

    Member Data Documentation

    - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    @@ -1028,7 +1029,7 @@ - +
    @@ -1043,7 +1044,7 @@ - +
    @@ -1063,7 +1064,7 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,44 @@ +var classVamp_1_1HostExt_1_1PluginBufferingAdapter = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "PluginBufferingAdapter", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a1276bcfcbe1414b33eeefbd7b2b702fe", null ], + [ "~PluginBufferingAdapter", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a96263f7b0910a10eeae86f20db007e55", null ], + [ "getPreferredStepSize", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60", null ], + [ "getPreferredBlockSize", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03", null ], + [ "initialise", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8", null ], + [ "getPluginPreferredStepSize", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ad7fad500331808b5cdf90f5a45019b02", null ], + [ "getPluginPreferredBlockSize", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7045be875de9dd226d2e2a222e957de0", null ], + [ "setPluginStepSize", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ac99898d78a01a7fad4def4d6c5fd3a7e", null ], + [ "setPluginBlockSize", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa80ae1bff6f95e805811df2c3770a98c", null ], + [ "getActualStepAndBlockSizes", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa065985fd864f6869d1bc7fea6fa2ece", null ], + [ "setParameter", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3", null ], + [ "selectProgram", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927", null ], + [ "getOutputDescriptors", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845", null ], + [ "reset", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a131fd9fe8a1795d7370d8a721176868a", null ], + [ "process", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0", null ], + [ "getRemainingFeatures", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a28423951b2eda1a1fc371485434f417b", null ], + [ "getInputDomain", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214", null ], + [ "getVampApiVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff", null ], + [ "getIdentifier", "classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904", null ], + [ "getName", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088", null ], + [ "getDescription", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c", null ], + [ "getMaker", "classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb", null ], + [ "getPluginVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5", null ], + [ "getCopyright", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566", null ], + [ "getParameterDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36", null ], + [ "getParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c", null ], + [ "getPrograms", "classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802", null ], + [ "getCurrentProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651", null ], + [ "getMinChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8", null ], + [ "getMaxChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58", null ], + [ "getWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "m_impl", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a51e10c9c63c0349fd74c6d604de5554e", null ], + [ "m_plugin", "classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png Binary file code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter-members.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::HostExt::PluginChannelAdapter, including all inherited members. @@ -121,14 +122,14 @@ -
    FeatureList typedefVamp::Plugin
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~PluginChannelAdapter()Vamp::HostExt::PluginChannelAdapter [virtual]
    ~PluginWrapper()Vamp::HostExt::PluginWrapper [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::HostExt::PluginChannelAdapter Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::HostExt::PluginChannelAdapter Class Reference
    - +
    - +

    PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data. More...

    @@ -97,80 +98,80 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + +

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     PluginChannelAdapter (Plugin *plugin)
     Construct a PluginChannelAdapter wrapping the given plugin.
    virtual ~PluginChannelAdapter ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet processInterleaved (const float *inputBuffer, RealTime timestamp)
     Call process(), providing interleaved audio data with the number of channels passed to initialise().
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
     PluginChannelAdapter (Plugin *plugin)
     Construct a PluginChannelAdapter wrapping the given plugin.
    virtual ~PluginChannelAdapter ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet processInterleaved (const float *inputBuffer, RealTime timestamp)
     Call process(), providing interleaved audio data with the number of channels passed to initialise().
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.

    Protected Attributes

    Impl * m_impl
    Plugin * m_plugin
    float m_inputSampleRate
    Impl * m_impl
    Plugin * m_plugin
    float m_inputSampleRate

    Detailed Description

    PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data.

    @@ -196,11 +197,11 @@

    Note that PluginChannelAdapter does not override the minimum and maximum channel counts returned by the wrapped plugin. The host will need to be aware that it is using a PluginChannelAdapter, and be prepared to ignore these counts as necessary. (This contrasts with the approach used in PluginInputDomainAdapter, which aims to make the host completely unaware of which underlying input domain is in fact in use.)

    (The rationale for this is that a host may wish to use the PluginChannelAdapter but still discriminate in some way on the basis of the number of channels actually supported. For example, a simple stereo audio host may prefer to reject plugins that require more than two channels on the grounds that doesn't actually understand what they are for, rather than allow the channel adapter to make a potentially meaningless channel conversion for them.)

    In every respect other than its management of channels, the PluginChannelAdapter behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted.

    -
    Note:
    This class was introduced in version 1.1 of the Vamp plugin SDK.
    +
    Note:
    This class was introduced in version 1.1 of the Vamp plugin SDK.

    Definition at line 112 of file PluginChannelAdapter.h.

    Member Typedef Documentation

    - +
    @@ -215,7 +216,7 @@ - +
    @@ -230,7 +231,7 @@ - +
    @@ -245,7 +246,7 @@ - +
    @@ -256,11 +257,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -271,12 +272,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -287,9 +288,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -300,12 +301,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -320,12 +321,12 @@ - +
    Vamp::HostExt::PluginChannelAdapter::PluginChannelAdapter Vamp::HostExt::PluginChannelAdapter::PluginChannelAdapter ( Plugin *  plugin)
    - + @@ -337,12 +338,12 @@

    Member Function Documentation

    - +
    virtual Vamp::HostExt::PluginChannelAdapter::~PluginChannelAdapter virtual Vamp::HostExt::PluginChannelAdapter::~PluginChannelAdapter ( ) [virtual]
    - + @@ -376,12 +377,12 @@ - +
    bool Vamp::HostExt::PluginChannelAdapter::initialise bool Vamp::HostExt::PluginChannelAdapter::initialise ( size_t  inputChannels,
    - + @@ -403,19 +404,19 @@

    Process a single block of input data.

    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.

    -

    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).

    +

    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).

    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.)

    Reimplemented from Vamp::HostExt::PluginWrapper.

    - +
    FeatureSet Vamp::HostExt::PluginChannelAdapter::process FeatureSet Vamp::HostExt::PluginChannelAdapter::process ( const float *const *  inputBuffers,
    - + @@ -437,16 +438,16 @@

    Call process(), providing interleaved audio data with the number of channels passed to initialise().

    The adapter will de-interleave into temporary buffers as appropriate before calling process().

    -
    Note:
    This function was introduced in version 1.4 of the Vamp plugin SDK.
    +
    Note:
    This function was introduced in version 1.4 of the Vamp plugin SDK.
    - +
    FeatureSet Vamp::HostExt::PluginChannelAdapter::processInterleaved FeatureSet Vamp::HostExt::PluginChannelAdapter::processInterleaved ( const float *  inputBuffer,
    - + @@ -464,12 +465,12 @@ - +
    void Vamp::HostExt::PluginWrapper::reset void Vamp::HostExt::PluginWrapper::reset ( ) [virtual, inherited]
    - + @@ -480,7 +481,7 @@

    Get the plugin's required input domain.

    If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin.

    -

    If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). 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.

    +

    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 process(). 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.

    Implements Vamp::Plugin.

    @@ -488,12 +489,12 @@ - +
    InputDomain Vamp::HostExt::PluginWrapper::getInputDomain InputDomain Vamp::HostExt::PluginWrapper::getInputDomain ( ) const [virtual, inherited]
    - + @@ -508,12 +509,12 @@ - +
    unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion ( ) const [virtual, inherited]
    - + @@ -531,12 +532,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getIdentifier std::string Vamp::HostExt::PluginWrapper::getIdentifier ( ) const [virtual, inherited]
    - + @@ -553,12 +554,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getName std::string Vamp::HostExt::PluginWrapper::getName ( ) const [virtual, inherited]
    - + @@ -575,12 +576,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getDescription std::string Vamp::HostExt::PluginWrapper::getDescription ( ) const [virtual, inherited]
    - + @@ -596,12 +597,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getMaker std::string Vamp::HostExt::PluginWrapper::getMaker ( ) const [virtual, inherited]
    - + @@ -616,12 +617,12 @@ - +
    int Vamp::HostExt::PluginWrapper::getPluginVersion int Vamp::HostExt::PluginWrapper::getPluginVersion ( ) const [virtual, inherited]
    - + @@ -637,12 +638,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCopyright std::string Vamp::HostExt::PluginWrapper::getCopyright ( ) const [virtual, inherited]
    - + @@ -657,12 +658,12 @@ - +
    ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ( ) const [virtual, inherited]
    - + @@ -679,12 +680,12 @@ - +
    float Vamp::HostExt::PluginWrapper::getParameter float Vamp::HostExt::PluginWrapper::getParameter ( std::string  )
    - + @@ -713,12 +714,12 @@ - +
    void Vamp::HostExt::PluginWrapper::setParameter void Vamp::HostExt::PluginWrapper::setParameter ( std::string  ,
    - + @@ -735,12 +736,12 @@ - +
    ProgramList Vamp::HostExt::PluginWrapper::getPrograms ProgramList Vamp::HostExt::PluginWrapper::getPrograms ( ) const [virtual, inherited]
    - + @@ -755,12 +756,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCurrentProgram std::string Vamp::HostExt::PluginWrapper::getCurrentProgram ( ) const [virtual, inherited]
    - + @@ -779,12 +780,12 @@ - +
    void Vamp::HostExt::PluginWrapper::selectProgram void Vamp::HostExt::PluginWrapper::selectProgram ( std::string  )
    - + @@ -803,12 +804,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize ( ) const [virtual, inherited]
    - + @@ -827,12 +828,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize ( ) const [virtual, inherited]
    - + @@ -847,12 +848,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMinChannelCount size_t Vamp::HostExt::PluginWrapper::getMinChannelCount ( ) const [virtual, inherited]
    - + @@ -867,12 +868,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount ( ) const [virtual, inherited]
    - + @@ -890,12 +891,12 @@ - +
    OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors ( ) const [virtual, inherited]
    - + @@ -912,14 +913,14 @@ - +
    template<typename WrapperType >
    FeatureSet Vamp::HostExt::PluginWrapper::getRemainingFeatures FeatureSet Vamp::HostExt::PluginWrapper::getRemainingFeatures ( ) [virtual, inherited]
    - + @@ -939,12 +940,12 @@ - +
    WrapperType* Vamp::HostExt::PluginWrapper::getWrapper WrapperType* Vamp::HostExt::PluginWrapper::getWrapper ( ) [inline, inherited]
    - + @@ -963,7 +964,7 @@

    Member Data Documentation

    - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    @@ -978,7 +979,7 @@ - +
    @@ -993,7 +994,7 @@ - +
    @@ -1013,7 +1014,7 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,40 @@ +var classVamp_1_1HostExt_1_1PluginChannelAdapter = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "PluginChannelAdapter", "classVamp_1_1HostExt_1_1PluginChannelAdapter.html#a2cda2b672708264f9a33c43bad3acdd8", null ], + [ "~PluginChannelAdapter", "classVamp_1_1HostExt_1_1PluginChannelAdapter.html#acb9a20fefd130e323b1eb2ced43e521c", null ], + [ "initialise", "classVamp_1_1HostExt_1_1PluginChannelAdapter.html#ade0473c8fc54636431967cbf41649c1c", null ], + [ "process", "classVamp_1_1HostExt_1_1PluginChannelAdapter.html#a6ff37bf754ff8711dbcb2f020fa3902c", null ], + [ "processInterleaved", "classVamp_1_1HostExt_1_1PluginChannelAdapter.html#a5c94c3eb1dbc8899fe58527bbb7bb61f", null ], + [ "reset", "classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6", null ], + [ "getInputDomain", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214", null ], + [ "getVampApiVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff", null ], + [ "getIdentifier", "classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904", null ], + [ "getName", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088", null ], + [ "getDescription", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c", null ], + [ "getMaker", "classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb", null ], + [ "getPluginVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5", null ], + [ "getCopyright", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566", null ], + [ "getParameterDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36", null ], + [ "getParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c", null ], + [ "setParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5", null ], + [ "getPrograms", "classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802", null ], + [ "getCurrentProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651", null ], + [ "selectProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf", null ], + [ "getPreferredStepSize", "classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e", null ], + [ "getPreferredBlockSize", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01", null ], + [ "getMinChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8", null ], + [ "getMaxChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58", null ], + [ "getOutputDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270", null ], + [ "getRemainingFeatures", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e", null ], + [ "getWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "m_impl", "classVamp_1_1HostExt_1_1PluginChannelAdapter.html#ae3a74a2e6c4cd33dce9f4248e73c6701", null ], + [ "m_plugin", "classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter__inherit__graph.png Binary file code-docs/classVamp_1_1HostExt_1_1PluginChannelAdapter__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter-members.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::HostExt::PluginInputDomainAdapter, including all inherited members. @@ -139,14 +140,14 @@ -
    BartlettWindow enum valueVamp::HostExt::PluginInputDomainAdapter
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~PluginInputDomainAdapter()Vamp::HostExt::PluginInputDomainAdapter [virtual]
    ~PluginWrapper()Vamp::HostExt::PluginWrapper [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::HostExt::PluginInputDomainAdapter Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::HostExt::PluginInputDomainAdapter Class Reference
    - +
    - +

    PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-domain input for plugins that need it. More...

    @@ -97,12 +98,12 @@ - - - + - - + - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + +

    Public Types

    enum  ProcessTimestampMethod { ShiftTimestamp, +
    enum  ProcessTimestampMethod { ShiftTimestamp, ShiftData, NoShift }
     ProcessTimestampMethod determines how the PluginInputDomainAdapter handles timestamps for the data passed to the process() function of the plugin it wraps, in the case where the plugin is expecting frequency-domain data. More...
    enum  WindowType {
    +
     ProcessTimestampMethod determines how the PluginInputDomainAdapter handles timestamps for the data passed to the process() function of the plugin it wraps, in the case where the plugin is expecting frequency-domain data. More...
    enum  WindowType {
      RectangularWindow = 0, BartlettWindow = 1, TriangularWindow = 1, @@ -116,103 +117,103 @@   BlackmanHarrisWindow = 8
    }
     The set of supported window shapes. More...
    enum  InputDomain { TimeDomain, +
     The set of supported window shapes. More...
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     PluginInputDomainAdapter (Plugin *plugin)
     Construct a PluginInputDomainAdapter wrapping the given plugin.
    virtual ~PluginInputDomainAdapter ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    void setProcessTimestampMethod (ProcessTimestampMethod)
     Set the method used for timestamp adjustment in plugins taking frequency-domain input.
    ProcessTimestampMethod getProcessTimestampMethod () const
     Retrieve the method used for timestamp adjustment in plugins taking frequency-domain input.
    RealTime getTimestampAdjustment () const
     Return the amount by which the timestamps supplied to process() are being incremented when they are passed to the plugin's own process() implementation.
    WindowType getWindowType () const
     Return the current window shape.
    void setWindowType (WindowType type)
     Set the current window shape.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
     PluginInputDomainAdapter (Plugin *plugin)
     Construct a PluginInputDomainAdapter wrapping the given plugin.
    virtual ~PluginInputDomainAdapter ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    void setProcessTimestampMethod (ProcessTimestampMethod)
     Set the method used for timestamp adjustment in plugins taking frequency-domain input.
    ProcessTimestampMethod getProcessTimestampMethod () const
     Retrieve the method used for timestamp adjustment in plugins taking frequency-domain input.
    RealTime getTimestampAdjustment () const
     Return the amount by which the timestamps supplied to process() are being incremented when they are passed to the plugin's own process() implementation.
    WindowType getWindowType () const
     Return the current window shape.
    void setWindowType (WindowType type)
     Set the current window shape.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.

    Protected Attributes

    Impl * m_impl
    Plugin * m_plugin
    float m_inputSampleRate
    Impl * m_impl
    Plugin * m_plugin
    float m_inputSampleRate

    Detailed Description

    PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-domain input for plugins that need it.

    This permits a host to use time- and frequency-domain plugins interchangeably without needing to handle the conversion itself.

    -

    This adapter uses a basic windowed FFT (using Hann window by default) that supports power-of-two block sizes only. If a frequency domain plugin requests a non-power-of-two blocksize, the adapter will adjust it to a nearby power of two instead. Thus, getPreferredBlockSize() will always return a power of two if the wrapped plugin is a frequency domain one. If the plugin doesn't accept the adjusted power of two block size, initialise() will fail.

    +

    This adapter uses a basic windowed FFT (using Hann window by default) that supports power-of-two block sizes only. If a frequency domain plugin requests a non-power-of-two blocksize, the adapter will adjust it to a nearby power of two instead. Thus, getPreferredBlockSize() will always return a power of two if the wrapped plugin is a frequency domain one. If the plugin doesn't accept the adjusted power of two block size, initialise() will fail.

    The adapter provides no way for the host to discover whether the underlying plugin is actually a time or frequency domain plugin (except that if the preferred block size is not a power of two, it must be a time domain plugin).

    -

    The FFT implementation is simple and self-contained, but unlikely to be the fastest available: a host can usually do better if it cares enough.

    -

    The window shape for the FFT frame can be set using setWindowType and the current shape retrieved using getWindowType. (This was added in v2.3 of the SDK.)

    +

    The FFT implementation is simple and self-contained, but unlikely to be the fastest available: a host can usually do better if it cares enough.

    +

    The window shape for the FFT frame can be set using setWindowType and the current shape retrieved using getWindowType. (This was added in v2.3 of the SDK.)

    In every respect other than its input domain handling, the PluginInputDomainAdapter behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted.

    -
    Note:
    This class was introduced in version 1.1 of the Vamp plugin SDK.
    +
    Note:
    This class was introduced in version 1.1 of the Vamp plugin SDK.

    Definition at line 87 of file PluginInputDomainAdapter.h.

    Member Typedef Documentation

    - +
    @@ -227,7 +228,7 @@ - +
    @@ -242,7 +243,7 @@ - +
    @@ -257,7 +258,7 @@ - +
    @@ -268,11 +269,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -283,12 +284,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -306,11 +307,11 @@

    If ProcessTimestampMethod is set to ShiftData, then the timestamp passed to the wrapped plugin will be the same as that passed to the process call of the wrapper, but the data block used to calculate the input will be shifted back (earlier) by half of the window size, with half a block of zero padding at the start of the first process call. This has the advantage of preserving the first half block of audio without any deterioration from window shaping.

    If ProcessTimestampMethod is set to NoShift, then no adjustment will be made and the timestamps will be incorrect.

    Enumerator:
    - - -
    ShiftTimestamp  +
    ShiftTimestamp 
    ShiftData  +
    ShiftData 
    NoShift  +
    NoShift 
    @@ -320,7 +321,7 @@
    - +
    @@ -333,27 +334,27 @@

    The set of supported window shapes.

    Enumerator:
    - - - - - - - - -
    RectangularWindow  +
    RectangularWindow 
    BartlettWindow  +
    BartlettWindow 
    TriangularWindow  +
    TriangularWindow 

    synonym for RectangularWindow

    HammingWindow  +
    HammingWindow 

    synonym for BartlettWindow

    HanningWindow  +
    HanningWindow 
    HannWindow  +
    HannWindow 

    synonym for HannWindow

    BlackmanWindow  +
    BlackmanWindow 

    synonym for HanningWindow

    NuttallWindow  +
    NuttallWindow 
    BlackmanHarrisWindow  +
    BlackmanHarrisWindow 
    @@ -363,7 +364,7 @@
    - +
    @@ -374,9 +375,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -387,12 +388,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -407,12 +408,12 @@ - +
    Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter ( Plugin *  plugin)
    - + @@ -424,12 +425,12 @@

    Member Function Documentation

    - +
    virtual Vamp::HostExt::PluginInputDomainAdapter::~PluginInputDomainAdapter virtual Vamp::HostExt::PluginInputDomainAdapter::~PluginInputDomainAdapter ( ) [virtual]
    - + @@ -463,12 +464,12 @@ - +
    bool Vamp::HostExt::PluginInputDomainAdapter::initialise bool Vamp::HostExt::PluginInputDomainAdapter::initialise ( size_t  inputChannels,
    - + @@ -484,12 +485,12 @@ - +
    void Vamp::HostExt::PluginInputDomainAdapter::reset void Vamp::HostExt::PluginInputDomainAdapter::reset ( ) [virtual]
    - + @@ -500,18 +501,18 @@

    Get the plugin's required input domain.

    If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin.

    -

    If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). 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.

    +

    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 process(). 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.

    Reimplemented from Vamp::HostExt::PluginWrapper.

    - +
    InputDomain Vamp::HostExt::PluginInputDomainAdapter::getInputDomain InputDomain Vamp::HostExt::PluginInputDomainAdapter::getInputDomain ( ) const [virtual]
    - + @@ -528,12 +529,12 @@ - +
    size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize ( ) const [virtual]
    - + @@ -550,12 +551,12 @@ - +
    size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredBlockSize size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredBlockSize ( ) const [virtual]
    - + @@ -577,19 +578,19 @@

    Process a single block of input data.

    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.

    -

    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).

    +

    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).

    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.)

    Reimplemented from Vamp::HostExt::PluginWrapper.

    - +
    FeatureSet Vamp::HostExt::PluginInputDomainAdapter::process FeatureSet Vamp::HostExt::PluginInputDomainAdapter::process ( const float *const *  inputBuffers,
    - + @@ -605,12 +606,12 @@ - +
    void Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod void Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod ( ProcessTimestampMethod  )
    - + @@ -624,12 +625,12 @@ - +
    ProcessTimestampMethod Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod ProcessTimestampMethod Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod ( ) const
    - + @@ -648,12 +649,12 @@ - +
    RealTime Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment RealTime Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment ( ) const
    - + @@ -667,12 +668,12 @@ - +
    WindowType Vamp::HostExt::PluginInputDomainAdapter::getWindowType WindowType Vamp::HostExt::PluginInputDomainAdapter::getWindowType ( ) const
    - + @@ -686,12 +687,12 @@ - +
    void Vamp::HostExt::PluginInputDomainAdapter::setWindowType void Vamp::HostExt::PluginInputDomainAdapter::setWindowType ( WindowType  type)
    - + @@ -706,12 +707,12 @@ - +
    unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion ( ) const [virtual, inherited]
    - + @@ -729,12 +730,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getIdentifier std::string Vamp::HostExt::PluginWrapper::getIdentifier ( ) const [virtual, inherited]
    - + @@ -751,12 +752,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getName std::string Vamp::HostExt::PluginWrapper::getName ( ) const [virtual, inherited]
    - + @@ -773,12 +774,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getDescription std::string Vamp::HostExt::PluginWrapper::getDescription ( ) const [virtual, inherited]
    - + @@ -794,12 +795,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getMaker std::string Vamp::HostExt::PluginWrapper::getMaker ( ) const [virtual, inherited]
    - + @@ -814,12 +815,12 @@ - +
    int Vamp::HostExt::PluginWrapper::getPluginVersion int Vamp::HostExt::PluginWrapper::getPluginVersion ( ) const [virtual, inherited]
    - + @@ -835,12 +836,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCopyright std::string Vamp::HostExt::PluginWrapper::getCopyright ( ) const [virtual, inherited]
    - + @@ -855,12 +856,12 @@ - +
    ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ( ) const [virtual, inherited]
    - + @@ -877,12 +878,12 @@ - +
    float Vamp::HostExt::PluginWrapper::getParameter float Vamp::HostExt::PluginWrapper::getParameter ( std::string  )
    - + @@ -911,12 +912,12 @@ - +
    void Vamp::HostExt::PluginWrapper::setParameter void Vamp::HostExt::PluginWrapper::setParameter ( std::string  ,
    - + @@ -933,12 +934,12 @@ - +
    ProgramList Vamp::HostExt::PluginWrapper::getPrograms ProgramList Vamp::HostExt::PluginWrapper::getPrograms ( ) const [virtual, inherited]
    - + @@ -953,12 +954,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCurrentProgram std::string Vamp::HostExt::PluginWrapper::getCurrentProgram ( ) const [virtual, inherited]
    - + @@ -977,12 +978,12 @@ - +
    void Vamp::HostExt::PluginWrapper::selectProgram void Vamp::HostExt::PluginWrapper::selectProgram ( std::string  )
    - + @@ -997,12 +998,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMinChannelCount size_t Vamp::HostExt::PluginWrapper::getMinChannelCount ( ) const [virtual, inherited]
    - + @@ -1017,12 +1018,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount ( ) const [virtual, inherited]
    - + @@ -1040,12 +1041,12 @@ - +
    OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors ( ) const [virtual, inherited]
    - + @@ -1062,14 +1063,14 @@ - +
    template<typename WrapperType >
    FeatureSet Vamp::HostExt::PluginWrapper::getRemainingFeatures FeatureSet Vamp::HostExt::PluginWrapper::getRemainingFeatures ( ) [virtual, inherited]
    - + @@ -1089,12 +1090,12 @@ - +
    WrapperType* Vamp::HostExt::PluginWrapper::getWrapper WrapperType* Vamp::HostExt::PluginWrapper::getWrapper ( ) [inline, inherited]
    - + @@ -1113,7 +1114,7 @@

    Member Data Documentation

    - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    @@ -1128,7 +1129,7 @@ - +
    @@ -1143,7 +1144,7 @@ - +
    @@ -1163,7 +1164,7 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,46 @@ +var classVamp_1_1HostExt_1_1PluginInputDomainAdapter = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "ProcessTimestampMethod", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577", null ], + [ "WindowType", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dc", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "PluginInputDomainAdapter", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a878e7275acdb77efc7a802944305039d", null ], + [ "~PluginInputDomainAdapter", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#aba2cbfa650d8a7c9181dbdb49b10aad0", null ], + [ "initialise", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c", null ], + [ "reset", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a984a12b5b4cb0be1e2f7a0aa84106c4c", null ], + [ "getInputDomain", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a", null ], + [ "getPreferredStepSize", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ad979af9f1cbf2eeb16f4eaedb4a4f565", null ], + [ "getPreferredBlockSize", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5", null ], + [ "process", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231", null ], + [ "setProcessTimestampMethod", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a1d7366f8cab39abc01ebfc7bf7ca8089", null ], + [ "getProcessTimestampMethod", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#acfc7a9121f678fd085448f68f15c9eae", null ], + [ "getTimestampAdjustment", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ac1ab6af0fcda0a4c3f050c54b2db4769", null ], + [ "getWindowType", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab143065e1a65f1d860cb26b32d5a9c1e", null ], + [ "setWindowType", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a652bf9f25352a4fa89dd80ff816558d4", null ], + [ "getVampApiVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff", null ], + [ "getIdentifier", "classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904", null ], + [ "getName", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088", null ], + [ "getDescription", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c", null ], + [ "getMaker", "classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb", null ], + [ "getPluginVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5", null ], + [ "getCopyright", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566", null ], + [ "getParameterDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36", null ], + [ "getParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c", null ], + [ "setParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5", null ], + [ "getPrograms", "classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802", null ], + [ "getCurrentProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651", null ], + [ "selectProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf", null ], + [ "getMinChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8", null ], + [ "getMaxChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58", null ], + [ "getOutputDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270", null ], + [ "getRemainingFeatures", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e", null ], + [ "getWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "m_impl", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a9fa8a6b8a4e41b6e3f2fabc0d23678cc", null ], + [ "m_plugin", "classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__graph.png Binary file code-docs/classVamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginLoader-members.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginLoader-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginLoader-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::HostExt::PluginLoader, including all inherited members. @@ -96,14 +97,14 @@ -
    ADAPT_ALL enum valueVamp::HostExt::PluginLoader
    PluginKeyList typedefVamp::HostExt::PluginLoader
    PluginLoader()Vamp::HostExt::PluginLoader [protected]
    ~PluginLoader()Vamp::HostExt::PluginLoader [protected, virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginLoader.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginLoader.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginLoader.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::HostExt::PluginLoader Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::HostExt::PluginLoader Class Reference
    - +
    - +

    Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the typical plugin-path, library naming, and categorisation conventions described in the Vamp SDK documentation. More...

    @@ -93,7 +94,7 @@ - - - - - - - - + + + + + + + - - - - - - - - - - + + + + + + + + + + - - + + - - + + - + - +

    Public Types

    enum  AdapterFlags {
    +
    enum  AdapterFlags {
      ADAPT_INPUT_DOMAIN = 0x01, ADAPT_CHANNEL_COUNT = 0x02, ADAPT_BUFFER_SIZE = 0x04, @@ -102,49 +103,49 @@   ADAPT_ALL = 0xff
    }
     AdapterFlags contains a set of values that may be OR'd together to indicate in which circumstances PluginLoader should use a plugin adapter to make a plugin easier to use for a host that does not want to cater for complex features. More...
    typedef std::string PluginKey
     PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system".
    typedef std::vector< PluginKey > PluginKeyList
     PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().
    typedef std::vector< std::string > PluginCategoryHierarchy
     PluginCategoryHierarchy is a sequence of general->specific category names, as may be associated with a single plugin.
     AdapterFlags contains a set of values that may be OR'd together to indicate in which circumstances PluginLoader should use a plugin adapter to make a plugin easier to use for a host that does not want to cater for complex features. More...
    typedef std::string PluginKey
     PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system".
    typedef std::vector< PluginKey > PluginKeyList
     PluginKeyList is a sequence of plugin keys, such as returned by listPlugins().
    typedef std::vector< std::string > PluginCategoryHierarchy
     PluginCategoryHierarchy is a sequence of general->specific category names, as may be associated with a single plugin.

    Public Member Functions

    PluginKeyList listPlugins ()
     Search for all available Vamp plugins, and return a list of them in the order in which they were found.
    Plugin * loadPlugin (PluginKey key, float inputSampleRate, int adapterFlags=0)
     Load a Vamp plugin, given its identifying key.
    PluginKey composePluginKey (std::string libraryName, std::string identifier)
     Given a Vamp plugin library name and plugin identifier, return the corresponding plugin key in a form suitable for passing in to loadPlugin().
    PluginCategoryHierarchy getPluginCategory (PluginKey plugin)
     Return the category hierarchy for a Vamp plugin, given its identifying key.
    std::string getLibraryPathForPlugin (PluginKey plugin)
     Return the file path of the dynamic library from which the given plugin will be loaded (if available).
    PluginKeyList listPlugins ()
     Search for all available Vamp plugins, and return a list of them in the order in which they were found.
    Plugin * loadPlugin (PluginKey key, float inputSampleRate, int adapterFlags=0)
     Load a Vamp plugin, given its identifying key.
    PluginKey composePluginKey (std::string libraryName, std::string identifier)
     Given a Vamp plugin library name and plugin identifier, return the corresponding plugin key in a form suitable for passing in to loadPlugin().
    PluginCategoryHierarchy getPluginCategory (PluginKey plugin)
     Return the category hierarchy for a Vamp plugin, given its identifying key.
    std::string getLibraryPathForPlugin (PluginKey plugin)
     Return the file path of the dynamic library from which the given plugin will be loaded (if available).

    Static Public Member Functions

    static PluginLoader * getInstance ()
     Obtain a pointer to the singleton instance of PluginLoader.
    static PluginLoader * getInstance ()
     Obtain a pointer to the singleton instance of PluginLoader.

    Protected Member Functions

     PluginLoader ()
    virtual ~PluginLoader ()
     PluginLoader ()
    virtual ~PluginLoader ()

    Protected Attributes

    Impl * m_impl
    Impl * m_impl

    Static Protected Attributes

    static PluginLoader * m_instance
    static PluginLoader * m_instance

    Detailed Description

    Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the typical plugin-path, library naming, and categorisation conventions described in the Vamp SDK documentation.

    This class is intended to greatly simplify the task of becoming a Vamp plugin host for any C++ application.

    Hosts are not required by the Vamp specification to use the same plugin search path and naming conventions as implemented by this class, and are certainly not required to use this actual class. But we do strongly recommend it.

    -
    Note:
    This class was introduced in version 1.1 of the Vamp plugin SDK.
    +
    Note:
    This class was introduced in version 1.1 of the Vamp plugin SDK.

    Definition at line 72 of file PluginLoader.h.

    Member Typedef Documentation

    - +
    @@ -158,13 +159,13 @@

    PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system".

    It consists of the lower-cased base name of the plugin library, a colon separator, and the identifier string for the plugin. It is only meaningful in the context of a given plugin path (the one returned by PluginHostAdapter::getPluginPath()).

    Use composePluginKey() to construct a plugin key from a known plugin library name and identifier.

    -

    Note: the fact that the library component of the key is lower-cased implies that library names are matched case-insensitively by the PluginLoader class, regardless of the case sensitivity of the underlying filesystem. (Plugin identifiers _are_ case sensitive, however.) Also, it is not possible to portably extract a working library name from a plugin key, as the result may fail on case-sensitive filesystems. Use getLibraryPathForPlugin() instead.

    +

    Note: the fact that the library component of the key is lower-cased implies that library names are matched case-insensitively by the PluginLoader class, regardless of the case sensitivity of the underlying filesystem. (Plugin identifiers are case sensitive, however.) Also, it is not possible to portably extract a working library name from a plugin key, as the result may fail on case-sensitive filesystems. Use getLibraryPathForPlugin() instead.

    Definition at line 101 of file PluginLoader.h.

    - +
    @@ -181,7 +182,7 @@ - +
    @@ -194,14 +195,14 @@

    PluginCategoryHierarchy is a sequence of general->specific category names, as may be associated with a single plugin.

    This sequence describes the location of a plugin within a category forest, containing the human-readable names of the plugin's category tree root, followed by each of the nodes down to the leaf containing the plugin.

    -
    See also:
    getPluginCategory()
    +
    See also:
    getPluginCategory()

    Definition at line 119 of file PluginLoader.h.

    Member Enumeration Documentation

    - +
    @@ -221,15 +222,15 @@

    ADAPT_ALL - Perform all available adaptations that are meaningful for the plugin.

    See PluginInputDomainAdapter, PluginChannelAdapter and PluginBufferingAdapter for more details of the classes that the loader may use if these flags are set.

    Enumerator:
    - - - - -
    ADAPT_INPUT_DOMAIN  +
    ADAPT_INPUT_DOMAIN 
    ADAPT_CHANNEL_COUNT  +
    ADAPT_CHANNEL_COUNT 
    ADAPT_BUFFER_SIZE  +
    ADAPT_BUFFER_SIZE 
    ADAPT_ALL_SAFE  +
    ADAPT_ALL_SAFE 
    ADAPT_ALL  +
    ADAPT_ALL 
    @@ -240,12 +241,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -256,12 +257,12 @@ - +
    Vamp::HostExt::PluginLoader::PluginLoader Vamp::HostExt::PluginLoader::PluginLoader ( ) [protected]
    - + @@ -273,12 +274,12 @@

    Member Function Documentation

    - +
    virtual Vamp::HostExt::PluginLoader::~PluginLoader virtual Vamp::HostExt::PluginLoader::~PluginLoader ( ) [protected, virtual]
    - + @@ -292,12 +293,12 @@ - +
    static PluginLoader* Vamp::HostExt::PluginLoader::getInstance static PluginLoader* Vamp::HostExt::PluginLoader::getInstance ( ) [static]
    - + @@ -312,12 +313,12 @@ - +
    PluginKeyList Vamp::HostExt::PluginLoader::listPlugins PluginKeyList Vamp::HostExt::PluginLoader::listPlugins ( )
    - + @@ -346,24 +347,24 @@

    Load a Vamp plugin, given its identifying key.

    If the plugin could not be loaded, returns 0.

    The returned plugin should be deleted (using the standard C++ delete keyword) after use.

    -
    Parameters:
    +
    Parameters:
    Plugin* Vamp::HostExt::PluginLoader::loadPlugin Plugin* Vamp::HostExt::PluginLoader::loadPlugin ( PluginKey  key,
    adapterFlagsa bitwise OR of the values in the AdapterFlags enumeration, indicating under which circumstances an adapter should be used to wrap the original plugin. If adapterFlags is 0, no optional adapters will be used. Otherwise, the returned plugin may be of an adapter class type which will behave identically to the original plugin, apart from any particular features implemented by the adapter itself.
    -
    See also:
    AdapterFlags, PluginInputDomainAdapter, PluginChannelAdapter
    +
    See also:
    AdapterFlags, PluginInputDomainAdapter, PluginChannelAdapter

    Referenced by enumeratePlugins(), printPluginCategoryList(), and runPlugin().

    - +
    - + @@ -389,12 +390,12 @@ - +
    PluginKey Vamp::HostExt::PluginLoader::composePluginKey PluginKey Vamp::HostExt::PluginLoader::composePluginKey ( std::string  libraryName,
    - + @@ -406,18 +407,18 @@

    Return the category hierarchy for a Vamp plugin, given its identifying key.

    If the plugin has no category information, return an empty hierarchy.

    -
    See also:
    PluginCategoryHierarchy
    +
    See also:
    PluginCategoryHierarchy

    Referenced by enumeratePlugins(), and printPluginCategoryList().

    - +
    PluginCategoryHierarchy Vamp::HostExt::PluginLoader::getPluginCategory PluginCategoryHierarchy Vamp::HostExt::PluginLoader::getPluginCategory ( PluginKey  plugin)
    - + @@ -434,7 +435,7 @@

    Member Data Documentation

    - +
    std::string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin std::string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin ( PluginKey  plugin)
    @@ -449,7 +450,7 @@ - +
    @@ -467,7 +468,7 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginLoader.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginLoader.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,17 @@ +var classVamp_1_1HostExt_1_1PluginLoader = +[ + [ "PluginKey", "classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d", null ], + [ "PluginKeyList", "classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a", null ], + [ "PluginCategoryHierarchy", "classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364", null ], + [ "AdapterFlags", "classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494", null ], + [ "PluginLoader", "classVamp_1_1HostExt_1_1PluginLoader.html#a5ab9e0281244bef7976c6c0ce1a55c24", null ], + [ "~PluginLoader", "classVamp_1_1HostExt_1_1PluginLoader.html#ad74ab52bc6aa2514b3a6b3f679fc492c", null ], + [ "getInstance", "classVamp_1_1HostExt_1_1PluginLoader.html#a1d77fa1d58ee4fee2985b5af02380326", null ], + [ "listPlugins", "classVamp_1_1HostExt_1_1PluginLoader.html#aff51b52bb68aa2934ccf26ad1d284f28", null ], + [ "loadPlugin", "classVamp_1_1HostExt_1_1PluginLoader.html#a964689eb9688cd7e58e8c82ebb0d305f", null ], + [ "composePluginKey", "classVamp_1_1HostExt_1_1PluginLoader.html#acc6865d27825c100d7b6f9ed6ecf5207", null ], + [ "getPluginCategory", "classVamp_1_1HostExt_1_1PluginLoader.html#a52746ea66339ad981b868a031a3b382d", null ], + [ "getLibraryPathForPlugin", "classVamp_1_1HostExt_1_1PluginLoader.html#a4bbcb7873e617bbc9f79eade1f90f7ad", null ], + [ "m_impl", "classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072", null ], + [ "m_instance", "classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter-members.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::HostExt::PluginSummarisingAdapter, including all inherited members. @@ -138,14 +139,14 @@ -
    AveragingMethod enum nameVamp::HostExt::PluginSummarisingAdapter
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~PluginSummarisingAdapter()Vamp::HostExt::PluginSummarisingAdapter [virtual]
    ~PluginWrapper()Vamp::HostExt::PluginWrapper [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::HostExt::PluginSummarisingAdapter Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::HostExt::PluginSummarisingAdapter Class Reference
    - +
    - +

    PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean and median averages of output features, for use in any context where an available plugin produces individual values but the result that is actually needed is some sort of aggregate. More...

    @@ -97,7 +98,7 @@ - - - - - + + - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + +

    Public Types

    enum  SummaryType {
    +
    enum  SummaryType {
      Minimum = 0, Maximum = 1, Mean = 2, @@ -112,100 +113,100 @@ UnknownSummaryType = 999
    }
    enum  AveragingMethod { SampleAverage = 0, +
    enum  AveragingMethod { SampleAverage = 0, ContinuousTimeAverage = 1 }
     AveragingMethod indicates how the adapter should handle average-based summaries of features whose results are not equally spaced in time. More...
    typedef std::set< RealTime > SegmentBoundaries
    enum  InputDomain { TimeDomain, +
     AveragingMethod indicates how the adapter should handle average-based summaries of features whose results are not equally spaced in time. More...
    typedef std::set< RealTime > SegmentBoundaries
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     PluginSummarisingAdapter (Plugin *plugin)
     Construct a PluginSummarisingAdapter wrapping the given plugin.
    virtual ~PluginSummarisingAdapter ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    void setSummarySegmentBoundaries (const SegmentBoundaries &)
     Specify a series of segment boundaries, such that one summary will be returned for each of the contiguous intra-boundary segments.
    FeatureList getSummaryForOutput (int output, SummaryType type, AveragingMethod method=SampleAverage)
     Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod.
    FeatureSet getSummaryForAllOutputs (SummaryType type, AveragingMethod method=SampleAverage)
     Return summaries of the features that were returned on all of the plugin's outputs, using the given SummaryType and AveragingMethod.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
     PluginSummarisingAdapter (Plugin *plugin)
     Construct a PluginSummarisingAdapter wrapping the given plugin.
    virtual ~PluginSummarisingAdapter ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    void setSummarySegmentBoundaries (const SegmentBoundaries &)
     Specify a series of segment boundaries, such that one summary will be returned for each of the contiguous intra-boundary segments.
    FeatureList getSummaryForOutput (int output, SummaryType type, AveragingMethod method=SampleAverage)
     Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod.
    FeatureSet getSummaryForAllOutputs (SummaryType type, AveragingMethod method=SampleAverage)
     Return summaries of the features that were returned on all of the plugin's outputs, using the given SummaryType and AveragingMethod.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.

    Protected Attributes

    Impl * m_impl
    Plugin * m_plugin
    float m_inputSampleRate
    Impl * m_impl
    Plugin * m_plugin
    float m_inputSampleRate

    Detailed Description

    PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean and median averages of output features, for use in any context where an available plugin produces individual values but the result that is actually needed is some sort of aggregate.

    To make use of PluginSummarisingAdapter, the host should configure, initialise and run the plugin through the adapter interface just as normal. Then, after the process and getRemainingFeatures methods have been properly called and processing is complete, the host may call getSummaryForOutput or getSummaryForAllOutputs to obtain summarised features: averages, maximum values, etc, depending on the SummaryType passed to the function.

    By default PluginSummarisingAdapter calculates a single summary of each output's feature across the whole duration of processed audio. A host needing summaries of sub-segments of the whole audio may call setSummarySegmentBoundaries before retrieving the summaries, providing a list of times such that one summary will be provided for each segment between two consecutive times.

    PluginSummarisingAdapter is straightforward rather than fast. It calculates all of the summary types for all outputs always, and then returns only the ones that are requested. It is designed on the basis that, for most features, summarising and storing summarised results is far cheaper than calculating the results in the first place. If this is not true for your particular feature, PluginSummarisingAdapter may not be the best approach for you.

    -
    Note:
    This class was introduced in version 2.0 of the Vamp plugin SDK.
    +
    Note:
    This class was introduced in version 2.0 of the Vamp plugin SDK.

    Definition at line 86 of file PluginSummarisingAdapter.h.

    Member Typedef Documentation

    - +
    @@ -220,7 +221,7 @@ - +
    @@ -235,7 +236,7 @@ - +
    @@ -250,7 +251,7 @@ - +
    @@ -265,7 +266,7 @@ - +
    @@ -276,11 +277,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -291,12 +292,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -307,25 +308,25 @@
    Enumerator:
    - - - - - - - - - -
    Minimum  +
    Minimum 
    Maximum  +
    Maximum 
    Mean  +
    Mean 
    Median  +
    Median 
    Mode  +
    Mode 
    Sum  +
    Sum 
    Variance  +
    Variance 
    StandardDeviation  +
    StandardDeviation 
    Count  +
    Count 
    UnknownSummaryType  +
    UnknownSummaryType 
    @@ -335,7 +336,7 @@
    - +
    @@ -351,9 +352,9 @@

    If ContinuousTimeAverage is specified, each feature will be considered to have a duration, either as specified in the feature's duration field, or until the following feature: thus, for example, the mean will be the sum of the products of values and durations, divided by the total duration.

    Although SampleAverage is useful for many types of feature, ContinuousTimeAverage is essential for some situations, for example finding the result that spans the largest proportion of the input given a feature that emits a new result only when the value changes (the modal value integrated over time).

    Enumerator:
    - -
    SampleAverage  +
    SampleAverage 
    ContinuousTimeAverage  +
    ContinuousTimeAverage 
    @@ -363,7 +364,7 @@
    - +
    @@ -374,9 +375,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -387,12 +388,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -407,12 +408,12 @@ - +
    Vamp::HostExt::PluginSummarisingAdapter::PluginSummarisingAdapter Vamp::HostExt::PluginSummarisingAdapter::PluginSummarisingAdapter ( Plugin *  plugin)
    - + @@ -424,12 +425,12 @@

    Member Function Documentation

    - +
    virtual Vamp::HostExt::PluginSummarisingAdapter::~PluginSummarisingAdapter virtual Vamp::HostExt::PluginSummarisingAdapter::~PluginSummarisingAdapter ( ) [virtual]
    - + @@ -463,12 +464,12 @@ - +
    bool Vamp::HostExt::PluginSummarisingAdapter::initialise bool Vamp::HostExt::PluginSummarisingAdapter::initialise ( size_t  inputChannels,
    - + @@ -484,12 +485,12 @@ - +
    void Vamp::HostExt::PluginSummarisingAdapter::reset void Vamp::HostExt::PluginSummarisingAdapter::reset ( ) [virtual]
    - + @@ -511,19 +512,19 @@

    Process a single block of input data.

    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.

    -

    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).

    +

    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).

    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.)

    Reimplemented from Vamp::HostExt::PluginWrapper.

    - +
    FeatureSet Vamp::HostExt::PluginSummarisingAdapter::process FeatureSet Vamp::HostExt::PluginSummarisingAdapter::process ( const float *const *  inputBuffers,
    - + @@ -538,12 +539,12 @@ - +
    FeatureSet Vamp::HostExt::PluginSummarisingAdapter::getRemainingFeatures FeatureSet Vamp::HostExt::PluginSummarisingAdapter::getRemainingFeatures ( ) [virtual]
    - + @@ -559,12 +560,12 @@ - +
    void Vamp::HostExt::PluginSummarisingAdapter::setSummarySegmentBoundaries void Vamp::HostExt::PluginSummarisingAdapter::setSummarySegmentBoundaries ( const SegmentBoundaries &  )
    - + @@ -579,7 +580,7 @@ - + @@ -595,12 +596,12 @@ - +
    FeatureList Vamp::HostExt::PluginSummarisingAdapter::getSummaryForOutput FeatureList Vamp::HostExt::PluginSummarisingAdapter::getSummaryForOutput ( int  output, AveragingMethod method = SampleAverage method = SampleAverage 
    - + @@ -609,7 +610,7 @@ - + @@ -625,12 +626,12 @@ - +
    FeatureSet Vamp::HostExt::PluginSummarisingAdapter::getSummaryForAllOutputs FeatureSet Vamp::HostExt::PluginSummarisingAdapter::getSummaryForAllOutputs ( SummaryType  type, AveragingMethod method = SampleAverage method = SampleAverage 
    - + @@ -641,7 +642,7 @@

    Get the plugin's required input domain.

    If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin.

    -

    If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). 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.

    +

    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 process(). 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.

    Implements Vamp::Plugin.

    @@ -649,12 +650,12 @@ - +
    InputDomain Vamp::HostExt::PluginWrapper::getInputDomain InputDomain Vamp::HostExt::PluginWrapper::getInputDomain ( ) const [virtual, inherited]
    - + @@ -669,12 +670,12 @@ - +
    unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion ( ) const [virtual, inherited]
    - + @@ -692,12 +693,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getIdentifier std::string Vamp::HostExt::PluginWrapper::getIdentifier ( ) const [virtual, inherited]
    - + @@ -714,12 +715,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getName std::string Vamp::HostExt::PluginWrapper::getName ( ) const [virtual, inherited]
    - + @@ -736,12 +737,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getDescription std::string Vamp::HostExt::PluginWrapper::getDescription ( ) const [virtual, inherited]
    - + @@ -757,12 +758,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getMaker std::string Vamp::HostExt::PluginWrapper::getMaker ( ) const [virtual, inherited]
    - + @@ -777,12 +778,12 @@ - +
    int Vamp::HostExt::PluginWrapper::getPluginVersion int Vamp::HostExt::PluginWrapper::getPluginVersion ( ) const [virtual, inherited]
    - + @@ -798,12 +799,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCopyright std::string Vamp::HostExt::PluginWrapper::getCopyright ( ) const [virtual, inherited]
    - + @@ -818,12 +819,12 @@ - +
    ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ( ) const [virtual, inherited]
    - + @@ -840,12 +841,12 @@ - +
    float Vamp::HostExt::PluginWrapper::getParameter float Vamp::HostExt::PluginWrapper::getParameter ( std::string  )
    - + @@ -874,12 +875,12 @@ - +
    void Vamp::HostExt::PluginWrapper::setParameter void Vamp::HostExt::PluginWrapper::setParameter ( std::string  ,
    - + @@ -896,12 +897,12 @@ - +
    ProgramList Vamp::HostExt::PluginWrapper::getPrograms ProgramList Vamp::HostExt::PluginWrapper::getPrograms ( ) const [virtual, inherited]
    - + @@ -916,12 +917,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCurrentProgram std::string Vamp::HostExt::PluginWrapper::getCurrentProgram ( ) const [virtual, inherited]
    - + @@ -940,12 +941,12 @@ - +
    void Vamp::HostExt::PluginWrapper::selectProgram void Vamp::HostExt::PluginWrapper::selectProgram ( std::string  )
    - + @@ -964,12 +965,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize ( ) const [virtual, inherited]
    - + @@ -988,12 +989,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize ( ) const [virtual, inherited]
    - + @@ -1008,12 +1009,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMinChannelCount size_t Vamp::HostExt::PluginWrapper::getMinChannelCount ( ) const [virtual, inherited]
    - + @@ -1028,12 +1029,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount ( ) const [virtual, inherited]
    - + @@ -1051,14 +1052,14 @@ - +
    template<typename WrapperType >
    OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors ( ) const [virtual, inherited]
    - + @@ -1078,12 +1079,12 @@ - +
    WrapperType* Vamp::HostExt::PluginWrapper::getWrapper WrapperType* Vamp::HostExt::PluginWrapper::getWrapper ( ) [inline, inherited]
    - + @@ -1102,7 +1103,7 @@

    Member Data Documentation

    - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    @@ -1117,7 +1118,7 @@ - +
    @@ -1132,7 +1133,7 @@ - +
    @@ -1152,7 +1153,7 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,45 @@ +var classVamp_1_1HostExt_1_1PluginSummarisingAdapter = +[ + [ "SegmentBoundaries", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b", null ], + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "SummaryType", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705", null ], + [ "AveragingMethod", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "PluginSummarisingAdapter", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a31b41f54560a2ae6c3ec1a945f3f1d68", null ], + [ "~PluginSummarisingAdapter", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a47846e7cc0ef4a29335e08b9645316d0", null ], + [ "initialise", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745", null ], + [ "reset", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3402381d145d507bd26d1a67e3616911", null ], + [ "process", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846", null ], + [ "getRemainingFeatures", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688", null ], + [ "setSummarySegmentBoundaries", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1a659500ca1290a228c0b9b91f6ac0b7", null ], + [ "getSummaryForOutput", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#abe13faa68d3244b962dbd362671e23f9", null ], + [ "getSummaryForAllOutputs", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ac3f93d9ca2d25c9fdc80d0ba10eaaa6b", null ], + [ "getInputDomain", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214", null ], + [ "getVampApiVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff", null ], + [ "getIdentifier", "classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904", null ], + [ "getName", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088", null ], + [ "getDescription", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c", null ], + [ "getMaker", "classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb", null ], + [ "getPluginVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5", null ], + [ "getCopyright", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566", null ], + [ "getParameterDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36", null ], + [ "getParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c", null ], + [ "setParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5", null ], + [ "getPrograms", "classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802", null ], + [ "getCurrentProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651", null ], + [ "selectProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf", null ], + [ "getPreferredStepSize", "classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e", null ], + [ "getPreferredBlockSize", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01", null ], + [ "getMinChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8", null ], + [ "getMaxChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58", null ], + [ "getOutputDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270", null ], + [ "getWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "m_impl", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af131140817d9f131650af98b6b8d7a94", null ], + [ "m_plugin", "classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter__inherit__graph.png Binary file code-docs/classVamp_1_1HostExt_1_1PluginSummarisingAdapter__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginWrapper-members.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginWrapper-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginWrapper-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::HostExt::PluginWrapper, including all inherited members. @@ -117,14 +118,14 @@ -
    FeatureList typedefVamp::Plugin
    ~Plugin()Vamp::Plugin [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~PluginWrapper()Vamp::HostExt::PluginWrapper [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginWrapper.html --- a/code-docs/classVamp_1_1HostExt_1_1PluginWrapper.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginWrapper.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::HostExt::PluginWrapper Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::HostExt::PluginWrapper Class Reference
    - +
    - +

    PluginWrapper is a simple base class for adapter plugins. More...

    @@ -98,87 +99,87 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + +

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

    virtual ~PluginWrapper ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual ~PluginWrapper ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    template<typename WrapperType >
    WrapperType * getWrapper ()
     Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.

    Protected Member Functions

     PluginWrapper (Plugin *plugin)
     PluginWrapper (Plugin *plugin)

    Protected Attributes

    Plugin * m_plugin
    float m_inputSampleRate
    Plugin * m_plugin
    float m_inputSampleRate

    Detailed Description

    PluginWrapper is a simple base class for adapter plugins.

    It takes a pointer to a "to be wrapped" Vamp plugin on construction, and provides implementations of all the Vamp plugin methods that simply delegate through to the wrapped plugin. A subclass can therefore override only the methods that are meaningful for the particular adapter.

    -
    Note:
    This class was introduced in version 1.1 of the Vamp plugin SDK.
    +
    Note:
    This class was introduced in version 1.1 of the Vamp plugin SDK.

    Definition at line 62 of file PluginWrapper.h.

    Member Typedef Documentation

    - +
    @@ -193,7 +194,7 @@ - +
    @@ -208,7 +209,7 @@ - +
    @@ -223,7 +224,7 @@ - +
    @@ -234,11 +235,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -249,12 +250,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -265,9 +266,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -278,12 +279,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -294,12 +295,12 @@ - +
    virtual Vamp::HostExt::PluginWrapper::~PluginWrapper virtual Vamp::HostExt::PluginWrapper::~PluginWrapper ( ) [virtual]
    - + @@ -312,12 +313,12 @@

    Member Function Documentation

    - +
    Vamp::HostExt::PluginWrapper::PluginWrapper Vamp::HostExt::PluginWrapper::PluginWrapper ( Plugin *  plugin)
    - + @@ -353,12 +354,12 @@ - +
    bool Vamp::HostExt::PluginWrapper::initialise bool Vamp::HostExt::PluginWrapper::initialise ( size_t  inputChannels,
    - + @@ -376,12 +377,12 @@ - +
    void Vamp::HostExt::PluginWrapper::reset void Vamp::HostExt::PluginWrapper::reset ( ) [virtual]
    - + @@ -392,7 +393,7 @@

    Get the plugin's required input domain.

    If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin.

    -

    If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). 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.

    +

    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 process(). 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.

    Implements Vamp::Plugin.

    @@ -400,12 +401,12 @@ - +
    InputDomain Vamp::HostExt::PluginWrapper::getInputDomain InputDomain Vamp::HostExt::PluginWrapper::getInputDomain ( ) const [virtual]
    - + @@ -420,12 +421,12 @@ - +
    unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion ( ) const [virtual]
    - + @@ -443,12 +444,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getIdentifier std::string Vamp::HostExt::PluginWrapper::getIdentifier ( ) const [virtual]
    - + @@ -465,12 +466,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getName std::string Vamp::HostExt::PluginWrapper::getName ( ) const [virtual]
    - + @@ -487,12 +488,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getDescription std::string Vamp::HostExt::PluginWrapper::getDescription ( ) const [virtual]
    - + @@ -508,12 +509,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getMaker std::string Vamp::HostExt::PluginWrapper::getMaker ( ) const [virtual]
    - + @@ -528,12 +529,12 @@ - +
    int Vamp::HostExt::PluginWrapper::getPluginVersion int Vamp::HostExt::PluginWrapper::getPluginVersion ( ) const [virtual]
    - + @@ -549,12 +550,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCopyright std::string Vamp::HostExt::PluginWrapper::getCopyright ( ) const [virtual]
    - + @@ -569,12 +570,12 @@ - +
    ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors ( ) const [virtual]
    - + @@ -591,12 +592,12 @@ - +
    float Vamp::HostExt::PluginWrapper::getParameter float Vamp::HostExt::PluginWrapper::getParameter ( std::string  )
    - + @@ -625,12 +626,12 @@ - +
    void Vamp::HostExt::PluginWrapper::setParameter void Vamp::HostExt::PluginWrapper::setParameter ( std::string  ,
    - + @@ -647,12 +648,12 @@ - +
    ProgramList Vamp::HostExt::PluginWrapper::getPrograms ProgramList Vamp::HostExt::PluginWrapper::getPrograms ( ) const [virtual]
    - + @@ -667,12 +668,12 @@ - +
    std::string Vamp::HostExt::PluginWrapper::getCurrentProgram std::string Vamp::HostExt::PluginWrapper::getCurrentProgram ( ) const [virtual]
    - + @@ -691,12 +692,12 @@ - +
    void Vamp::HostExt::PluginWrapper::selectProgram void Vamp::HostExt::PluginWrapper::selectProgram ( std::string  )
    - + @@ -715,12 +716,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize ( ) const [virtual]
    - + @@ -739,12 +740,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize ( ) const [virtual]
    - + @@ -759,12 +760,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMinChannelCount size_t Vamp::HostExt::PluginWrapper::getMinChannelCount ( ) const [virtual]
    - + @@ -779,12 +780,12 @@ - +
    size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount ( ) const [virtual]
    - + @@ -802,12 +803,12 @@ - +
    OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors ( ) const [virtual]
    - + @@ -829,7 +830,7 @@

    Process a single block of input data.

    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.

    -

    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).

    +

    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).

    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.)

    Implements Vamp::Plugin.

    @@ -838,12 +839,12 @@ - +
    FeatureSet Vamp::HostExt::PluginWrapper::process FeatureSet Vamp::HostExt::PluginWrapper::process ( const float *const *  inputBuffers,
    - + @@ -860,14 +861,14 @@ - +
    template<typename WrapperType >
    FeatureSet Vamp::HostExt::PluginWrapper::getRemainingFeatures FeatureSet Vamp::HostExt::PluginWrapper::getRemainingFeatures ( ) [virtual]
    - + @@ -887,12 +888,12 @@ - +
    WrapperType* Vamp::HostExt::PluginWrapper::getWrapper WrapperType* Vamp::HostExt::PluginWrapper::getWrapper ( ) [inline]
    - + @@ -911,7 +912,7 @@

    Member Data Documentation

    - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    @@ -926,7 +927,7 @@ - +
    @@ -946,7 +947,7 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginWrapper.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1HostExt_1_1PluginWrapper.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,38 @@ +var classVamp_1_1HostExt_1_1PluginWrapper = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "~PluginWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac4fb6cfd7c0d3b2c8576a4e9dc61f518", null ], + [ "PluginWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html#a35cc2d42f8322f5022e89859a79c97be", null ], + [ "initialise", "classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137", null ], + [ "reset", "classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6", null ], + [ "getInputDomain", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214", null ], + [ "getVampApiVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff", null ], + [ "getIdentifier", "classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904", null ], + [ "getName", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088", null ], + [ "getDescription", "classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c", null ], + [ "getMaker", "classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb", null ], + [ "getPluginVersion", "classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5", null ], + [ "getCopyright", "classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566", null ], + [ "getParameterDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36", null ], + [ "getParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c", null ], + [ "setParameter", "classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5", null ], + [ "getPrograms", "classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802", null ], + [ "getCurrentProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651", null ], + [ "selectProgram", "classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf", null ], + [ "getPreferredStepSize", "classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e", null ], + [ "getPreferredBlockSize", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01", null ], + [ "getMinChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8", null ], + [ "getMaxChannelCount", "classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58", null ], + [ "getOutputDescriptors", "classVamp_1_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270", null ], + [ "process", "classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf", null ], + [ "getRemainingFeatures", "classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e", null ], + [ "getWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "m_plugin", "classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png Binary file code-docs/classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1Plugin-members.html --- a/code-docs/classVamp_1_1Plugin-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1Plugin-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::Plugin, including all inherited members. @@ -113,14 +114,14 @@ -
    FeatureList typedefVamp::Plugin
    TimeDomain enum valueVamp::Plugin
    ~Plugin()Vamp::Plugin [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1Plugin.html --- a/code-docs/classVamp_1_1Plugin.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1Plugin.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::Plugin Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::Plugin Class Reference
    - +
    - +

    Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio or related data. More...

    @@ -99,78 +100,78 @@ - - + + - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - +

    Classes

    struct  Feature
    struct  OutputDescriptor
    struct  Feature
    struct  OutputDescriptor

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

    virtual ~Plugin ()
    virtual bool initialise (size_t inputChannels, size_t stepSize, size_t blockSize)=0
     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).
    virtual void reset ()=0
     Reset the plugin after use, to prepare it for another clean run.
    virtual InputDomain getInputDomain () const =0
     Get the plugin's required input domain.
    virtual size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    virtual size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual OutputList getOutputDescriptors () const =0
     Get the outputs of this plugin.
    virtual FeatureSet process (const float *const *inputBuffers, RealTime timestamp)=0
     Process a single block of input data.
    virtual FeatureSet getRemainingFeatures ()=0
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual std::string getIdentifier () const =0
     Get the computer-usable name of the plugin.
    virtual std::string getName () const =0
     Get a human-readable name or title of the plugin.
    virtual std::string getDescription () const =0
     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".
    virtual std::string getMaker () const =0
     Get the name of the author or vendor of the plugin in human-readable form.
    virtual std::string getCopyright () const =0
     Get the copyright statement or licensing summary for the plugin.
    virtual int getPluginVersion () const =0
     Get the version number of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.
    virtual ~Plugin ()
    virtual bool initialise (size_t inputChannels, size_t stepSize, size_t blockSize)=0
     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).
    virtual void reset ()=0
     Reset the plugin after use, to prepare it for another clean run.
    virtual InputDomain getInputDomain () const =0
     Get the plugin's required input domain.
    virtual size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    virtual size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual OutputList getOutputDescriptors () const =0
     Get the outputs of this plugin.
    virtual FeatureSet process (const float *const *inputBuffers, RealTime timestamp)=0
     Process a single block of input data.
    virtual FeatureSet getRemainingFeatures ()=0
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual std::string getIdentifier () const =0
     Get the computer-usable name of the plugin.
    virtual std::string getName () const =0
     Get a human-readable name or title of the plugin.
    virtual std::string getDescription () const =0
     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".
    virtual std::string getMaker () const =0
     Get the name of the author or vendor of the plugin in human-readable form.
    virtual std::string getCopyright () const =0
     Get the copyright statement or licensing summary for the plugin.
    virtual int getPluginVersion () const =0
     Get the version number of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.

    Protected Member Functions

     Plugin (float inputSampleRate)
     Plugin (float inputSampleRate)

    Protected Attributes

    float m_inputSampleRate
    float m_inputSampleRate

    Detailed Description

    Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio or related data.

    @@ -178,20 +179,38 @@

    Note that this class inherits several abstract methods from PluginBase. These must be implemented by the subclass.

    PLUGIN LIFECYCLE

    Feature extraction plugins are managed differently from real-time plugins (such as VST effects). The main difference is that the parameters for a feature extraction plugin are configured before the plugin is used, and do not change during use.

    -

    1. Host constructs the plugin, passing it the input sample rate. The plugin may do basic initialisation, but should not do anything computationally expensive at this point. You must make sure your plugin is cheap to construct, otherwise you'll seriously affect the startup performance of almost all hosts. If you have serious initialisation to do, the proper place is in initialise() (step 5).

    -

    2. Host may query the plugin's available outputs.

    -

    3. Host queries programs and parameter descriptors, and may set some or all of them. Parameters that are not explicitly set should take their default values as specified in the parameter descriptor. When a program is set, the parameter values may change and the host will re-query them to check.

    -

    4. Host queries the preferred step size, block size and number of channels. These may all vary depending on the parameter values. (Note however that you cannot make the number of distinct outputs dependent on parameter values.)

    -

    5. Plugin is properly initialised with a call to initialise. This fixes the step size, block size, and number of channels, as well as all of the parameter and program settings. If the values passed in to initialise do not match the plugin's advertised preferred values from step 4, the plugin may refuse to initialise and return false (although if possible it should accept the new values). Any computationally expensive setup code should take place here.

    -

    6. Host finally checks the number of values, resolution, extents etc per output (which may vary depending on the number of channels, step size and block size as well as the parameter values).

    -

    7. Host will repeatedly call the process method to pass in blocks of input data. This method may return features extracted from that data (if the plugin is causal).

    -

    8. Host will call getRemainingFeatures exactly once, after all the input data has been processed. This may return any non-causal or leftover features.

    -

    9. At any point after initialise was called, the host may optionally call the reset method and restart processing. (This does not mean it can change the parameters, which are fixed from initialise until destruction.)

    +
      +
    1. Host constructs the plugin, passing it the input sample rate. The plugin may do basic initialisation, but should not do anything computationally expensive at this point. You must make sure your plugin is cheap to construct, otherwise you'll seriously affect the startup performance of almost all hosts. If you have serious initialisation to do, the proper place is in initialise() (step 5).
      2. +
    +
      +
    1. Host may query the plugin's available outputs.
      2. +
    +
      +
    1. Host queries programs and parameter descriptors, and may set some or all of them. Parameters that are not explicitly set should take their default values as specified in the parameter descriptor. When a program is set, the parameter values may change and the host will re-query them to check.
      2. +
    +
      +
    1. Host queries the preferred step size, block size and number of channels. These may all vary depending on the parameter values. (Note however that you cannot make the number of distinct outputs dependent on parameter values.)
      2. +
    +
      +
    1. Plugin is properly initialised with a call to initialise. This fixes the step size, block size, and number of channels, as well as all of the parameter and program settings. If the values passed in to initialise do not match the plugin's advertised preferred values from step 4, the plugin may refuse to initialise and return false (although if possible it should accept the new values). Any computationally expensive setup code should take place here.
      2. +
    +
      +
    1. Host finally checks the number of values, resolution, extents etc per output (which may vary depending on the number of channels, step size and block size as well as the parameter values).
      2. +
    +
      +
    1. Host will repeatedly call the process method to pass in blocks of input data. This method may return features extracted from that data (if the plugin is causal).
      2. +
    +
      +
    1. Host will call getRemainingFeatures exactly once, after all the input data has been processed. This may return any non-causal or leftover features.
      2. +
    +
      +
    1. At any point after initialise was called, the host may optionally call the reset method and restart processing. (This does not mean it can change the parameters, which are fixed from initialise until destruction.)
      2. +

    A plugin does not need to handle the case where setParameter or selectProgram is called after initialise has been called. It's the host's responsibility not to do that. Similarly, the plugin may safely assume that initialise is called no more than once.

    Definition at line 124 of file vamp-sdk/Plugin.h.

    Member Typedef Documentation

    - +
    @@ -206,7 +225,7 @@ - +
    @@ -221,7 +240,7 @@ - +
    @@ -236,7 +255,7 @@ - +
    @@ -247,11 +266,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -262,12 +281,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -278,9 +297,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -291,12 +310,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -309,12 +328,12 @@ - +
    virtual Vamp::Plugin::~Plugin virtual Vamp::Plugin::~Plugin ( ) [inline, virtual]
    - + @@ -329,12 +348,12 @@

    Member Function Documentation

    - +
    Vamp::Plugin::Plugin Vamp::Plugin::Plugin ( float  inputSampleRate)
    - + @@ -370,12 +389,12 @@ - +
    virtual bool Vamp::Plugin::initialise virtual bool Vamp::Plugin::initialise ( size_t  inputChannels,
    - + @@ -391,12 +410,12 @@ - +
    virtual void Vamp::Plugin::reset virtual void Vamp::Plugin::reset ( ) [pure virtual]
    - + @@ -407,7 +426,7 @@

    Get the plugin's required input domain.

    If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin.

    -

    If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). 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.

    +

    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 process(). 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.

    Implemented in Vamp::HostExt::PluginInputDomainAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, PowerSpectrum, AmplitudeFollower, SpectralCentroid, ZeroCrossing, FixedTempoEstimator, and PercussionOnsetDetector.

    @@ -415,12 +434,12 @@ - +
    virtual InputDomain Vamp::Plugin::getInputDomain virtual InputDomain Vamp::Plugin::getInputDomain ( ) const [pure virtual]
    - + @@ -441,12 +460,12 @@ - +
    virtual size_t Vamp::Plugin::getPreferredBlockSize virtual size_t Vamp::Plugin::getPreferredBlockSize ( ) const [inline, virtual]
    - + @@ -467,12 +486,12 @@ - +
    virtual size_t Vamp::Plugin::getPreferredStepSize virtual size_t Vamp::Plugin::getPreferredStepSize ( ) const [inline, virtual]
    - + @@ -491,12 +510,12 @@ - +
    virtual size_t Vamp::Plugin::getMinChannelCount virtual size_t Vamp::Plugin::getMinChannelCount ( ) const [inline, virtual]
    - + @@ -515,12 +534,12 @@ - +
    virtual size_t Vamp::Plugin::getMaxChannelCount virtual size_t Vamp::Plugin::getMaxChannelCount ( ) const [inline, virtual]
    - + @@ -538,12 +557,12 @@ - +
    virtual OutputList Vamp::Plugin::getOutputDescriptors virtual OutputList Vamp::Plugin::getOutputDescriptors ( ) const [pure virtual]
    - + @@ -565,7 +584,7 @@

    Process a single block of input data.

    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.

    -

    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).

    +

    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).

    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.)

    Implemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::HostExt::PluginChannelAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginInputDomainAdapter, Vamp::HostExt::PluginSummarisingAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, PercussionOnsetDetector, AmplitudeFollower, PowerSpectrum, SpectralCentroid, and ZeroCrossing.

    @@ -574,12 +593,12 @@ - +
    virtual FeatureSet Vamp::Plugin::process virtual FeatureSet Vamp::Plugin::process ( const float *const *  inputBuffers,
    - + @@ -596,12 +615,12 @@ - +
    virtual FeatureSet Vamp::Plugin::getRemainingFeatures virtual FeatureSet Vamp::Plugin::getRemainingFeatures ( ) [pure virtual]
    - + @@ -619,12 +638,12 @@ - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual]
    - + @@ -637,18 +656,18 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 72 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 68 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual unsigned int Vamp::PluginBase::getVampApiVersion virtual unsigned int Vamp::PluginBase::getVampApiVersion ( ) const [inline, virtual, inherited]
    - + @@ -668,12 +687,12 @@ - +
    virtual std::string Vamp::PluginBase::getIdentifier virtual std::string Vamp::PluginBase::getIdentifier ( ) const [pure virtual, inherited]
    - + @@ -692,12 +711,12 @@ - +
    virtual std::string Vamp::PluginBase::getName virtual std::string Vamp::PluginBase::getName ( ) const [pure virtual, inherited]
    - + @@ -716,12 +735,12 @@ - +
    virtual std::string Vamp::PluginBase::getDescription virtual std::string Vamp::PluginBase::getDescription ( ) const [pure virtual, inherited]
    - + @@ -739,12 +758,12 @@ - +
    virtual std::string Vamp::PluginBase::getMaker virtual std::string Vamp::PluginBase::getMaker ( ) const [pure virtual, inherited]
    - + @@ -762,12 +781,12 @@ - +
    virtual std::string Vamp::PluginBase::getCopyright virtual std::string Vamp::PluginBase::getCopyright ( ) const [pure virtual, inherited]
    - + @@ -784,12 +803,12 @@ - +
    virtual int Vamp::PluginBase::getPluginVersion virtual int Vamp::PluginBase::getPluginVersion ( ) const [pure virtual, inherited]
    - + @@ -802,18 +821,18 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 208 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 204 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual ParameterList Vamp::PluginBase::getParameterDescriptors virtual ParameterList Vamp::PluginBase::getParameterDescriptors ( ) const [inline, virtual, inherited]
    - + @@ -828,16 +847,16 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 216 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 212 of file vamp-sdk/PluginBase.h.

    - +
    virtual float Vamp::PluginBase::getParameter virtual float Vamp::PluginBase::getParameter ( std::string  )
    - + @@ -862,16 +881,16 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 222 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 218 of file vamp-sdk/PluginBase.h.

    - +
    virtual void Vamp::PluginBase::setParameter virtual void Vamp::PluginBase::setParameter ( std::string  ,
    - + @@ -886,16 +905,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 237 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 233 of file vamp-sdk/PluginBase.h.

    - +
    virtual ProgramList Vamp::PluginBase::getPrograms virtual ProgramList Vamp::PluginBase::getPrograms ( ) const [inline, virtual, inherited]
    - + @@ -908,16 +927,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 242 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 238 of file vamp-sdk/PluginBase.h.

    - +
    virtual std::string Vamp::PluginBase::getCurrentProgram virtual std::string Vamp::PluginBase::getCurrentProgram ( ) const [inline, virtual, inherited]
    - + @@ -932,12 +951,12 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 248 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 244 of file vamp-sdk/PluginBase.h.

    Member Data Documentation

    - +
    virtual void Vamp::PluginBase::selectProgram virtual void Vamp::PluginBase::selectProgram ( std::string  )
    @@ -957,16 +976,16 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1Plugin.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1Plugin.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,36 @@ +var classVamp_1_1Plugin = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "~Plugin", "classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b", null ], + [ "Plugin", "classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9", null ], + [ "initialise", "classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822", null ], + [ "reset", "classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f", null ], + [ "getInputDomain", "classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6", null ], + [ "getPreferredBlockSize", "classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac", null ], + [ "getPreferredStepSize", "classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567", null ], + [ "getMinChannelCount", "classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525", null ], + [ "getMaxChannelCount", "classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e", null ], + [ "getOutputDescriptors", "classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35", null ], + [ "process", "classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996", null ], + [ "getRemainingFeatures", "classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "getVampApiVersion", "classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf", null ], + [ "getIdentifier", "classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a", null ], + [ "getName", "classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232", null ], + [ "getDescription", "classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a", null ], + [ "getMaker", "classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637", null ], + [ "getCopyright", "classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661", null ], + [ "getPluginVersion", "classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151", null ], + [ "getParameterDescriptors", "classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21", null ], + [ "getParameter", "classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7", null ], + [ "setParameter", "classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366", null ], + [ "getPrograms", "classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af", null ], + [ "getCurrentProgram", "classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3", null ], + [ "selectProgram", "classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginAdapter-members.html --- a/code-docs/classVamp_1_1PluginAdapter-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginAdapter-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::PluginAdapter< P >, including all inherited members. @@ -84,14 +85,14 @@ -
    createPlugin(float inputSampleRate)Vamp::PluginAdapter< P > [inline, protected, virtual]
    PluginAdapterBase()Vamp::PluginAdapterBase [protected]
    ~PluginAdapter()Vamp::PluginAdapter< P > [inline, virtual]
    ~PluginAdapterBase()Vamp::PluginAdapterBase [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginAdapter.html --- a/code-docs/classVamp_1_1PluginAdapter.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginAdapter.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::PluginAdapter< P > Class Template Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::PluginAdapter< P > Class Template Reference
    - +
    - +

    PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementation. More...

    @@ -97,16 +98,16 @@ - - - - + + + + - + - +

    Public Member Functions

     PluginAdapter ()
    virtual ~PluginAdapter ()
    const VampPluginDescriptor * getDescriptor ()
     Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.
     PluginAdapter ()
    virtual ~PluginAdapter ()
    const VampPluginDescriptor * getDescriptor ()
     Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.

    Protected Member Functions

    Plugin * createPlugin (float inputSampleRate)
    Plugin * createPlugin (float inputSampleRate)

    Protected Attributes

    Impl * m_impl
    Impl * m_impl

    Detailed Description

    template<typename P>
    @@ -117,7 +118,7 @@

    Definition at line 95 of file PluginAdapter.h.

    Constructor & Destructor Documentation

    - +
    @@ -137,7 +138,7 @@
    - +
    @@ -158,14 +159,14 @@

    Member Function Documentation

    - +
    template<typename P>
    - + @@ -181,12 +182,12 @@ - +
    Plugin* Vamp::PluginAdapter< P >::createPlugin Plugin* Vamp::PluginAdapter< P >::createPlugin ( float  inputSampleRate)
    - + @@ -202,7 +203,7 @@

    Member Data Documentation

    - +
    const VampPluginDescriptor* Vamp::PluginAdapterBase::getDescriptor const VampPluginDescriptor* Vamp::PluginAdapterBase::getDescriptor ( ) [inherited]
    @@ -220,16 +221,16 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginAdapter.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1PluginAdapter.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,8 @@ +var classVamp_1_1PluginAdapter = +[ + [ "PluginAdapter", "classVamp_1_1PluginAdapter.html#a16312efd629b7063d7b6d67889a2c15a", null ], + [ "~PluginAdapter", "classVamp_1_1PluginAdapter.html#a9612c9df7d4844959a36921d43d4bd50", null ], + [ "createPlugin", "classVamp_1_1PluginAdapter.html#a3f387e7e37409e00d32477903b5b13d3", null ], + [ "getDescriptor", "classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb", null ], + [ "m_impl", "classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginAdapterBase-members.html --- a/code-docs/classVamp_1_1PluginAdapterBase-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginAdapterBase-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::PluginAdapterBase, including all inherited members. @@ -82,14 +83,14 @@ -
    createPlugin(float inputSampleRate)=0Vamp::PluginAdapterBase [protected, pure virtual]
    m_implVamp::PluginAdapterBase [protected]
    PluginAdapterBase()Vamp::PluginAdapterBase [protected]
    ~PluginAdapterBase()Vamp::PluginAdapterBase [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginAdapterBase.html --- a/code-docs/classVamp_1_1PluginAdapterBase.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginAdapterBase.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::PluginAdapterBase Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@
    - +
    Vamp::PluginAdapterBase Class Reference
    -
    +
    - +

    PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its C++ Vamp::Plugin objects available through the Vamp C API. More...

    @@ -97,30 +98,30 @@ - - - + + + - - + + - +

    Public Member Functions

    virtual ~PluginAdapterBase ()
    const VampPluginDescriptor * getDescriptor ()
     Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.
    virtual ~PluginAdapterBase ()
    const VampPluginDescriptor * getDescriptor ()
     Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.

    Protected Member Functions

     PluginAdapterBase ()
    virtual Plugin * createPlugin (float inputSampleRate)=0
     PluginAdapterBase ()
    virtual Plugin * createPlugin (float inputSampleRate)=0

    Protected Attributes

    Impl * m_impl
    Impl * m_impl

    Detailed Description

    PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its C++ Vamp::Plugin objects available through the Vamp C API.

    Almost all Vamp plugin libraries will want to make use of this. To do so, all they need to do is declare a PluginAdapter<T> for each plugin class T in their library. It's very simple, and you need to know absolutely nothing about how it works in order to use it. Just cut and paste from an existing plugin's discovery function.

    -
    See also:
    vampGetPluginDescriptor
    +
    See also:
    vampGetPluginDescriptor

    Definition at line 65 of file PluginAdapter.h.

    Constructor & Destructor Documentation

    - +
    - + @@ -131,12 +132,12 @@ - +
    virtual Vamp::PluginAdapterBase::~PluginAdapterBase virtual Vamp::PluginAdapterBase::~PluginAdapterBase ( ) [virtual]
    - + @@ -148,12 +149,12 @@

    Member Function Documentation

    - +
    Vamp::PluginAdapterBase::PluginAdapterBase Vamp::PluginAdapterBase::PluginAdapterBase ( ) [protected]
    - + @@ -168,12 +169,12 @@ - +
    const VampPluginDescriptor* Vamp::PluginAdapterBase::getDescriptor const VampPluginDescriptor* Vamp::PluginAdapterBase::getDescriptor ( )
    - + @@ -188,7 +189,7 @@

    Member Data Documentation

    - +
    virtual Plugin* Vamp::PluginAdapterBase::createPlugin virtual Plugin* Vamp::PluginAdapterBase::createPlugin ( float  inputSampleRate)
    @@ -206,16 +207,16 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginAdapterBase.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1PluginAdapterBase.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,8 @@ +var classVamp_1_1PluginAdapterBase = +[ + [ "~PluginAdapterBase", "classVamp_1_1PluginAdapterBase.html#aaa8afd318b6c3da108e1cbcc7e46603d", null ], + [ "PluginAdapterBase", "classVamp_1_1PluginAdapterBase.html#a5dad6a9b4b170c0f284962e125ac988e", null ], + [ "getDescriptor", "classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb", null ], + [ "createPlugin", "classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b", null ], + [ "m_impl", "classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginAdapterBase__inherit__graph.png Binary file code-docs/classVamp_1_1PluginAdapterBase__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginAdapter__inherit__graph.png Binary file code-docs/classVamp_1_1PluginAdapter__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginBase-members.html --- a/code-docs/classVamp_1_1PluginBase-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginBase-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::PluginBase, including all inherited members. @@ -94,14 +95,14 @@ -
    getCopyright() const =0Vamp::PluginBase [pure virtual]
    selectProgram(std::string)Vamp::PluginBase [inline, virtual]
    setParameter(std::string, float)Vamp::PluginBase [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginBase.html --- a/code-docs/classVamp_1_1PluginBase.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginBase.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::PluginBase Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::PluginBase Class Reference
    - +
    - +

    A base class for plugins with optional configurable parameters, programs, etc. More...

    @@ -97,52 +98,52 @@ - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Classes

    struct  ParameterDescriptor
    struct  ParameterDescriptor

    Public Types

    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

    virtual ~PluginBase ()
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual std::string getIdentifier () const =0
     Get the computer-usable name of the plugin.
    virtual std::string getName () const =0
     Get a human-readable name or title of the plugin.
    virtual std::string getDescription () const =0
     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".
    virtual std::string getMaker () const =0
     Get the name of the author or vendor of the plugin in human-readable form.
    virtual std::string getCopyright () const =0
     Get the copyright statement or licensing summary for the plugin.
    virtual int getPluginVersion () const =0
     Get the version number of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.
    virtual std::string getType () const =0
     Get the type of plugin.
    virtual ~PluginBase ()
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual std::string getIdentifier () const =0
     Get the computer-usable name of the plugin.
    virtual std::string getName () const =0
     Get a human-readable name or title of the plugin.
    virtual std::string getDescription () const =0
     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".
    virtual std::string getMaker () const =0
     Get the name of the author or vendor of the plugin in human-readable form.
    virtual std::string getCopyright () const =0
     Get the copyright statement or licensing summary for the plugin.
    virtual int getPluginVersion () const =0
     Get the version number of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.
    virtual std::string getType () const =0
     Get the type of plugin.

    Detailed Description

    A base class for plugins with optional configurable parameters, programs, etc.

    The Vamp::Plugin is derived from this, and individual Vamp plugins should derive from that.

    This class does not provide the necessary interfaces to instantiate or run a plugin. It only specifies an interface for retrieving those controls that the host may wish to show to the user for editing. It could meaningfully be subclassed by real-time plugins or other sorts of plugin as well as Vamp plugins.

    -

    Definition at line 64 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 60 of file vamp-sdk/PluginBase.h.

    Member Typedef Documentation

    - +
    @@ -153,11 +154,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -168,17 +169,17 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Constructor & Destructor Documentation

    - +
    - + @@ -187,17 +188,17 @@
    -

    Definition at line 67 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 63 of file vamp-sdk/PluginBase.h.

    Member Function Documentation

    - +
    virtual Vamp::PluginBase::~PluginBase virtual Vamp::PluginBase::~PluginBase ( ) [inline, virtual]
    - + @@ -210,18 +211,18 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 72 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 68 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual unsigned int Vamp::PluginBase::getVampApiVersion virtual unsigned int Vamp::PluginBase::getVampApiVersion ( ) const [inline, virtual]
    - + @@ -241,12 +242,12 @@ - +
    virtual std::string Vamp::PluginBase::getIdentifier virtual std::string Vamp::PluginBase::getIdentifier ( ) const [pure virtual]
    - + @@ -265,12 +266,12 @@ - +
    virtual std::string Vamp::PluginBase::getName virtual std::string Vamp::PluginBase::getName ( ) const [pure virtual]
    - + @@ -289,12 +290,12 @@ - +
    virtual std::string Vamp::PluginBase::getDescription virtual std::string Vamp::PluginBase::getDescription ( ) const [pure virtual]
    - + @@ -312,12 +313,12 @@ - +
    virtual std::string Vamp::PluginBase::getMaker virtual std::string Vamp::PluginBase::getMaker ( ) const [pure virtual]
    - + @@ -335,12 +336,12 @@ - +
    virtual std::string Vamp::PluginBase::getCopyright virtual std::string Vamp::PluginBase::getCopyright ( ) const [pure virtual]
    - + @@ -357,12 +358,12 @@ - +
    virtual int Vamp::PluginBase::getPluginVersion virtual int Vamp::PluginBase::getPluginVersion ( ) const [pure virtual]
    - + @@ -375,18 +376,18 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 208 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 204 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual ParameterList Vamp::PluginBase::getParameterDescriptors virtual ParameterList Vamp::PluginBase::getParameterDescriptors ( ) const [inline, virtual]
    - + @@ -401,16 +402,16 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 216 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 212 of file vamp-sdk/PluginBase.h.

    - +
    virtual float Vamp::PluginBase::getParameter virtual float Vamp::PluginBase::getParameter ( std::string  )
    - + @@ -435,16 +436,16 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 222 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 218 of file vamp-sdk/PluginBase.h.

    - +
    virtual void Vamp::PluginBase::setParameter virtual void Vamp::PluginBase::setParameter ( std::string  ,
    - + @@ -459,16 +460,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 237 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 233 of file vamp-sdk/PluginBase.h.

    - +
    virtual ProgramList Vamp::PluginBase::getPrograms virtual ProgramList Vamp::PluginBase::getPrograms ( ) const [inline, virtual]
    - + @@ -481,16 +482,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 242 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 238 of file vamp-sdk/PluginBase.h.

    - +
    virtual std::string Vamp::PluginBase::getCurrentProgram virtual std::string Vamp::PluginBase::getCurrentProgram ( ) const [inline, virtual]
    - + @@ -505,16 +506,16 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 248 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 244 of file vamp-sdk/PluginBase.h.

    - +
    virtual void Vamp::PluginBase::selectProgram virtual void Vamp::PluginBase::selectProgram ( std::string  )
    - + @@ -533,16 +534,16 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginBase.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1PluginBase.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,20 @@ +var classVamp_1_1PluginBase = +[ + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "~PluginBase", "classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5", null ], + [ "getVampApiVersion", "classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf", null ], + [ "getIdentifier", "classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a", null ], + [ "getName", "classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232", null ], + [ "getDescription", "classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a", null ], + [ "getMaker", "classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637", null ], + [ "getCopyright", "classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661", null ], + [ "getPluginVersion", "classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151", null ], + [ "getParameterDescriptors", "classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21", null ], + [ "getParameter", "classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7", null ], + [ "setParameter", "classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366", null ], + [ "getPrograms", "classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af", null ], + [ "getCurrentProgram", "classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3", null ], + [ "selectProgram", "classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353", null ], + [ "getType", "classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginBase__inherit__graph.png Binary file code-docs/classVamp_1_1PluginBase__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginHostAdapter-members.html --- a/code-docs/classVamp_1_1PluginHostAdapter-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginHostAdapter-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    virtual std::string Vamp::PluginBase::getType virtual std::string Vamp::PluginBase::getType ( ) const [pure virtual]
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::PluginHostAdapter, including all inherited members. @@ -119,14 +120,14 @@ -
    convertFeatures(VampFeatureList *, FeatureSet &)Vamp::PluginHostAdapter [protected]
    ~Plugin()Vamp::Plugin [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~PluginHostAdapter()Vamp::PluginHostAdapter [virtual]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginHostAdapter.html --- a/code-docs/classVamp_1_1PluginHostAdapter.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginHostAdapter.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp::PluginHostAdapter Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Vamp::PluginHostAdapter Class Reference
    - +
    - +

    PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescriptor object appear as a C++ Vamp::Plugin object. More...

    @@ -99,80 +100,80 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - - - + + +

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     PluginHostAdapter (const VampPluginDescriptor *descriptor, float inputSampleRate)
    virtual ~PluginHostAdapter ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
     PluginHostAdapter (const VampPluginDescriptor *descriptor, float inputSampleRate)
    virtual ~PluginHostAdapter ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    float getParameter (std::string) const
     Get the value of a named parameter.
    void setParameter (std::string, float)
     Set a named parameter.
    ProgramList getPrograms () const
     Get the program settings available in this plugin.
    std::string getCurrentProgram () const
     Get the current program.
    void selectProgram (std::string)
     Select a program.
    size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.

    Static Public Member Functions

    static std::vector< std::string > getPluginPath ()
    static std::vector< std::string > getPluginPath ()

    Protected Member Functions

    void convertFeatures (VampFeatureList *, FeatureSet &)
    void convertFeatures (VampFeatureList *, FeatureSet &)

    Protected Attributes

    const VampPluginDescriptor * m_descriptor
    VampPluginHandle m_handle
    float m_inputSampleRate
    const VampPluginDescriptor * m_descriptor
    VampPluginHandle m_handle
    float m_inputSampleRate

    Detailed Description

    PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescriptor object appear as a C++ Vamp::Plugin object.

    @@ -181,7 +182,7 @@

    Definition at line 68 of file PluginHostAdapter.h.

    Member Typedef Documentation

    - +
    @@ -196,7 +197,7 @@ - +
    @@ -211,7 +212,7 @@ - +
    @@ -226,7 +227,7 @@ - +
    @@ -237,11 +238,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -252,12 +253,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -268,9 +269,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -281,12 +282,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -308,12 +309,12 @@ - +
    Vamp::PluginHostAdapter::PluginHostAdapter Vamp::PluginHostAdapter::PluginHostAdapter ( const VampPluginDescriptor *  descriptor,
    - + @@ -325,12 +326,12 @@

    Member Function Documentation

    - +
    virtual Vamp::PluginHostAdapter::~PluginHostAdapter virtual Vamp::PluginHostAdapter::~PluginHostAdapter ( ) [virtual]
    - + @@ -341,12 +342,12 @@ - +
    static std::vector<std::string> Vamp::PluginHostAdapter::getPluginPath static std::vector<std::string> Vamp::PluginHostAdapter::getPluginPath ( ) [static]
    - + @@ -380,12 +381,12 @@ - +
    bool Vamp::PluginHostAdapter::initialise bool Vamp::PluginHostAdapter::initialise ( size_t  inputChannels,
    - + @@ -401,12 +402,12 @@ - +
    void Vamp::PluginHostAdapter::reset void Vamp::PluginHostAdapter::reset ( ) [virtual]
    - + @@ -417,18 +418,18 @@

    Get the plugin's required input domain.

    If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin.

    -

    If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). 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.

    +

    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 process(). 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.

    Implements Vamp::Plugin.

    - +
    InputDomain Vamp::PluginHostAdapter::getInputDomain InputDomain Vamp::PluginHostAdapter::getInputDomain ( ) const [virtual]
    - + @@ -443,12 +444,12 @@ - +
    unsigned int Vamp::PluginHostAdapter::getVampApiVersion unsigned int Vamp::PluginHostAdapter::getVampApiVersion ( ) const [virtual]
    - + @@ -466,12 +467,12 @@ - +
    std::string Vamp::PluginHostAdapter::getIdentifier std::string Vamp::PluginHostAdapter::getIdentifier ( ) const [virtual]
    - + @@ -488,12 +489,12 @@ - +
    std::string Vamp::PluginHostAdapter::getName std::string Vamp::PluginHostAdapter::getName ( ) const [virtual]
    - + @@ -510,12 +511,12 @@ - +
    std::string Vamp::PluginHostAdapter::getDescription std::string Vamp::PluginHostAdapter::getDescription ( ) const [virtual]
    - + @@ -531,12 +532,12 @@ - +
    std::string Vamp::PluginHostAdapter::getMaker std::string Vamp::PluginHostAdapter::getMaker ( ) const [virtual]
    - + @@ -551,12 +552,12 @@ - +
    int Vamp::PluginHostAdapter::getPluginVersion int Vamp::PluginHostAdapter::getPluginVersion ( ) const [virtual]
    - + @@ -572,12 +573,12 @@ - +
    std::string Vamp::PluginHostAdapter::getCopyright std::string Vamp::PluginHostAdapter::getCopyright ( ) const [virtual]
    - + @@ -592,12 +593,12 @@ - +
    ParameterList Vamp::PluginHostAdapter::getParameterDescriptors ParameterList Vamp::PluginHostAdapter::getParameterDescriptors ( ) const [virtual]
    - + @@ -614,12 +615,12 @@ - +
    float Vamp::PluginHostAdapter::getParameter float Vamp::PluginHostAdapter::getParameter ( std::string  )
    - + @@ -646,12 +647,12 @@ - +
    void Vamp::PluginHostAdapter::setParameter void Vamp::PluginHostAdapter::setParameter ( std::string  ,
    - + @@ -668,12 +669,12 @@ - +
    ProgramList Vamp::PluginHostAdapter::getPrograms ProgramList Vamp::PluginHostAdapter::getPrograms ( ) const [virtual]
    - + @@ -688,12 +689,12 @@ - +
    std::string Vamp::PluginHostAdapter::getCurrentProgram std::string Vamp::PluginHostAdapter::getCurrentProgram ( ) const [virtual]
    - + @@ -710,12 +711,12 @@ - +
    void Vamp::PluginHostAdapter::selectProgram void Vamp::PluginHostAdapter::selectProgram ( std::string  )
    - + @@ -732,12 +733,12 @@ - +
    size_t Vamp::PluginHostAdapter::getPreferredStepSize size_t Vamp::PluginHostAdapter::getPreferredStepSize ( ) const [virtual]
    - + @@ -754,12 +755,12 @@ - +
    size_t Vamp::PluginHostAdapter::getPreferredBlockSize size_t Vamp::PluginHostAdapter::getPreferredBlockSize ( ) const [virtual]
    - + @@ -774,12 +775,12 @@ - +
    size_t Vamp::PluginHostAdapter::getMinChannelCount size_t Vamp::PluginHostAdapter::getMinChannelCount ( ) const [virtual]
    - + @@ -794,12 +795,12 @@ - +
    size_t Vamp::PluginHostAdapter::getMaxChannelCount size_t Vamp::PluginHostAdapter::getMaxChannelCount ( ) const [virtual]
    - + @@ -815,12 +816,12 @@ - +
    OutputList Vamp::PluginHostAdapter::getOutputDescriptors OutputList Vamp::PluginHostAdapter::getOutputDescriptors ( ) const [virtual]
    - + @@ -842,19 +843,19 @@

    Process a single block of input data.

    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.

    -

    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).

    +

    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).

    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.)

    Implements Vamp::Plugin.

    - +
    FeatureSet Vamp::PluginHostAdapter::process FeatureSet Vamp::PluginHostAdapter::process ( const float *const *  inputBuffers,
    - + @@ -869,12 +870,12 @@ - +
    FeatureSet Vamp::PluginHostAdapter::getRemainingFeatures FeatureSet Vamp::PluginHostAdapter::getRemainingFeatures ( ) [virtual]
    - + @@ -896,12 +897,12 @@ - +
    void Vamp::PluginHostAdapter::convertFeatures void Vamp::PluginHostAdapter::convertFeatures ( VampFeatureList *  ,
    - + @@ -920,7 +921,7 @@

    Member Data Documentation

    - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    @@ -935,7 +936,7 @@ - +
    @@ -950,7 +951,7 @@ - +
    @@ -970,16 +971,16 @@
    The documentation for this class was generated from the following file: - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginHostAdapter.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classVamp_1_1PluginHostAdapter.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,40 @@ +var classVamp_1_1PluginHostAdapter = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "PluginHostAdapter", "classVamp_1_1PluginHostAdapter.html#a6535abd551acfbbaab381bbe1268cd49", null ], + [ "~PluginHostAdapter", "classVamp_1_1PluginHostAdapter.html#aed66c091340aa668d3be89c4b4c24474", null ], + [ "getPluginPath", "classVamp_1_1PluginHostAdapter.html#a09cbfb7903d28f10d6d556c6cb81c5f6", null ], + [ "initialise", "classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738", null ], + [ "reset", "classVamp_1_1PluginHostAdapter.html#a5d54c5bbd76bc27b7a243827148afeaa", null ], + [ "getInputDomain", "classVamp_1_1PluginHostAdapter.html#a8e9d25673367c741631a60cbb36e91d2", null ], + [ "getVampApiVersion", "classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e", null ], + [ "getIdentifier", "classVamp_1_1PluginHostAdapter.html#ab27423a656f878d97d2ad2eba4e76c7a", null ], + [ "getName", "classVamp_1_1PluginHostAdapter.html#a45f1d0377e233eeddd1b7cefb48be62a", null ], + [ "getDescription", "classVamp_1_1PluginHostAdapter.html#a5eaafcef030e81b90a3e77cf16cf8ae1", null ], + [ "getMaker", "classVamp_1_1PluginHostAdapter.html#af572be0b175f5661559006a380a0f3db", null ], + [ "getPluginVersion", "classVamp_1_1PluginHostAdapter.html#a6fbd94781867ca46a20368c2a3593c77", null ], + [ "getCopyright", "classVamp_1_1PluginHostAdapter.html#ac73c9d6baad04369beee695e99584815", null ], + [ "getParameterDescriptors", "classVamp_1_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76", null ], + [ "getParameter", "classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb", null ], + [ "setParameter", "classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6", null ], + [ "getPrograms", "classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc", null ], + [ "getCurrentProgram", "classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867", null ], + [ "selectProgram", "classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683", null ], + [ "getPreferredStepSize", "classVamp_1_1PluginHostAdapter.html#a859ad5d59402691daed3cf1af1899ebe", null ], + [ "getPreferredBlockSize", "classVamp_1_1PluginHostAdapter.html#ad5e0ea8042bdec4dd18428991117e07a", null ], + [ "getMinChannelCount", "classVamp_1_1PluginHostAdapter.html#a67d1198c0e58d3f0076d0eda599ff28d", null ], + [ "getMaxChannelCount", "classVamp_1_1PluginHostAdapter.html#a25091905e97e39d515d8ffc1a9f2b9e0", null ], + [ "getOutputDescriptors", "classVamp_1_1PluginHostAdapter.html#a9649a113da0252fe8bd9fc731b047ae0", null ], + [ "process", "classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd", null ], + [ "getRemainingFeatures", "classVamp_1_1PluginHostAdapter.html#a984a4c11f3fbdcfd90e4837b1619a5ab", null ], + [ "convertFeatures", "classVamp_1_1PluginHostAdapter.html#aee417a4c9ba9dbb63777c963d5f9452a", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "m_descriptor", "classVamp_1_1PluginHostAdapter.html#a0c9f252aca8ac298e30cadd0de032ec2", null ], + [ "m_handle", "classVamp_1_1PluginHostAdapter.html#a02ebd03b226b4a467cad747ce77e79ee", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1PluginHostAdapter__inherit__graph.png Binary file code-docs/classVamp_1_1PluginHostAdapter__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1Plugin__inherit__graph.png Binary file code-docs/classVamp_1_1Plugin__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classVamp_1_1RealTime-members.html --- a/code-docs/classVamp_1_1RealTime-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1RealTime-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Member List @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    This is the complete list of members for Vamp::RealTime, including all inherited members. @@ -104,14 +105,14 @@ -
    frame2RealTime(long frame, unsigned int sampleRate)Vamp::RealTime [static]
    toText(bool fixedDp=false) const Vamp::RealTime
    usec() const Vamp::RealTime [inline]
    zeroTimeVamp::RealTime [static]
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classZeroCrossing-members.html --- a/code-docs/classZeroCrossing-members.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classZeroCrossing-members.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Member List @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    This is the complete list of members for ZeroCrossing, including all inherited members. @@ -117,14 +118,14 @@ -
    FeatureList typedefVamp::Plugin
    ~Plugin()Vamp::Plugin [inline, virtual]
    ~PluginBase()Vamp::PluginBase [inline, virtual]
    ~ZeroCrossing()ZeroCrossing [virtual]
    + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classZeroCrossing.html --- a/code-docs/classZeroCrossing.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classZeroCrossing.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: ZeroCrossing Class Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    ZeroCrossing Class Reference
    - +
    - +

    Example plugin that calculates the positions and density of zero-crossing points in an audio waveform. More...

    @@ -97,81 +98,81 @@ - - - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + +

    Public Types

    enum  InputDomain { TimeDomain, +
    enum  InputDomain { TimeDomain, FrequencyDomain }
    typedef std::vector
    +
    typedef std::vector
    < OutputDescriptor >     		OutputList
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    +
    typedef std::vector< Feature > FeatureList
    typedef std::map< int,
    FeatureList >     		FeatureSet
    typedef std::vector
    +
    typedef std::vector
    < ParameterDescriptor >     		ParameterList
    typedef std::vector< std::string > ProgramList
    typedef std::vector< std::string > ProgramList

    Public Member Functions

     ZeroCrossing (float inputSampleRate)
    virtual ~ZeroCrossing ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    virtual size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.
     ZeroCrossing (float inputSampleRate)
    virtual ~ZeroCrossing ()
    bool initialise (size_t channels, size_t stepSize, size_t blockSize)
     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).
    void reset ()
     Reset the plugin after use, to prepare it for another clean run.
    InputDomain getInputDomain () const
     Get the plugin's required input domain.
    std::string getIdentifier () const
     Get the computer-usable name of the plugin.
    std::string getName () const
     Get a human-readable name or title of the plugin.
    std::string getDescription () const
     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".
    std::string getMaker () const
     Get the name of the author or vendor of the plugin in human-readable form.
    int getPluginVersion () const
     Get the version number of the plugin.
    std::string getCopyright () const
     Get the copyright statement or licensing summary for the plugin.
    OutputList getOutputDescriptors () const
     Get the outputs of this plugin.
    FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
     Process a single block of input data.
    FeatureSet getRemainingFeatures ()
     After all blocks have been processed, calculate and return any remaining features derived from the complete input.
    virtual size_t getPreferredBlockSize () const
     Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
    virtual size_t getPreferredStepSize () const
     Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.
    virtual size_t getMinChannelCount () const
     Get the minimum supported number of input channels.
    virtual size_t getMaxChannelCount () const
     Get the maximum supported number of input channels.
    virtual std::string getType () const
     Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
    virtual unsigned int getVampApiVersion () const
     Get the Vamp API compatibility level of the plugin.
    virtual ParameterList getParameterDescriptors () const
     Get the controllable parameters of this plugin.
    virtual float getParameter (std::string) const
     Get the value of a named parameter.
    virtual void setParameter (std::string, float)
     Set a named parameter.
    virtual ProgramList getPrograms () const
     Get the program settings available in this plugin.
    virtual std::string getCurrentProgram () const
     Get the current program.
    virtual void selectProgram (std::string)
     Select a program.

    Protected Attributes

    size_t m_stepSize
    float m_previousSample
    float m_inputSampleRate
    size_t m_stepSize
    float m_previousSample
    float m_inputSampleRate

    Detailed Description

    Example plugin that calculates the positions and density of zero-crossing points in an audio waveform.

    Definition at line 47 of file ZeroCrossing.h.

    Member Typedef Documentation

    - +
    @@ -186,7 +187,7 @@ - +
    @@ -201,7 +202,7 @@ - +
    @@ -216,7 +217,7 @@ - +
    @@ -227,11 +228,11 @@
    -

    Definition at line 203 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 199 of file vamp-sdk/PluginBase.h.

    - +
    @@ -242,12 +243,12 @@
    -

    Definition at line 225 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 221 of file vamp-sdk/PluginBase.h.

    Member Enumeration Documentation

    - +
    @@ -258,9 +259,9 @@
    Enumerator:
    - -
    TimeDomain  +
    TimeDomain 
    FrequencyDomain  +
    FrequencyDomain 
    @@ -271,12 +272,12 @@

    Constructor & Destructor Documentation

    - +
    - + @@ -290,12 +291,12 @@ - +
    ZeroCrossing::ZeroCrossing ZeroCrossing::ZeroCrossing ( float  inputSampleRate)
    - + @@ -309,12 +310,12 @@

    Member Function Documentation

    - +
    ZeroCrossing::~ZeroCrossing ZeroCrossing::~ZeroCrossing ( ) [virtual]
    - + @@ -352,12 +353,12 @@ - +
    bool ZeroCrossing::initialise bool ZeroCrossing::initialise ( size_t  inputChannels,
    - + @@ -377,12 +378,12 @@ - +
    void ZeroCrossing::reset void ZeroCrossing::reset ( ) [virtual]
    - + @@ -403,12 +404,12 @@ - +
    InputDomain ZeroCrossing::getInputDomain InputDomain ZeroCrossing::getInputDomain ( ) const [inline, virtual]
    - + @@ -428,12 +429,12 @@ - +
    string ZeroCrossing::getIdentifier string ZeroCrossing::getIdentifier ( ) const [virtual]
    - + @@ -452,12 +453,12 @@ - +
    string ZeroCrossing::getName string ZeroCrossing::getName ( ) const [virtual]
    - + @@ -476,12 +477,12 @@ - +
    string ZeroCrossing::getDescription string ZeroCrossing::getDescription ( ) const [virtual]
    - + @@ -499,12 +500,12 @@ - +
    string ZeroCrossing::getMaker string ZeroCrossing::getMaker ( ) const [virtual]
    - + @@ -521,12 +522,12 @@ - +
    int ZeroCrossing::getPluginVersion int ZeroCrossing::getPluginVersion ( ) const [virtual]
    - + @@ -544,12 +545,12 @@ - +
    string ZeroCrossing::getCopyright string ZeroCrossing::getCopyright ( ) const [virtual]
    - + @@ -569,12 +570,12 @@ - +
    ZeroCrossing::OutputList ZeroCrossing::getOutputDescriptors ZeroCrossing::OutputList ZeroCrossing::getOutputDescriptors ( ) const [virtual]
    - + @@ -607,12 +608,12 @@ - +
    ZeroCrossing::FeatureSet ZeroCrossing::process ZeroCrossing::FeatureSet ZeroCrossing::process ( const float *const *  inputBuffers,
    - + @@ -629,12 +630,12 @@ - +
    ZeroCrossing::FeatureSet ZeroCrossing::getRemainingFeatures ZeroCrossing::FeatureSet ZeroCrossing::getRemainingFeatures ( ) [virtual]
    - + @@ -655,12 +656,12 @@ - +
    virtual size_t Vamp::Plugin::getPreferredBlockSize virtual size_t Vamp::Plugin::getPreferredBlockSize ( ) const [inline, virtual, inherited]
    - + @@ -681,12 +682,12 @@ - +
    virtual size_t Vamp::Plugin::getPreferredStepSize virtual size_t Vamp::Plugin::getPreferredStepSize ( ) const [inline, virtual, inherited]
    - + @@ -705,12 +706,12 @@ - +
    virtual size_t Vamp::Plugin::getMinChannelCount virtual size_t Vamp::Plugin::getMinChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -729,12 +730,12 @@ - +
    virtual size_t Vamp::Plugin::getMaxChannelCount virtual size_t Vamp::Plugin::getMaxChannelCount ( ) const [inline, virtual, inherited]
    - + @@ -752,12 +753,12 @@ - +
    virtual std::string Vamp::Plugin::getType virtual std::string Vamp::Plugin::getType ( ) const [inline, virtual, inherited]
    - + @@ -770,18 +771,18 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 72 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 68 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual unsigned int Vamp::PluginBase::getVampApiVersion virtual unsigned int Vamp::PluginBase::getVampApiVersion ( ) const [inline, virtual, inherited]
    - + @@ -794,18 +795,18 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 208 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 204 of file vamp-sdk/PluginBase.h.

    Referenced by enumeratePlugins().

    - +
    virtual ParameterList Vamp::PluginBase::getParameterDescriptors virtual ParameterList Vamp::PluginBase::getParameterDescriptors ( ) const [inline, virtual, inherited]
    - + @@ -820,16 +821,16 @@

    Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 216 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 212 of file vamp-sdk/PluginBase.h.

    - +
    virtual float Vamp::PluginBase::getParameter virtual float Vamp::PluginBase::getParameter ( std::string  )
    - + @@ -854,16 +855,16 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.

    -

    Definition at line 222 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 218 of file vamp-sdk/PluginBase.h.

    - +
    virtual void Vamp::PluginBase::setParameter virtual void Vamp::PluginBase::setParameter ( std::string  ,
    - + @@ -878,16 +879,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 237 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 233 of file vamp-sdk/PluginBase.h.

    - +
    virtual ProgramList Vamp::PluginBase::getPrograms virtual ProgramList Vamp::PluginBase::getPrograms ( ) const [inline, virtual, inherited]
    - + @@ -900,16 +901,16 @@

    Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 242 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 238 of file vamp-sdk/PluginBase.h.

    - +
    virtual std::string Vamp::PluginBase::getCurrentProgram virtual std::string Vamp::PluginBase::getCurrentProgram ( ) const [inline, virtual, inherited]
    - + @@ -924,12 +925,12 @@

    Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

    -

    Definition at line 248 of file vamp-sdk/PluginBase.h.

    +

    Definition at line 244 of file vamp-sdk/PluginBase.h.

    Member Data Documentation

    - +
    virtual void Vamp::PluginBase::selectProgram virtual void Vamp::PluginBase::selectProgram ( std::string  )
    @@ -946,7 +947,7 @@ - +
    @@ -963,7 +964,7 @@ - +
    @@ -984,15 +985,15 @@
  • ZeroCrossing.h
  • ZeroCrossing.cpp
    • - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classZeroCrossing.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/classZeroCrossing.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,38 @@ +var classZeroCrossing = +[ + [ "OutputList", "classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9", null ], + [ "FeatureList", "classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1", null ], + [ "FeatureSet", "classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f", null ], + [ "ParameterList", "classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8", null ], + [ "ProgramList", "classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20", null ], + [ "InputDomain", "classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc", null ], + [ "ZeroCrossing", "classZeroCrossing.html#a9855153a54bdc9ba75cc1a705a149473", null ], + [ "~ZeroCrossing", "classZeroCrossing.html#af1de0da862e6e2443581e4e16044675b", null ], + [ "initialise", "classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc", null ], + [ "reset", "classZeroCrossing.html#a9ae6c4a31ea027dceb1e97ead807e228", null ], + [ "getInputDomain", "classZeroCrossing.html#aafe2ce6ebd353a14c40db7e8e60f4051", null ], + [ "getIdentifier", "classZeroCrossing.html#af2baf9e19fcdd11cfe97ace56d4f5c1a", null ], + [ "getName", "classZeroCrossing.html#afa96f7ce6e7d9f03768f48c6a9d88498", null ], + [ "getDescription", "classZeroCrossing.html#a710bb0b013157adaeef2a9e6867b4478", null ], + [ "getMaker", "classZeroCrossing.html#ac68561634a3c329a029c2fd3deaeae2a", null ], + [ "getPluginVersion", "classZeroCrossing.html#ad685f6c2f443f07a1634550c335571eb", null ], + [ "getCopyright", "classZeroCrossing.html#af9c41b92aa8ff8bddaebf75569ff789c", null ], + [ "getOutputDescriptors", "classZeroCrossing.html#ac9d590a6feb1fc9a37d7892aefe2b688", null ], + [ "process", "classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da", null ], + [ "getRemainingFeatures", "classZeroCrossing.html#a70996d1b7166e303903daf92a9a37ad8", null ], + [ "getPreferredBlockSize", "classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac", null ], + [ "getPreferredStepSize", "classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567", null ], + [ "getMinChannelCount", "classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525", null ], + [ "getMaxChannelCount", "classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e", null ], + [ "getType", "classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91", null ], + [ "getVampApiVersion", "classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf", null ], + [ "getParameterDescriptors", "classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21", null ], + [ "getParameter", "classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7", null ], + [ "setParameter", "classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366", null ], + [ "getPrograms", "classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af", null ], + [ "getCurrentProgram", "classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3", null ], + [ "selectProgram", "classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353", null ], + [ "m_stepSize", "classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52", null ], + [ "m_previousSample", "classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8", null ], + [ "m_inputSampleRate", "classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classZeroCrossing__inherit__graph.png Binary file code-docs/classZeroCrossing__inherit__graph.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/classes.html --- a/code-docs/classes.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classes.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: Class Index @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    VampPluginSDK -  2.1 +  2.4
    - +
    A | D | F | O | P | R | S | Z | _
    - +
    @@ -93,27 +94,28 @@ - + + - - + + + - - + + +
      A  
    		PercussionOnsetDetector   
      S  
    PluginHostAdapter (Vamp)   
    Plugin::Feature (Vamp)   PluginInputDomainAdapter (Vamp::HostExt)   _VampFeature   
    FixedTempoEstimator   PluginLoader (Vamp::HostExt)   _VampFeatureList   
    FFT (Vamp)   PluginLoader (Vamp::HostExt)   _VampFeatureList   
    FixedTempoEstimator   PluginSummarisingAdapter (Vamp::HostExt)   _VampFeatureUnion   
      O  
    -    		PluginSummarisingAdapter (Vamp::HostExt)   _VampFeatureUnion   
    PluginWrapper (Vamp::HostExt)   _VampFeatureV2   
    Plugin::OutputDescriptor (Vamp)   PowerSpectrum   _VampOutputDescriptor   
    PluginWrapper (Vamp::HostExt)   _VampFeatureV2   
    PowerSpectrum   _VampOutputDescriptor   
    Plugin::OutputDescriptor (Vamp)   
      R  
    +    		_VampParameterDescriptor   
      P  
    -
      R  
    -    		_VampParameterDescriptor   
    _VampPluginDescriptor   
    PluginBase::ParameterDescriptor (Vamp)   RealTime (Vamp)   
    _VampPluginDescriptor   
    RealTime (Vamp)   
    PluginBase::ParameterDescriptor (Vamp)   
    A | D | F | O | P | R | S | Z | _
    -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_2d75386d541e768dd0382c2de0bcb161.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_2d75386d541e768dd0382c2de0bcb161.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,98 @@ + + + + +VampPluginSDK: src/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.3 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    src Directory Reference
    +
    +
    +
    +Directory dependency graph for src/:
    +
    +
    src/
    + + +
    + + + +

    +Files

    file  doc-overview [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_2d75386d541e768dd0382c2de0bcb161_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_2d75386d541e768dd0382c2de0bcb161_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_2d75386d541e768dd0382c2de0bcb161_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_2d75386d541e768dd0382c2de0bcb161_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +508f030d44297a1462e7e2fde9dd977c \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_2d75386d541e768dd0382c2de0bcb161_dep.png Binary file code-docs/dir_2d75386d541e768dd0382c2de0bcb161_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_35887283b966ca996e4ff77f459c38ce.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_35887283b966ca996e4ff77f459c38ce.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,110 @@ + + + + +VampPluginSDK: examples/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.3 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    examples Directory Reference
    +
    +
    +
    +Directory dependency graph for examples/:
    +
    +
    examples/
    + + +
    + + + + + + + + + + + + + + + +

    +Files

    file  AmplitudeFollower.cpp [code]
    file  AmplitudeFollower.h [code]
    file  FixedTempoEstimator.cpp [code]
    file  FixedTempoEstimator.h [code]
    file  PercussionOnsetDetector.cpp [code]
    file  PercussionOnsetDetector.h [code]
    file  plugins.cpp [code]
    file  PowerSpectrum.cpp [code]
    file  PowerSpectrum.h [code]
    file  SpectralCentroid.cpp [code]
    file  SpectralCentroid.h [code]
    file  ZeroCrossing.cpp [code]
    file  ZeroCrossing.h [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_35887283b966ca996e4ff77f459c38ce_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_35887283b966ca996e4ff77f459c38ce_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_35887283b966ca996e4ff77f459c38ce_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_35887283b966ca996e4ff77f459c38ce_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +df458a330b7fc67f5e9b56e4130d8e39 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_35887283b966ca996e4ff77f459c38ce_dep.png Binary file code-docs/dir_35887283b966ca996e4ff77f459c38ce_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4571ebff077265f6d30f5427df02fcd6.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_4571ebff077265f6d30f5427df02fcd6.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,109 @@ + + + + +VampPluginSDK: vamp-hostsdk/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.3 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    vamp-hostsdk Directory Reference
    +
    +
    +
    +Directory dependency graph for vamp-hostsdk/:
    +
    +
    vamp-hostsdk/
    + + +
    + + + + + + + + + + + + + + +

    +Files

    file  hostguard.h [code]
    file  vamp-hostsdk/Plugin.h [code]
    file  vamp-hostsdk/PluginBase.h [code]
    file  PluginBufferingAdapter.h [code]
    file  PluginChannelAdapter.h [code]
    file  PluginHostAdapter.h [code]
    file  PluginInputDomainAdapter.h [code]
    file  PluginLoader.h [code]
    file  PluginSummarisingAdapter.h [code]
    file  PluginWrapper.h [code]
    file  vamp-hostsdk/RealTime.h [code]
    file  vamp-hostsdk.h [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4571ebff077265f6d30f5427df02fcd6_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_4571ebff077265f6d30f5427df02fcd6_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4571ebff077265f6d30f5427df02fcd6_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_4571ebff077265f6d30f5427df02fcd6_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +c76c95c460dd63acdeebf850c51e7371 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4571ebff077265f6d30f5427df02fcd6_dep.png Binary file code-docs/dir_4571ebff077265f6d30f5427df02fcd6_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4f7e4242e27b8c8b476722507617a881.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_4f7e4242e27b8c8b476722507617a881.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,100 @@ + + + + + +VampPluginSDK: host/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.4 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    host Directory Reference
    +
    +
    +
    +Directory dependency graph for host/:
    +
    +
    host/
    + + +
    + + + + +

    +Files

    file  system.h [code]
    file  vamp-simple-host.cpp [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4f7e4242e27b8c8b476722507617a881.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_4f7e4242e27b8c8b476722507617a881.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,5 @@ +var dir_4f7e4242e27b8c8b476722507617a881 = +[ + [ "system.h", "system_8h.html", null ], + [ "vamp-simple-host.cpp", "vamp-simple-host_8cpp.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4f7e4242e27b8c8b476722507617a881_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_4f7e4242e27b8c8b476722507617a881_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4f7e4242e27b8c8b476722507617a881_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_4f7e4242e27b8c8b476722507617a881_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +dd9f8c36bed7f65011373d474af35ca7 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_4f7e4242e27b8c8b476722507617a881_dep.png Binary file code-docs/dir_4f7e4242e27b8c8b476722507617a881_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_5b77fce4b90561041d958141b45c7c55.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_5b77fce4b90561041d958141b45c7c55.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,103 @@ + + + + +VampPluginSDK: vamp-sdk/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.3 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    vamp-sdk Directory Reference
    +
    +
    +
    +Directory dependency graph for vamp-sdk/:
    +
    +
    vamp-sdk/
    + + +
    + + + + + + + + +

    +Files

    file  plugguard.h [code]
    file  vamp-sdk/Plugin.h [code]
    file  PluginAdapter.h [code]
    file  vamp-sdk/PluginBase.h [code]
    file  vamp-sdk/RealTime.h [code]
    file  vamp-sdk.h [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_5b77fce4b90561041d958141b45c7c55_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_5b77fce4b90561041d958141b45c7c55_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_5b77fce4b90561041d958141b45c7c55_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_5b77fce4b90561041d958141b45c7c55_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +a90a48fc58b0133c16bdddab892783d2 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_5b77fce4b90561041d958141b45c7c55_dep.png Binary file code-docs/dir_5b77fce4b90561041d958141b45c7c55_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,99 @@ + + + + + +VampPluginSDK: src/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.4 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    src Directory Reference
    +
    +
    +
    +Directory dependency graph for src/:
    +
    +
    src/
    + + +
    + + + +

    +Files

    file  doc-overview [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,4 @@ +var dir_68267d1309a1af8e8297ef4c3efbcdba = +[ + [ "doc-overview", "doc-overview.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +0359f9f3db80f8303b5c3d3ef459005d \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png Binary file code-docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,105 @@ + + + + + +VampPluginSDK: vamp-sdk/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.4 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    vamp-sdk Directory Reference
    +
    +
    +
    +Directory dependency graph for vamp-sdk/:
    +
    +
    vamp-sdk/
    + + +
    + + + + + + + + + +

    +Files

    file  FFT.h [code]
    file  plugguard.h [code]
    file  vamp-sdk/Plugin.h [code]
    file  PluginAdapter.h [code]
    file  vamp-sdk/PluginBase.h [code]
    file  vamp-sdk/RealTime.h [code]
    file  vamp-sdk.h [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,10 @@ +var dir_8661d6ced9d80e9e8c7982a58cd73404 = +[ + [ "FFT.h", "FFT_8h.html", null ], + [ "plugguard.h", "plugguard_8h.html", null ], + [ "vamp-sdk/Plugin.h", "vamp-sdk_2Plugin_8h.html", null ], + [ "PluginAdapter.h", "PluginAdapter_8h.html", null ], + [ "vamp-sdk/PluginBase.h", "vamp-sdk_2PluginBase_8h.html", null ], + [ "vamp-sdk/RealTime.h", "vamp-sdk_2RealTime_8h.html", null ], + [ "vamp-sdk.h", "vamp-sdk_8h.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +f3416788fff7ad7bdf976282b4463ba8 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404_dep.png Binary file code-docs/dir_8661d6ced9d80e9e8c7982a58cd73404_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,99 @@ + + + + + +VampPluginSDK: vamp/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.4 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    vamp Directory Reference
    +
    +
    +
    +Directory dependency graph for vamp/:
    +
    +
    vamp/
    + + +
    + + + +

    +Files

    file  vamp.h [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,4 @@ +var dir_9c751ccb9387a8f0ae6ae8f777da02a0 = +[ + [ "vamp.h", "vamp_8h.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +6cf79b2d9d1638155ff2a0d14c7fc408 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0_dep.png Binary file code-docs/dir_9c751ccb9387a8f0ae6ae8f777da02a0_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_b086eb10f854304ab96fb3af468374a7.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_b086eb10f854304ab96fb3af468374a7.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,98 @@ + + + + +VampPluginSDK: vamp/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.3 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    vamp Directory Reference
    +
    +
    +
    +Directory dependency graph for vamp/:
    +
    +
    vamp/
    + + +
    + + + +

    +Files

    file  vamp.h [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_b086eb10f854304ab96fb3af468374a7_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_b086eb10f854304ab96fb3af468374a7_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_b086eb10f854304ab96fb3af468374a7_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_b086eb10f854304ab96fb3af468374a7_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +3e487476c06676330b2ed33684db7d1a \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_b086eb10f854304ab96fb3af468374a7_dep.png Binary file code-docs/dir_b086eb10f854304ab96fb3af468374a7_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_d28a4824dc47e487b107a5db32ef43c4.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_d28a4824dc47e487b107a5db32ef43c4.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,111 @@ + + + + + +VampPluginSDK: examples/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.4 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    examples Directory Reference
    +
    +
    +
    +Directory dependency graph for examples/:
    +
    +
    examples/
    + + +
    + + + + + + + + + + + + + + + +

    +Files

    file  AmplitudeFollower.cpp [code]
    file  AmplitudeFollower.h [code]
    file  FixedTempoEstimator.cpp [code]
    file  FixedTempoEstimator.h [code]
    file  PercussionOnsetDetector.cpp [code]
    file  PercussionOnsetDetector.h [code]
    file  plugins.cpp [code]
    file  PowerSpectrum.cpp [code]
    file  PowerSpectrum.h [code]
    file  SpectralCentroid.cpp [code]
    file  SpectralCentroid.h [code]
    file  ZeroCrossing.cpp [code]
    file  ZeroCrossing.h [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_d28a4824dc47e487b107a5db32ef43c4.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_d28a4824dc47e487b107a5db32ef43c4.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,16 @@ +var dir_d28a4824dc47e487b107a5db32ef43c4 = +[ + [ "AmplitudeFollower.cpp", "AmplitudeFollower_8cpp.html", null ], + [ "AmplitudeFollower.h", "AmplitudeFollower_8h.html", null ], + [ "FixedTempoEstimator.cpp", "FixedTempoEstimator_8cpp.html", null ], + [ "FixedTempoEstimator.h", "FixedTempoEstimator_8h.html", null ], + [ "PercussionOnsetDetector.cpp", "PercussionOnsetDetector_8cpp.html", null ], + [ "PercussionOnsetDetector.h", "PercussionOnsetDetector_8h.html", null ], + [ "plugins.cpp", "plugins_8cpp.html", null ], + [ "PowerSpectrum.cpp", "PowerSpectrum_8cpp.html", null ], + [ "PowerSpectrum.h", "PowerSpectrum_8h.html", null ], + [ "SpectralCentroid.cpp", "SpectralCentroid_8cpp.html", null ], + [ "SpectralCentroid.h", "SpectralCentroid_8h.html", null ], + [ "ZeroCrossing.cpp", "ZeroCrossing_8cpp.html", null ], + [ "ZeroCrossing.h", "ZeroCrossing_8h.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +10937f28fa50affc753bdfc7e07e9d06 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.png Binary file code-docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_dc0199af6955c245f7b5a687135670df.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_dc0199af6955c245f7b5a687135670df.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,99 @@ + + + + +VampPluginSDK: host/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.3 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    host Directory Reference
    +
    +
    +
    +Directory dependency graph for host/:
    +
    +
    host/
    + + +
    + + + + +

    +Files

    file  system.h [code]
    file  vamp-simple-host.cpp [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_dc0199af6955c245f7b5a687135670df_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_dc0199af6955c245f7b5a687135670df_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_dc0199af6955c245f7b5a687135670df_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_dc0199af6955c245f7b5a687135670df_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +2e73e3e63c81320b20412486cb25acc4 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_dc0199af6955c245f7b5a687135670df_dep.png Binary file code-docs/dir_dc0199af6955c245f7b5a687135670df_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_fb90db1f62862cb68177e0e13786fda0.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_fb90db1f62862cb68177e0e13786fda0.html Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,110 @@ + + + + + +VampPluginSDK: vamp-hostsdk/ Directory Reference + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + +
    +
    VampPluginSDK +  2.4 +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + +
    +
    +
    +
    vamp-hostsdk Directory Reference
    +
    +
    +
    +Directory dependency graph for vamp-hostsdk/:
    +
    +
    vamp-hostsdk/
    + + +
    + + + + + + + + + + + + + + +

    +Files

    file  hostguard.h [code]
    file  vamp-hostsdk/Plugin.h [code]
    file  vamp-hostsdk/PluginBase.h [code]
    file  PluginBufferingAdapter.h [code]
    file  PluginChannelAdapter.h [code]
    file  PluginHostAdapter.h [code]
    file  PluginInputDomainAdapter.h [code]
    file  PluginLoader.h [code]
    file  PluginSummarisingAdapter.h [code]
    file  PluginWrapper.h [code]
    file  vamp-hostsdk/RealTime.h [code]
    file  vamp-hostsdk.h [code]
    +
    +
    + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_fb90db1f62862cb68177e0e13786fda0.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_fb90db1f62862cb68177e0e13786fda0.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,15 @@ +var dir_fb90db1f62862cb68177e0e13786fda0 = +[ + [ "hostguard.h", "hostguard_8h.html", null ], + [ "vamp-hostsdk/Plugin.h", "vamp-hostsdk_2Plugin_8h.html", null ], + [ "vamp-hostsdk/PluginBase.h", "vamp-hostsdk_2PluginBase_8h.html", null ], + [ "PluginBufferingAdapter.h", "PluginBufferingAdapter_8h.html", null ], + [ "PluginChannelAdapter.h", "PluginChannelAdapter_8h.html", null ], + [ "PluginHostAdapter.h", "PluginHostAdapter_8h.html", null ], + [ "PluginInputDomainAdapter.h", "PluginInputDomainAdapter_8h.html", null ], + [ "PluginLoader.h", "PluginLoader_8h.html", null ], + [ "PluginSummarisingAdapter.h", "PluginSummarisingAdapter_8h.html", null ], + [ "PluginWrapper.h", "PluginWrapper_8h.html", null ], + [ "vamp-hostsdk/RealTime.h", "vamp-hostsdk_2RealTime_8h.html", null ], + [ "vamp-hostsdk.h", "vamp-hostsdk_8h.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_fb90db1f62862cb68177e0e13786fda0_dep.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_fb90db1f62862cb68177e0e13786fda0_dep.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_fb90db1f62862cb68177e0e13786fda0_dep.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dir_fb90db1f62862cb68177e0e13786fda0_dep.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +983c6efe48dec4196d7c7c578b7cca88 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dir_fb90db1f62862cb68177e0e13786fda0_dep.png Binary file code-docs/dir_fb90db1f62862cb68177e0e13786fda0_dep.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dirs.html --- a/code-docs/dirs.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/dirs.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Directories @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    This directory hierarchy is sorted roughly, but not completely, alphabetically:
    -
    + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/dirs.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/dirs.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,9 @@ +var dirs = +[ + [ "examples", "dir_d28a4824dc47e487b107a5db32ef43c4.html", "dir_d28a4824dc47e487b107a5db32ef43c4" ], + [ "host", "dir_4f7e4242e27b8c8b476722507617a881.html", "dir_4f7e4242e27b8c8b476722507617a881" ], + [ "src", "dir_68267d1309a1af8e8297ef4c3efbcdba.html", "dir_68267d1309a1af8e8297ef4c3efbcdba" ], + [ "vamp", "dir_9c751ccb9387a8f0ae6ae8f777da02a0.html", "dir_9c751ccb9387a8f0ae6ae8f777da02a0" ], + [ "vamp-hostsdk", "dir_fb90db1f62862cb68177e0e13786fda0.html", "dir_fb90db1f62862cb68177e0e13786fda0" ], + [ "vamp-sdk", "dir_8661d6ced9d80e9e8c7982a58cd73404.html", "dir_8661d6ced9d80e9e8c7982a58cd73404" ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/doc-overview.html --- a/code-docs/doc-overview.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/doc-overview.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: doc-overview File Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +

    Go to the source code of this file.

    -
    + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/doc-overview_source.html --- a/code-docs/doc-overview_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/doc-overview_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: doc-overview Source File @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Go to the documentation of this file.
    00001 
-
    + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/doxygen.css --- a/code-docs/doxygen.css Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/doxygen.css Fri Jul 13 13:30:27 2012 +0100 @@ -2,7 +2,8 @@ body, table, div, p, dl { font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; - font-size: 12px; + font-size: 13px; + line-height: 1.3; } /* @group Heading Levels */ @@ -121,12 +122,12 @@ a.elRef { } -a.code { - color: #4665A2; +a.code, a.code:visited { + color: #4665A2; } -a.codeRef { - color: #4665A2; +a.codeRef, a.codeRef:visited { + color: #4665A2; } /* @end */ @@ -198,6 +199,8 @@ border: 1px solid #C4CFE5; margin: 2px 0px 2px 0; padding: 2px 10px; + white-space: nowrap; + vertical-align: top; } td.indexvalue { @@ -290,6 +293,13 @@ color: #ff0000 } +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + /* @end */ /* @@ -613,6 +623,8 @@ table.doxtable { border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; } table.doxtable td, table.doxtable th { @@ -626,7 +638,6 @@ font-size: 110%; padding-bottom: 4px; padding-top: 5px; - text-align:left; } table.fieldtable { @@ -791,7 +802,8 @@ padding: 0 0 0 10px; } -dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section { border-left:4px solid; padding: 0 0 0 6px; @@ -832,6 +844,11 @@ border-color: #C08050; } +dl.section dd { + margin-bottom: 6px; +} + + #projectlogo { text-align: center; @@ -915,6 +932,55 @@ padding:5px 0; } +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 20px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + + @media print { #top { display: none; } diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/files.html --- a/code-docs/files.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/files.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: File List @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    Here is a list of all files with brief descriptions:
    + @@ -112,14 +114,14 @@
    AmplitudeFollower.cpp [code]
    AmplitudeFollower.h [code]
    doc-overview [code]
    FFT.h [code]
    FixedTempoEstimator.cpp [code]
    FixedTempoEstimator.h [code]
    hostguard.h [code]
    ZeroCrossing.cpp [code]
    ZeroCrossing.h [code]
    -
    + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/files.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/files.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,39 @@ +var files = +[ + [ "AmplitudeFollower.cpp", "AmplitudeFollower_8cpp.html", null ], + [ "AmplitudeFollower.h", "AmplitudeFollower_8h.html", null ], + [ "doc-overview", "doc-overview.html", null ], + [ "FFT.h", "FFT_8h.html", null ], + [ "FixedTempoEstimator.cpp", "FixedTempoEstimator_8cpp.html", "FixedTempoEstimator_8cpp" ], + [ "FixedTempoEstimator.h", "FixedTempoEstimator_8h.html", null ], + [ "hostguard.h", "hostguard_8h.html", "hostguard_8h" ], + [ "PercussionOnsetDetector.cpp", "PercussionOnsetDetector_8cpp.html", null ], + [ "PercussionOnsetDetector.h", "PercussionOnsetDetector_8h.html", null ], + [ "plugguard.h", "plugguard_8h.html", "plugguard_8h" ], + [ "vamp-sdk/Plugin.h", "vamp-sdk_2Plugin_8h.html", null ], + [ "vamp-hostsdk/Plugin.h", "vamp-hostsdk_2Plugin_8h.html", null ], + [ "PluginAdapter.h", "PluginAdapter_8h.html", null ], + [ "vamp-sdk/PluginBase.h", "vamp-sdk_2PluginBase_8h.html", null ], + [ "vamp-hostsdk/PluginBase.h", "vamp-hostsdk_2PluginBase_8h.html", null ], + [ "PluginBufferingAdapter.h", "PluginBufferingAdapter_8h.html", null ], + [ "PluginChannelAdapter.h", "PluginChannelAdapter_8h.html", null ], + [ "PluginHostAdapter.h", "PluginHostAdapter_8h.html", null ], + [ "PluginInputDomainAdapter.h", "PluginInputDomainAdapter_8h.html", null ], + [ "PluginLoader.h", "PluginLoader_8h.html", null ], + [ "plugins.cpp", "plugins_8cpp.html", "plugins_8cpp" ], + [ "PluginSummarisingAdapter.h", "PluginSummarisingAdapter_8h.html", null ], + [ "PluginWrapper.h", "PluginWrapper_8h.html", null ], + [ "PowerSpectrum.cpp", "PowerSpectrum_8cpp.html", null ], + [ "PowerSpectrum.h", "PowerSpectrum_8h.html", null ], + [ "vamp-sdk/RealTime.h", "vamp-sdk_2RealTime_8h.html", "vamp-sdk_2RealTime_8h" ], + [ "vamp-hostsdk/RealTime.h", "vamp-hostsdk_2RealTime_8h.html", null ], + [ "SpectralCentroid.cpp", "SpectralCentroid_8cpp.html", null ], + [ "SpectralCentroid.h", "SpectralCentroid_8h.html", null ], + [ "system.h", "system_8h.html", "system_8h" ], + [ "vamp-hostsdk.h", "vamp-hostsdk_8h.html", null ], + [ "vamp-sdk.h", "vamp-sdk_8h.html", null ], + [ "vamp-simple-host.cpp", "vamp-simple-host_8cpp.html", "vamp-simple-host_8cpp" ], + [ "vamp.h", "vamp_8h.html", "vamp_8h" ], + [ "ZeroCrossing.cpp", "ZeroCrossing_8cpp.html", null ], + [ "ZeroCrossing.h", "ZeroCrossing_8h.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions.html --- a/code-docs/functions.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x62.html --- a/code-docs/functions_0x62.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x62.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -129,14 +130,14 @@ : Vamp::HostExt::PluginInputDomainAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x63.html --- a/code-docs/functions_0x63.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x63.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -137,14 +138,14 @@ , Vamp::PluginAdapter< P > -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x64.html --- a/code-docs/functions_0x64.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x64.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -135,14 +136,14 @@ : _VampFeatureV2 -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x66.html --- a/code-docs/functions_0x66.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x66.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -132,6 +133,9 @@
  • FixedTempoEstimator() : FixedTempoEstimator
    • +
  • forward() +: Vamp::FFT +
  • frame2RealTime() : Vamp::RealTime
    • @@ -148,14 +152,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x67.html --- a/code-docs/functions_0x67.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x67.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -339,14 +340,14 @@ : Vamp::HostExt::PluginWrapper -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x68.html --- a/code-docs/functions_0x68.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x68.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -139,14 +140,14 @@ , _VampFeature -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x69.html --- a/code-docs/functions_0x69.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x69.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -127,10 +128,10 @@ , SpectralCentroid , Vamp::PluginHostAdapter , ZeroCrossing +, Vamp::HostExt::PluginInputDomainAdapter , FixedTempoEstimator::D , AmplitudeFollower , Vamp::HostExt::PluginWrapper -, Vamp::HostExt::PluginInputDomainAdapter , _VampPluginDescriptor , Vamp::HostExt::PluginSummarisingAdapter , Vamp::Plugin @@ -144,21 +145,24 @@
  • instantiate : _VampPluginDescriptor
    • +
  • inverse() +: Vamp::FFT +
  • isQuantized -: Vamp::PluginBase::ParameterDescriptor +: _VampParameterDescriptor +, Vamp::PluginBase::ParameterDescriptor , Vamp::Plugin::OutputDescriptor -, _VampParameterDescriptor , _VampOutputDescriptor
    • -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x6c.html --- a/code-docs/functions_0x6c.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x6c.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -125,14 +126,14 @@ : Vamp::HostExt::PluginLoader -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x6d.html --- a/code-docs/functions_0x6d.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x6d.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -246,14 +247,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x6e.html --- a/code-docs/functions_0x6e.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x6e.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -129,14 +130,14 @@ : Vamp::HostExt::PluginInputDomainAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x6f.html --- a/code-docs/functions_0x6f.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x6f.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -151,14 +152,14 @@ : Vamp::Plugin -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x70.html --- a/code-docs/functions_0x70.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x70.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -204,14 +205,14 @@ : _VampPluginDescriptor -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x71.html --- a/code-docs/functions_0x71.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x71.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -118,14 +119,14 @@ , _VampOutputDescriptor -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x72.html --- a/code-docs/functions_0x72.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x72.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -143,14 +144,14 @@ , PercussionOnsetDetector -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x73.html --- a/code-docs/functions_0x73.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x73.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -184,14 +185,14 @@ : Vamp::HostExt::PluginSummarisingAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x74.html --- a/code-docs/functions_0x74.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x74.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -130,14 +131,14 @@ : Vamp::HostExt::PluginInputDomainAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x75.html --- a/code-docs/functions_0x75.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x75.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -124,14 +125,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x76.html --- a/code-docs/functions_0x76.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x76.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -138,14 +139,14 @@ : Vamp::HostExt::PluginSummarisingAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x77.html --- a/code-docs/functions_0x77.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x77.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -115,14 +116,14 @@ : Vamp::HostExt::PluginInputDomainAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x7a.html --- a/code-docs/functions_0x7a.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x7a.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -118,14 +119,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_0x7e.html --- a/code-docs/functions_0x7e.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_0x7e.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -166,14 +167,14 @@ : ZeroCrossing -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_dup.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/functions_dup.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,25 @@ +var functions_dup = +[ + [ "a", "functions.html", null ], + [ "b", "functions_0x62.html", null ], + [ "c", "functions_0x63.html", null ], + [ "d", "functions_0x64.html", null ], + [ "f", "functions_0x66.html", null ], + [ "g", "functions_0x67.html", null ], + [ "h", "functions_0x68.html", null ], + [ "i", "functions_0x69.html", null ], + [ "l", "functions_0x6c.html", null ], + [ "m", "functions_0x6d.html", null ], + [ "n", "functions_0x6e.html", null ], + [ "o", "functions_0x6f.html", null ], + [ "p", "functions_0x70.html", null ], + [ "q", "functions_0x71.html", null ], + [ "r", "functions_0x72.html", null ], + [ "s", "functions_0x73.html", null ], + [ "t", "functions_0x74.html", null ], + [ "u", "functions_0x75.html", null ], + [ "v", "functions_0x76.html", null ], + [ "w", "functions_0x77.html", null ], + [ "z", "functions_0x7a.html", null ], + [ "~", "functions_0x7e.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_enum.html --- a/code-docs/functions_enum.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_enum.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Enumerations @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -105,14 +106,14 @@ : Vamp::HostExt::PluginInputDomainAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_eval.html --- a/code-docs/functions_eval.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_eval.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Enumerator @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -253,14 +254,14 @@ : Vamp::HostExt::PluginSummarisingAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func.html --- a/code-docs/functions_func.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -112,14 +113,14 @@ : FixedTempoEstimator::D -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/functions_func.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,19 @@ +var functions_func = +[ + [ "a", "functions_func.html", null ], + [ "c", "functions_func_0x63.html", null ], + [ "d", "functions_func_0x64.html", null ], + [ "f", "functions_func_0x66.html", null ], + [ "g", "functions_func_0x67.html", null ], + [ "i", "functions_func_0x69.html", null ], + [ "l", "functions_func_0x6c.html", null ], + [ "m", "functions_func_0x6d.html", null ], + [ "o", "functions_func_0x6f.html", null ], + [ "p", "functions_func_0x70.html", null ], + [ "r", "functions_func_0x72.html", null ], + [ "s", "functions_func_0x73.html", null ], + [ "t", "functions_func_0x74.html", null ], + [ "u", "functions_func_0x75.html", null ], + [ "z", "functions_func_0x7a.html", null ], + [ "~", "functions_func_0x7e.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x63.html --- a/code-docs/functions_func_0x63.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x63.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -119,14 +120,14 @@ , Vamp::PluginAdapter< P > -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x64.html --- a/code-docs/functions_func_0x64.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x64.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -109,14 +110,14 @@ : FixedTempoEstimator::D -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x66.html --- a/code-docs/functions_func_0x66.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x66.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -111,6 +112,9 @@
  • FixedTempoEstimator() : FixedTempoEstimator
    • +
  • forward() +: Vamp::FFT +
  • frame2RealTime() : Vamp::RealTime
    • @@ -124,14 +128,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x67.html --- a/code-docs/functions_func_0x67.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x67.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -320,14 +321,14 @@ : Vamp::HostExt::PluginWrapper -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x69.html --- a/code-docs/functions_func_0x69.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x69.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -107,29 +108,32 @@

    - i -

    -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x6c.html --- a/code-docs/functions_func_0x6c.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x6c.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -115,14 +116,14 @@ : Vamp::HostExt::PluginLoader -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x6d.html --- a/code-docs/functions_func_0x6d.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x6d.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -109,14 +110,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x6f.html --- a/code-docs/functions_func_0x6f.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x6f.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -139,14 +140,14 @@ : Vamp::Plugin::OutputDescriptor -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x70.html --- a/code-docs/functions_func_0x70.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x70.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -164,14 +165,14 @@ : Vamp::HostExt::PluginChannelAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x72.html --- a/code-docs/functions_func_0x72.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x72.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -127,14 +128,14 @@ , PowerSpectrum -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x73.html --- a/code-docs/functions_func_0x73.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x73.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -140,14 +141,14 @@ : SpectralCentroid -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x74.html --- a/code-docs/functions_func_0x74.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x74.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -115,14 +116,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x75.html --- a/code-docs/functions_func_0x75.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x75.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -109,14 +110,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x7a.html --- a/code-docs/functions_func_0x7a.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x7a.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -109,14 +110,14 @@ : ZeroCrossing -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_func_0x7e.html --- a/code-docs/functions_func_0x7e.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_func_0x7e.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Functions @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -160,14 +161,14 @@ : ZeroCrossing -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_type.html --- a/code-docs/functions_type.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_type.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Typedefs @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -111,14 +112,14 @@ : Vamp::HostExt::PluginSummarisingAdapter -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/functions_vars.html --- a/code-docs/functions_vars.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/functions_vars.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Members - Variables @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -497,14 +498,14 @@ : Vamp::RealTime -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/globals.html --- a/code-docs/globals.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/globals.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: File Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/globals_defs.html --- a/code-docs/globals_defs.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/globals_defs.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: File Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -128,23 +129,26 @@ : vamp.h
  • VAMP_SDK_MAJOR_VERSION -: vamp-sdk/PluginBase.h +: plugguard.h +, hostguard.h
  • VAMP_SDK_MINOR_VERSION -: vamp-sdk/PluginBase.h +: hostguard.h +, plugguard.h
  • VAMP_SDK_VERSION -: vamp-sdk/PluginBase.h +: plugguard.h +, hostguard.h
    • -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/globals_enum.html --- a/code-docs/globals_enum.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/globals_enum.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: File Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -93,14 +94,14 @@ : vamp-simple-host.cpp -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/globals_eval.html --- a/code-docs/globals_eval.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/globals_eval.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: File Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -111,14 +112,14 @@ : vamp.h -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/globals_func.html --- a/code-docs/globals_func.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/globals_func.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: File Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -121,14 +122,14 @@ , plugins.cpp -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/globals_type.html --- a/code-docs/globals_type.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/globals_type.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: File Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -111,14 +112,14 @@ : vamp.h -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/globals_vars.html --- a/code-docs/globals_vars.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/globals_vars.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: File Members @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    @@ -117,14 +118,14 @@ : plugins.cpp -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/graph_legend.html --- a/code-docs/graph_legend.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/graph_legend.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Graph Legend @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +

    This page explains how to interpret the graphs that are generated by doxygen.

    Consider the following example:

    @@ -107,9 +108,9 @@ };

    This will result in the following graph:

    -graph_legend.png +
    -

    The boxes in the above graph have the following meaning:

    +

    The boxes in the above graph have the following meaning:

    -

    The arrows have the following meaning:

    +

    The arrows have the following meaning:

    - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/graph_legend.png Binary file code-docs/graph_legend.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/hierarchy.html --- a/code-docs/hierarchy.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/hierarchy.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Hierarchy @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +

    Go to the graphical class hierarchy

    @@ -88,6 +89,7 @@
  • _VampPluginDescriptor
  • FixedTempoEstimator::D
  • Vamp::Plugin::Feature
    • +
  • Vamp::FFT
  • Vamp::Plugin::OutputDescriptor
  • Vamp::PluginBase::ParameterDescriptor
  • Vamp::PluginAdapterBase -
    • +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/hierarchy.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/hierarchy.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,37 @@ +var hierarchy = +[ + [ "_VampFeature", "struct__VampFeature.html", null ], + [ "_VampFeatureList", "struct__VampFeatureList.html", null ], + [ "_VampFeatureUnion", "union__VampFeatureUnion.html", null ], + [ "_VampFeatureV2", "struct__VampFeatureV2.html", null ], + [ "_VampOutputDescriptor", "struct__VampOutputDescriptor.html", null ], + [ "_VampParameterDescriptor", "struct__VampParameterDescriptor.html", null ], + [ "_VampPluginDescriptor", "struct__VampPluginDescriptor.html", null ], + [ "FixedTempoEstimator::D", "classFixedTempoEstimator_1_1D.html", null ], + [ "Vamp::Plugin::Feature", "structVamp_1_1Plugin_1_1Feature.html", null ], + [ "Vamp::FFT", "classVamp_1_1FFT.html", null ], + [ "Vamp::Plugin::OutputDescriptor", "structVamp_1_1Plugin_1_1OutputDescriptor.html", null ], + [ "Vamp::PluginBase::ParameterDescriptor", "structVamp_1_1PluginBase_1_1ParameterDescriptor.html", null ], + [ "Vamp::PluginAdapterBase", "classVamp_1_1PluginAdapterBase.html", [ + [ "Vamp::PluginAdapter< P >", "classVamp_1_1PluginAdapter.html", null ] + ] ], + [ "Vamp::PluginBase", "classVamp_1_1PluginBase.html", [ + [ "Vamp::Plugin", "classVamp_1_1Plugin.html", [ + [ "AmplitudeFollower", "classAmplitudeFollower.html", null ], + [ "FixedTempoEstimator", "classFixedTempoEstimator.html", null ], + [ "PercussionOnsetDetector", "classPercussionOnsetDetector.html", null ], + [ "PowerSpectrum", "classPowerSpectrum.html", null ], + [ "SpectralCentroid", "classSpectralCentroid.html", null ], + [ "Vamp::HostExt::PluginWrapper", "classVamp_1_1HostExt_1_1PluginWrapper.html", [ + [ "Vamp::HostExt::PluginBufferingAdapter", "classVamp_1_1HostExt_1_1PluginBufferingAdapter.html", null ], + [ "Vamp::HostExt::PluginChannelAdapter", "classVamp_1_1HostExt_1_1PluginChannelAdapter.html", null ], + [ "Vamp::HostExt::PluginInputDomainAdapter", "classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html", null ], + [ "Vamp::HostExt::PluginSummarisingAdapter", "classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html", null ] + ] ], + [ "Vamp::PluginHostAdapter", "classVamp_1_1PluginHostAdapter.html", null ], + [ "ZeroCrossing", "classZeroCrossing.html", null ] + ] ] + ] ], + [ "Vamp::HostExt::PluginLoader", "classVamp_1_1HostExt_1_1PluginLoader.html", null ], + [ "Vamp::RealTime", "structVamp_1_1RealTime.html", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/hostguard_8h.html --- a/code-docs/hostguard_8h.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/hostguard_8h.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: hostguard.h File Reference @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +
    hostguard.h File Reference
    - +

    Go to the source code of this file.

    - - - - - + + + + + + + +

    Defines

    #define _VAMP_IN_HOSTSDK
    #define _VAMP_SDK_HOSTSPACE_BEGIN(h)   namespace _VampHost {
    #define _VAMP_SDK_HOSTSPACE_END(h)
    #define _VAMP_SDK_PLUGSPACE_BEGIN(h)   namespace _VampHost {
    #define _VAMP_SDK_PLUGSPACE_END(h)
    #define _VAMP_IN_HOSTSDK
    #define VAMP_SDK_VERSION   "2.4"
    #define VAMP_SDK_MAJOR_VERSION   2
    #define VAMP_SDK_MINOR_VERSION   4
    #define _VAMP_SDK_HOSTSPACE_BEGIN(h)   namespace _VampHost {
    #define _VAMP_SDK_HOSTSPACE_END(h)
    #define _VAMP_SDK_PLUGSPACE_BEGIN(h)   namespace _VampHost {
    #define _VAMP_SDK_PLUGSPACE_END(h)

    Define Documentation

    - +
    - +
    #define _VAMP_IN_HOSTSDK#define _VAMP_IN_HOSTSDK
    @@ -104,12 +108,57 @@
    - +
    - + + +
    #define _VAMP_SDK_HOSTSPACE_BEGIN#define VAMP_SDK_VERSION   "2.4"
    +
    +
    + +

    Definition at line 46 of file hostguard.h.

    + +
    +
    + +
    +
    + + + + +
    #define VAMP_SDK_MAJOR_VERSION   2
    +
    +
    + +

    Definition at line 47 of file hostguard.h.

    + +
    +
    + +
    +
    + + + + +
    #define VAMP_SDK_MINOR_VERSION   4
    +
    +
    + +

    Definition at line 48 of file hostguard.h.

    + +
    +
    + +
    +
    + + + @@ -119,16 +168,16 @@
    -

    Definition at line 52 of file hostguard.h.

    +

    Definition at line 56 of file hostguard.h.

    - +
    #define _VAMP_SDK_HOSTSPACE_BEGIN (   h)
    - + @@ -140,16 +189,16 @@ Value:
    } \
         using namespace _VampHost;
    -

    Definition at line 55 of file hostguard.h.

    +

    Definition at line 59 of file hostguard.h.

    - +
    #define _VAMP_SDK_HOSTSPACE_END#define _VAMP_SDK_HOSTSPACE_END (   h)
    - + @@ -159,16 +208,16 @@
    -

    Definition at line 58 of file hostguard.h.

    +

    Definition at line 62 of file hostguard.h.

    - +
    #define _VAMP_SDK_PLUGSPACE_BEGIN#define _VAMP_SDK_PLUGSPACE_BEGIN (   h)
    - + @@ -180,19 +229,19 @@ Value:
    } \
         using namespace _VampHost;
    -

    Definition at line 61 of file hostguard.h.

    +

    Definition at line 65 of file hostguard.h.

    - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/hostguard_8h.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/hostguard_8h.js Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,11 @@ +var hostguard_8h = +[ + [ "_VAMP_IN_HOSTSDK", "hostguard_8h.html#a1b285975a7781cd1d1cdc19b0256380f", null ], + [ "VAMP_SDK_VERSION", "hostguard_8h.html#a9b7a8e1ac1c91366bec5f2f33c137a2f", null ], + [ "VAMP_SDK_MAJOR_VERSION", "hostguard_8h.html#ab5f7da6acf45065a6c7b7cd38a0bf588", null ], + [ "VAMP_SDK_MINOR_VERSION", "hostguard_8h.html#ad5eef1e2154b42769cd642d2a1d42257", null ], + [ "_VAMP_SDK_HOSTSPACE_BEGIN", "hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd", null ], + [ "_VAMP_SDK_HOSTSPACE_END", "hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171", null ], + [ "_VAMP_SDK_PLUGSPACE_BEGIN", "hostguard_8h.html#a1a2724ea453971288d3218e4eab3072c", null ], + [ "_VAMP_SDK_PLUGSPACE_END", "hostguard_8h.html#ac879bb1077ecc6132ea3581ef9033753", null ] +]; \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/hostguard_8h_source.html --- a/code-docs/hostguard_8h_source.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/hostguard_8h_source.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ +VampPluginSDK: hostguard.h Source File @@ -28,7 +29,7 @@ @@ -40,7 +41,7 @@
    #define _VAMP_SDK_PLUGSPACE_END#define _VAMP_SDK_PLUGSPACE_END (   h)
    VampPluginSDK -  2.1 +  2.4
    - +
    Go to the documentation of this file.
    00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 00002 
@@ -120,39 +121,43 @@
 00043 
 00044 #define _VAMP_IN_HOSTSDK
 00045 
-00046 #ifdef _VAMP_NO_HOST_NAMESPACE
-00047 #define _VAMP_SDK_HOSTSPACE_BEGIN(h)
-00048 #define _VAMP_SDK_HOSTSPACE_END(h)
-00049 #define _VAMP_SDK_PLUGSPACE_BEGIN(h)
-00050 #define _VAMP_SDK_PLUGSPACE_END(h)
-00051 #else
-00052 #define _VAMP_SDK_HOSTSPACE_BEGIN(h) \
-00053         namespace _VampHost {
-00054 
-00055 #define _VAMP_SDK_HOSTSPACE_END(h) \
-00056         } \
-00057         using namespace _VampHost;
-00058 #define _VAMP_SDK_PLUGSPACE_BEGIN(h) \
-00059         namespace _VampHost {
-00060 
-00061 #define _VAMP_SDK_PLUGSPACE_END(h) \
-00062         } \
-00063         using namespace _VampHost;
-00064 #endif
-00065 
-00066 #endif
-00067 
-00068 #endif
+00046 #define VAMP_SDK_VERSION "2.4"
+00047 #define VAMP_SDK_MAJOR_VERSION 2
+00048 #define VAMP_SDK_MINOR_VERSION 4
+00049 
+00050 #ifdef _VAMP_NO_HOST_NAMESPACE
+00051 #define _VAMP_SDK_HOSTSPACE_BEGIN(h)
+00052 #define _VAMP_SDK_HOSTSPACE_END(h)
+00053 #define _VAMP_SDK_PLUGSPACE_BEGIN(h)
+00054 #define _VAMP_SDK_PLUGSPACE_END(h)
+00055 #else
+00056 #define _VAMP_SDK_HOSTSPACE_BEGIN(h) \
+00057         namespace _VampHost {
+00058 
+00059 #define _VAMP_SDK_HOSTSPACE_END(h) \
+00060         } \
+00061         using namespace _VampHost;
+00062 #define _VAMP_SDK_PLUGSPACE_BEGIN(h) \
+00063         namespace _VampHost {
+00064 
+00065 #define _VAMP_SDK_PLUGSPACE_END(h) \
+00066         } \
+00067         using namespace _VampHost;
+00068 #endif
 00069 
-
    +00070 #endif +00071 +00072 #endif +00073 +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/index.html --- a/code-docs/index.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/index.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Vamp Plugin SDK @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +

    About Vamp

    @@ -98,6 +99,7 @@ +

    Plugin authors should also read the Programmer's Guide at http://vamp-plugins.org/guide.pdf .

    For Hosts

    Hosts will normally use a Vamp::PluginHostAdapter to convert each plugin's exposed C API back into a useful Vamp::Plugin C++ object.

    @@ -129,14 +131,14 @@

    License

    This plugin SDK is freely redistributable under a "new-style BSD" licence. See the file COPYING for more details. In short, you may modify and redistribute the SDK and example plugins within any commercial or non-commercial, proprietary or open-source plugin or application under almost any conditions, with no obligation to provide source code, provided you retain the original copyright note.

    -
    + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_0.png Binary file code-docs/inherit_graph_0.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_1.png Binary file code-docs/inherit_graph_1.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_10.map --- a/code-docs/inherit_graph_10.map Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_10.map Fri Jul 13 13:30:27 2012 +0100 @@ -1,3 +1,3 @@ - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_10.md5 --- a/code-docs/inherit_graph_10.md5 Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_10.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -1,1 +1,1 @@ -cdc6d883535df0f18b4ac88f3bd41d70 \ No newline at end of file +8a399c8baa4b0365dfe67d776f6e439a \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_10.png Binary file code-docs/inherit_graph_10.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_11.map --- a/code-docs/inherit_graph_11.map Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_11.map Fri Jul 13 13:30:27 2012 +0100 @@ -1,4 +1,3 @@ - - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_11.md5 --- a/code-docs/inherit_graph_11.md5 Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_11.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -1,1 +1,1 @@ -64cb6793b3cebd31d387c7f9355aadb1 \ No newline at end of file +cdc6d883535df0f18b4ac88f3bd41d70 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_11.png Binary file code-docs/inherit_graph_11.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_12.map --- a/code-docs/inherit_graph_12.map Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_12.map Fri Jul 13 13:30:27 2012 +0100 @@ -1,16 +1,4 @@ - - - - - - - - - - - - - - + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_12.md5 --- a/code-docs/inherit_graph_12.md5 Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_12.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -1,1 +1,1 @@ -b837ebdb201a5eb6a00a6636f42c6d34 \ No newline at end of file +64cb6793b3cebd31d387c7f9355aadb1 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_12.png Binary file code-docs/inherit_graph_12.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_13.map --- a/code-docs/inherit_graph_13.map Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_13.map Fri Jul 13 13:30:27 2012 +0100 @@ -1,3 +1,16 @@ - + + + + + + + + + + + + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_13.md5 --- a/code-docs/inherit_graph_13.md5 Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_13.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -1,1 +1,1 @@ -f8f6047af365dc0bcf885485e34eebbb \ No newline at end of file +b837ebdb201a5eb6a00a6636f42c6d34 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_13.png Binary file code-docs/inherit_graph_13.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_14.map --- a/code-docs/inherit_graph_14.map Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_14.map Fri Jul 13 13:30:27 2012 +0100 @@ -1,3 +1,3 @@ - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_14.md5 --- a/code-docs/inherit_graph_14.md5 Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_14.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -1,1 +1,1 @@ -72ba5bcf1305b723cc32db4dd35d4fb3 \ No newline at end of file +f8f6047af365dc0bcf885485e34eebbb \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_14.png Binary file code-docs/inherit_graph_14.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_15.map --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/inherit_graph_15.map Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,3 @@ + + + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_15.md5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/inherit_graph_15.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -0,0 +1,1 @@ +72ba5bcf1305b723cc32db4dd35d4fb3 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_15.png Binary file code-docs/inherit_graph_15.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_2.png Binary file code-docs/inherit_graph_2.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_3.png Binary file code-docs/inherit_graph_3.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_4.png Binary file code-docs/inherit_graph_4.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_5.png Binary file code-docs/inherit_graph_5.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_6.png Binary file code-docs/inherit_graph_6.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_7.png Binary file code-docs/inherit_graph_7.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_8.map --- a/code-docs/inherit_graph_8.map Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_8.map Fri Jul 13 13:30:27 2012 +0100 @@ -1,3 +1,3 @@ - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_8.md5 --- a/code-docs/inherit_graph_8.md5 Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_8.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -1,1 +1,1 @@ -550823f6e90752dea152b9695cea8bce \ No newline at end of file +5420b543e648e96f86fac267ce925194 \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_8.png Binary file code-docs/inherit_graph_8.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_9.map --- a/code-docs/inherit_graph_9.map Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_9.map Fri Jul 13 13:30:27 2012 +0100 @@ -1,3 +1,3 @@ - + diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_9.md5 --- a/code-docs/inherit_graph_9.md5 Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherit_graph_9.md5 Fri Jul 13 13:30:27 2012 +0100 @@ -1,1 +1,1 @@ -8a399c8baa4b0365dfe67d776f6e439a \ No newline at end of file +550823f6e90752dea152b9695cea8bce \ No newline at end of file diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherit_graph_9.png Binary file code-docs/inherit_graph_9.png has changed diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/inherits.html --- a/code-docs/inherits.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/inherits.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ + VampPluginSDK: Class Hierarchy @@ -28,7 +29,7 @@
    VampPluginSDK -  2.1 +  2.4
    @@ -40,7 +41,7 @@ - +

    Go to the textual class hierarchy

    @@ -111,43 +112,47 @@ - + + + + + - + - + - + - + - + - + -
    +
    diff -r 52d16fb98e80 -r 5c2683745b33 code-docs/jquery.js --- a/code-docs/jquery.js Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/jquery.js Fri Jul 13 13:30:27 2012 +0100 @@ -20,6 +20,16 @@ (function(){var R=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?/g,L=0,H=Object.prototype.toString;var F=function(Y,U,ab,ac){ab=ab||[];U=U||document;if(U.nodeType!==1&&U.nodeType!==9){return[]}if(!Y||typeof Y!=="string"){return ab}var Z=[],W,af,ai,T,ad,V,X=true;R.lastIndex=0;while((W=R.exec(Y))!==null){Z.push(W[1]);if(W[2]){V=RegExp.rightContext;break}}if(Z.length>1&&M.exec(Y)){if(Z.length===2&&I.relative[Z[0]]){af=J(Z[0]+Z[1],U)}else{af=I.relative[Z[0]]?[U]:F(Z.shift(),U);while(Z.length){Y=Z.shift();if(I.relative[Y]){Y+=Z.shift()}af=J(Y,af)}}}else{var ae=ac?{expr:Z.pop(),set:E(ac)}:F.find(Z.pop(),Z.length===1&&U.parentNode?U.parentNode:U,Q(U));af=F.filter(ae.expr,ae.set);if(Z.length>0){ai=E(af)}else{X=false}while(Z.length){var ah=Z.pop(),ag=ah;if(!I.relative[ah]){ah=""}else{ag=Z.pop()}if(ag==null){ag=U}I.relative[ah](ai,ag,Q(U))}}if(!ai){ai=af}if(!ai){throw"Syntax error, unrecognized expression: "+(ah||Y)}if(H.call(ai)==="[object Array]"){if(!X){ab.push.apply(ab,ai)}else{if(U.nodeType===1){for(var aa=0;ai[aa]!=null;aa++){if(ai[aa]&&(ai[aa]===true||ai[aa].nodeType===1&&K(U,ai[aa]))){ab.push(af[aa])}}}else{for(var aa=0;ai[aa]!=null;aa++){if(ai[aa]&&ai[aa].nodeType===1){ab.push(af[aa])}}}}}else{E(ai,ab)}if(V){F(V,U,ab,ac);if(G){hasDuplicate=false;ab.sort(G);if(hasDuplicate){for(var aa=1;aa":function(Z,U,aa){var X=typeof U==="string";if(X&&!/\W/.test(U)){U=aa?U:U.toUpperCase();for(var V=0,T=Z.length;V=0)){if(!V){T.push(Y)}}else{if(V){U[X]=false}}}}return false},ID:function(T){return T[1].replace(/\\/g,"")},TAG:function(U,T){for(var V=0;T[V]===false;V++){}return T[V]&&Q(T[V])?U[1]:U[1].toUpperCase()},CHILD:function(T){if(T[1]=="nth"){var U=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(T[2]=="even"&&"2n"||T[2]=="odd"&&"2n+1"||!/\D/.test(T[2])&&"0n+"+T[2]||T[2]);T[2]=(U[1]+(U[2]||1))-0;T[3]=U[3]-0}T[0]=L++;return T},ATTR:function(X,U,V,T,Y,Z){var W=X[1].replace(/\\/g,"");if(!Z&&I.attrMap[W]){X[1]=I.attrMap[W]}if(X[2]==="~="){X[4]=" "+X[4]+" "}return X},PSEUDO:function(X,U,V,T,Y){if(X[1]==="not"){if(X[3].match(R).length>1||/^\w/.test(X[3])){X[3]=F(X[3],null,null,U)}else{var W=F.filter(X[3],U,V,true^Y);if(!V){T.push.apply(T,W)}return false}}else{if(I.match.POS.test(X[0])||I.match.CHILD.test(X[0])){return true}}return X},POS:function(T){T.unshift(true);return T}},filters:{enabled:function(T){return T.disabled===false&&T.type!=="hidden"},disabled:function(T){return T.disabled===true},checked:function(T){return T.checked===true},selected:function(T){T.parentNode.selectedIndex;return T.selected===true},parent:function(T){return !!T.firstChild},empty:function(T){return !T.firstChild},has:function(V,U,T){return !!F(T[3],V).length},header:function(T){return/h\d/i.test(T.nodeName)},text:function(T){return"text"===T.type},radio:function(T){return"radio"===T.type},checkbox:function(T){return"checkbox"===T.type},file:function(T){return"file"===T.type},password:function(T){return"password"===T.type},submit:function(T){return"submit"===T.type},image:function(T){return"image"===T.type},reset:function(T){return"reset"===T.type},button:function(T){return"button"===T.type||T.nodeName.toUpperCase()==="BUTTON"},input:function(T){return/input|select|textarea|button/i.test(T.nodeName)}},setFilters:{first:function(U,T){return T===0},last:function(V,U,T,W){return U===W.length-1},even:function(U,T){return T%2===0},odd:function(U,T){return T%2===1},lt:function(V,U,T){return UT[3]-0},nth:function(V,U,T){return T[3]-0==U},eq:function(V,U,T){return T[3]-0==U}},filter:{PSEUDO:function(Z,V,W,aa){var U=V[1],X=I.filters[U];if(X){return X(Z,W,V,aa)}else{if(U==="contains"){return(Z.textContent||Z.innerText||"").indexOf(V[3])>=0}else{if(U==="not"){var Y=V[3];for(var W=0,T=Y.length;W=0)}}},ID:function(U,T){return U.nodeType===1&&U.getAttribute("id")===T},TAG:function(U,T){return(T==="*"&&U.nodeType===1)||U.nodeName===T},CLASS:function(U,T){return(" "+(U.className||U.getAttribute("class"))+" ").indexOf(T)>-1},ATTR:function(Y,W){var V=W[1],T=I.attrHandle[V]?I.attrHandle[V](Y):Y[V]!=null?Y[V]:Y.getAttribute(V),Z=T+"",X=W[2],U=W[4];return T==null?X==="!=":X==="="?Z===U:X==="*="?Z.indexOf(U)>=0:X==="~="?(" "+Z+" ").indexOf(U)>=0:!U?Z&&T!==false:X==="!="?Z!=U:X==="^="?Z.indexOf(U)===0:X==="$="?Z.substr(Z.length-U.length)===U:X==="|="?Z===U||Z.substr(0,U.length+1)===U+"-":false},POS:function(X,U,V,Y){var T=U[2],W=I.setFilters[T];if(W){return W(X,V,U,Y)}}}};var M=I.match.POS;for(var O in I.match){I.match[O]=RegExp(I.match[O].source+/(?![^\[]*\])(?![^\(]*\))/.source)}var E=function(U,T){U=Array.prototype.slice.call(U);if(T){T.push.apply(T,U);return T}return U};try{Array.prototype.slice.call(document.documentElement.childNodes)}catch(N){E=function(X,W){var U=W||[];if(H.call(X)==="[object Array]"){Array.prototype.push.apply(U,X)}else{if(typeof X.length==="number"){for(var V=0,T=X.length;V";var T=document.documentElement;T.insertBefore(U,T.firstChild);if(!!document.getElementById(V)){I.find.ID=function(X,Y,Z){if(typeof Y.getElementById!=="undefined"&&!Z){var W=Y.getElementById(X[1]);return W?W.id===X[1]||typeof W.getAttributeNode!=="undefined"&&W.getAttributeNode("id").nodeValue===X[1]?[W]:g:[]}};I.filter.ID=function(Y,W){var X=typeof Y.getAttributeNode!=="undefined"&&Y.getAttributeNode("id");return Y.nodeType===1&&X&&X.nodeValue===W}}T.removeChild(U)})();(function(){var T=document.createElement("div");T.appendChild(document.createComment(""));if(T.getElementsByTagName("*").length>0){I.find.TAG=function(U,Y){var X=Y.getElementsByTagName(U[1]);if(U[1]==="*"){var W=[];for(var V=0;X[V];V++){if(X[V].nodeType===1){W.push(X[V])}}X=W}return X}}T.innerHTML="";if(T.firstChild&&typeof T.firstChild.getAttribute!=="undefined"&&T.firstChild.getAttribute("href")!=="#"){I.attrHandle.href=function(U){return U.getAttribute("href",2)}}})();if(document.querySelectorAll){(function(){var T=F,U=document.createElement("div");U.innerHTML="

    ";if(U.querySelectorAll&&U.querySelectorAll(".TEST").length===0){return}F=function(Y,X,V,W){X=X||document;if(!W&&X.nodeType===9&&!Q(X)){try{return E(X.querySelectorAll(Y),V)}catch(Z){}}return T(Y,X,V,W)};F.find=T.find;F.filter=T.filter;F.selectors=T.selectors;F.matches=T.matches})()}if(document.getElementsByClassName&&document.documentElement.getElementsByClassName){(function(){var T=document.createElement("div");T.innerHTML="
    ";if(T.getElementsByClassName("e").length===0){return}T.lastChild.className="e";if(T.getElementsByClassName("e").length===1){return}I.order.splice(1,0,"CLASS");I.find.CLASS=function(U,V,W){if(typeof V.getElementsByClassName!=="undefined"&&!W){return V.getElementsByClassName(U[1])}}})()}function P(U,Z,Y,ad,aa,ac){var ab=U=="previousSibling"&&!ac;for(var W=0,V=ad.length;W0){X=T;break}}}T=T[U]}ad[W]=X}}}var K=document.compareDocumentPosition?function(U,T){return U.compareDocumentPosition(T)&16}:function(U,T){return U!==T&&(U.contains?U.contains(T):true)};var Q=function(T){return T.nodeType===9&&T.documentElement.nodeName!=="HTML"||!!T.ownerDocument&&Q(T.ownerDocument)};var J=function(T,aa){var W=[],X="",Y,V=aa.nodeType?[aa]:aa;while((Y=I.match.PSEUDO.exec(T))){X+=Y[0];T=T.replace(I.match.PSEUDO,"")}T=I.relative[T]?T+"*":T;for(var Z=0,U=V.length;Z0||T.offsetHeight>0};F.selectors.filters.animated=function(T){return o.grep(o.timers,function(U){return T===U.elem}).length};o.multiFilter=function(V,T,U){if(U){V=":not("+V+")"}return F.matches(V,T)};o.dir=function(V,U){var T=[],W=V[U];while(W&&W!=document){if(W.nodeType==1){T.push(W)}W=W[U]}return T};o.nth=function(X,T,V,W){T=T||1;var U=0;for(;X;X=X[V]){if(X.nodeType==1&&++U==T){break}}return X};o.sibling=function(V,U){var T=[];for(;V;V=V.nextSibling){if(V.nodeType==1&&V!=U){T.push(V)}}return T};return;l.Sizzle=F})();o.event={add:function(I,F,H,K){if(I.nodeType==3||I.nodeType==8){return}if(I.setInterval&&I!=l){I=l}if(!H.guid){H.guid=this.guid++}if(K!==g){var G=H;H=this.proxy(G);H.data=K}var E=o.data(I,"events")||o.data(I,"events",{}),J=o.data(I,"handle")||o.data(I,"handle",function(){return typeof o!=="undefined"&&!o.event.triggered?o.event.handle.apply(arguments.callee.elem,arguments):g});J.elem=I;o.each(F.split(/\s+/),function(M,N){var O=N.split(".");N=O.shift();H.type=O.slice().sort().join(".");var L=E[N];if(o.event.specialAll[N]){o.event.specialAll[N].setup.call(I,K,O)}if(!L){L=E[N]={};if(!o.event.special[N]||o.event.special[N].setup.call(I,K,O)===false){if(I.addEventListener){I.addEventListener(N,J,false)}else{if(I.attachEvent){I.attachEvent("on"+N,J)}}}}L[H.guid]=H;o.event.global[N]=true});I=null},guid:1,global:{},remove:function(K,H,J){if(K.nodeType==3||K.nodeType==8){return}var G=o.data(K,"events"),F,E;if(G){if(H===g||(typeof H==="string"&&H.charAt(0)==".")){for(var I in G){this.remove(K,I+(H||""))}}else{if(H.type){J=H.handler;H=H.type}o.each(H.split(/\s+/),function(M,O){var Q=O.split(".");O=Q.shift();var N=RegExp("(^|\\.)"+Q.slice().sort().join(".*\\.")+"(\\.|$)");if(G[O]){if(J){delete G[O][J.guid]}else{for(var P in G[O]){if(N.test(G[O][P].type)){delete G[O][P]}}}if(o.event.specialAll[O]){o.event.specialAll[O].teardown.call(K,Q)}for(F in G[O]){break}if(!F){if(!o.event.special[O]||o.event.special[O].teardown.call(K,Q)===false){if(K.removeEventListener){K.removeEventListener(O,o.data(K,"handle"),false)}else{if(K.detachEvent){K.detachEvent("on"+O,o.data(K,"handle"))}}}F=null;delete G[O]}}})}for(F in G){break}if(!F){var L=o.data(K,"handle");if(L){L.elem=null}o.removeData(K,"events");o.removeData(K,"handle")}}},trigger:function(I,K,H,E){var G=I.type||I;if(!E){I=typeof I==="object"?I[h]?I:o.extend(o.Event(G),I):o.Event(G);if(G.indexOf("!")>=0) {I.type=G=G.slice(0,-1);I.exclusive=true}if(!H){I.stopPropagation();if(this.global[G]){o.each(o.cache,function(){if(this.events&&this.events[G]){o.event.trigger(I,K,this.handle.elem)}})}}if(!H||H.nodeType==3||H.nodeType==8){return g}I.result=g;I.target=H;K=o.makeArray(K);K.unshift(I)}I.currentTarget=H;var J=o.data(H,"handle");if(J){J.apply(H,K)}if((!H[G]||(o.nodeName(H,"a")&&G=="click"))&&H["on"+G]&&H["on"+G].apply(H,K)===false){I.result=false}if(!E&&H[G]&&!I.isDefaultPrevented()&&!(o.nodeName(H,"a")&&G=="click")){this.triggered=true;try{H[G]()}catch(L){}}this.triggered=false;if(!I.isPropagationStopped()){var F=H.parentNode||H.ownerDocument;if(F){o.event.trigger(I,K,F,true)}}},handle:function(K){var J,E;K=arguments[0]=o.event.fix(K||l.event);K.currentTarget=this;var L=K.type.split(".");K.type=L.shift();J=!L.length&&!K.exclusive;var I=RegExp("(^|\\.)"+L.slice().sort().join(".*\\.")+"(\\.|$)");E=(o.data(this,"events")||{})[K.type];for(var G in E){var H=E[G];if(J||I.test(H.type)){K.handler=H;K.data=H.data;var F=H.apply(this,arguments);if(F!==g){K.result=F;if(F===false){K.preventDefault();K.stopPropagation()}}if(K.isImmediatePropagationStopped()){break}}}},props:"altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target toElement view wheelDelta which".split(" "),fix:function(H){if(H[h]){return H}var F=H;H=o.Event(F);for(var G=this.props.length,J;G;){J=this.props[--G];H[J]=F[J]}if(!H.target){H.target=H.srcElement||document}if(H.target.nodeType==3){H.target=H.target.parentNode}if(!H.relatedTarget&&H.fromElement){H.relatedTarget=H.fromElement==H.target?H.toElement:H.fromElement}if(H.pageX==null&&H.clientX!=null){var I=document.documentElement,E=document.body;H.pageX=H.clientX+(I&&I.scrollLeft||E&&E.scrollLeft||0)-(I.clientLeft||0);H.pageY=H.clientY+(I&&I.scrollTop||E&&E.scrollTop||0)-(I.clientTop||0)}if(!H.which&&((H.charCode||H.charCode===0)?H.charCode:H.keyCode)){H.which=H.charCode||H.keyCode}if(!H.metaKey&&H.ctrlKey){H.metaKey=H.ctrlKey}if(!H.which&&H.button){H.which=(H.button&1?1:(H.button&2?3:(H.button&4?2:0)))}return H},proxy:function(F,E){E=E||function(){return F.apply(this,arguments)};E.guid=F.guid=F.guid||E.guid||this.guid++;return E},special:{ready:{setup:B,teardown:function(){}}},specialAll:{live:{setup:function(E,F){o.event.add(this,F[0],c)},teardown:function(G){if(G.length){var E=0,F=RegExp("(^|\\.)"+G[0]+"(\\.|$)");o.each((o.data(this,"events").live||{}),function(){if(F.test(this.type)){E++}});if(E<1){o.event.remove(this,G[0],c)}}}}}};o.Event=function(E){if(!this.preventDefault){return new o.Event(E)}if(E&&E.type){this.originalEvent=E;this.type=E.type}else{this.type=E}this.timeStamp=e();this[h]=true};function k(){return false}function u(){return true}o.Event.prototype={preventDefault:function(){this.isDefaultPrevented=u;var E=this.originalEvent;if(!E){return}if(E.preventDefault){E.preventDefault()}E.returnValue=false},stopPropagation:function(){this.isPropagationStopped=u;var E=this.originalEvent;if(!E){return}if(E.stopPropagation){E.stopPropagation()}E.cancelBubble=true},stopImmediatePropagation:function(){this.isImmediatePropagationStopped=u;this.stopPropagation()},isDefaultPrevented:k,isPropagationStopped:k,isImmediatePropagationStopped:k};var a=function(F){var E=F.relatedTarget;while(E&&E!=this){try{E=E.parentNode}catch(G){E=this}}if(E!=this){F.type=F.data;o.event.handle.apply(this,arguments)}};o.each({mouseover:"mouseenter",mouseout:"mouseleave"},function(F,E){o.event.special[E]={setup:function(){o.event.add(this,F,a,E)},teardown:function(){o.event.remove(this,F,a)}}});o.fn.extend({bind:function(F,G,E){return F=="unload"?this.one(F,G,E):this.each(function(){o.event.add(this,F,E||G,E&&G)})},one:function(G,H,F){var E=o.event.proxy(F||H,function(I){o(this).unbind(I,E);return(F||H).apply(this,arguments)});return this.each(function(){o.event.add(this,G,E,F&&H)})},unbind:function(F,E){return this.each(function(){o.event.remove(this,F,E)})},trigger:function(E,F){return this.each(function(){o.event.trigger(E,F,this)})},triggerHandler:function(E,G){if(this[0]){var F=o.Event(E);F.preventDefault();F.stopPropagation();o.event.trigger(F,G,this[0]);return F.result}},toggle:function(G){var E=arguments,F=1;while(F=0){var E=G.slice(I,G.length);G=G.slice(0,I)}var H="GET";if(J){if(o.isFunction(J)){K=J;J=null}else{if(typeof J==="object"){J=o.param(J);H="POST"}}}var F=this;o.ajax({url:G,type:H,dataType:"html",data:J,complete:function(M,L){if(L=="success"||L=="notmodified"){F.html(E?o("
    ").append(M.responseText.replace(//g,"")).find(E):M.responseText)}if(K){F.each(K,[M.responseText,L,M])}}});return this},serialize:function(){return o.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?o.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||/select|textarea/i.test(this.nodeName)||/text|hidden|password|search/i.test(this.type))}).map(function(E,F){var G=o(this).val();return G==null?null:o.isArray(G)?o.map(G,function(I,H){return{name:F.name,value:I}}):{name:F.name,value:G}}).get()}});o.each("ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","),function(E,F){o.fn[F]=function(G){return this.bind(F,G)}});var r=e();o.extend({get:function(E,G,H,F){if(o.isFunction(G)){H=G;G=null}return o.ajax({type:"GET",url:E,data:G,success:H,dataType:F})},getScript:function(E,F){return o.get(E,null,F,"script")},getJSON:function(E,F,G){return o.get(E,F,G,"json")},post:function(E,G,H,F){if(o.isFunction(G)){H=G;G={}}return o.ajax({type:"POST",url:E,data:G,success:H,dataType:F})},ajaxSetup:function(E){o.extend(o.ajaxSettings,E)},ajaxSettings:{url:location.href,global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:function(){return l.ActiveXObject?new ActiveXObject("Microsoft.XMLHTTP"):new XMLHttpRequest()},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},ajax:function(M){M=o.extend(true,M,o.extend(true,{},o.ajaxSettings,M));var W,F=/=\?(&|$)/g,R,V,G=M.type.toUpperCase();if(M.data&&M.processData&&typeof M.data!=="string"){M.data=o.param(M.data)}if(M.dataType=="jsonp"){if(G=="GET"){if(!M.url.match(F)){M.url+=(M.url.match(/\?/)?"&":"?")+(M.jsonp||"callback")+"=?"}}else{if(!M.data||!M.data.match(F)){M.data=(M.data?M.data+"&":"")+(M.jsonp||"callback")+"=?"}}M.dataType="json"}if(M.dataType=="json"&&(M.data&&M.data.match(F)||M.url.match(F))){W="jsonp"+r++;if(M.data){M.data=(M.data+"").replace(F,"="+W+"$1")}M.url=M.url.replace(F,"="+W+"$1");M.dataType="script";l[W]=function(X){V=X;I();L();l[W]=g;try{delete l[W]}catch(Y){}if(H){H.removeChild(T)}}}if(M.dataType=="script"&&M.cache==null){M.cache=false}if(M.cache===false&&G=="GET"){var E=e();var U=M.url.replace(/(\?|&)_=.*?(&|$)/,"$1_="+E+"$2");M.url=U+((U==M.url)?(M.url.match(/\?/)?"&":"?")+"_="+E:"")}if(M.data&&G=="GET"){M.url+=(M.url.match(/\?/)?"&":"?")+M.data;M.data=null}if(M.global&&!o.active++){o.event.trigger("ajaxStart")}var Q=/^(\w+:)?\/\/([^\/?#]+)/.exec(M.url);if(M.dataType=="script"&&G=="GET"&&Q&&(Q[1]&&Q[1]!=location.protocol||Q[2]!=location.host)){var H=document.getElementsByTagName("head")[0];var T=document.createElement("script");T.src=M.url;if(M.scriptCharset){T.charset=M.scriptCharset}if(!W){var O=false;T.onload=T.onreadystatechange=function(){if(!O&&(!this.readyState||this.readyState=="loaded"||this.readyState=="complete")){O=true;I();L();T.onload=T.onreadystatechange=null;H.removeChild(T)}}}H.appendChild(T);return g}var K=false;var J=M.xhr();if(M.username){J.open(G,M.url,M.async,M.username,M.password)}else{J.open(G,M.url,M.async)}try{if(M.data){J.setRequestHeader("Content-Type",M.contentType)}if(M.ifModified){J.setRequestHeader("If-Modified-Since",o.lastModified[M.url]||"Thu, 01 Jan 1970 00:00:00 GMT")}J.setRequestHeader("X-Requested-With","XMLHttpRequest");J.setRequestHeader("Accept",M.dataType&&M.accepts[M.dataType]?M.accepts[M.dataType]+", */*":M.accepts._default)}catch(S){}if(M.beforeSend&&M.beforeSend(J,M)===false){if(M.global&&!--o.active){o.event.trigger("ajaxStop")}J.abort();return false}if(M.global){o.event.trigger("ajaxSend",[J,M])}var N=function(X){if(J.readyState==0){if(P){clearInterval(P);P=null;if(M.global&&!--o.active){o.event.trigger("ajaxStop")}}}else{if(!K&&J&&(J.readyState==4||X=="timeout")){K=true;if(P){clearInterval(P);P=null}R=X=="timeout"?"timeout":!o.httpSuccess(J)?"error":M.ifModified&&o.httpNotModified(J,M.url)?"notmodified":"success";if(R=="success"){try{V=o.httpData(J,M.dataType,M)}catch(Z){R="parsererror"}}if(R=="success"){var Y;try{Y=J.getResponseHeader("Last-Modified")}catch(Z){}if(M.ifModified&&Y){o.lastModified[M.url]=Y}if(!W){I()}}else{o.handleError(M,J,R)}L();if(X){J.abort()}if(M.async){J=null}}}};if(M.async){var P=setInterval(N,13);if(M.timeout>0){setTimeout(function(){if(J&&!K){N("timeout")}},M.timeout)}}try{J.send(M.data)}catch(S){o.handleError(M,J,null,S)}if(!M.async){N()}function I(){if(M.success){M.success(V,R)}if(M.global){o.event.trigger("ajaxSuccess",[J,M])}}function L(){if(M.complete){M.complete(J,R)}if(M.global){o.event.trigger("ajaxComplete",[J,M])}if(M.global&&!--o.active){o.event.trigger("ajaxStop")}}return J},handleError:function(F,H,E,G){if(F.error){F.error(H,E,G)}if(F.global){o.event.trigger("ajaxError",[H,F,G])}},active:0,httpSuccess:function(F){try{return !F.status&&location.protocol=="file:"||(F.status>=200&&F.status<300)||F.status==304||F.status==1223}catch(E){}return false},httpNotModified:function(G,E){try{var H=G.getResponseHeader("Last-Modified");return G.status==304||H==o.lastModified[E]}catch(F){}return false},httpData:function(J,H,G){var F=J.getResponseHeader("content-type"),E=H=="xml"||!H&&F&&F.indexOf("xml")>=0,I=E?J.responseXML:J.responseText;if(E&&I.documentElement.tagName=="parsererror"){throw"parsererror"}if(G&&G.dataFilter){I=G.dataFilter(I,H)}if(typeof I==="string"){if(H=="script"){o.globalEval(I)}if(H=="json"){I=l["eval"]("("+I+")")}}return I},param:function(E){var G=[];function H(I,J){G[G.length]=encodeURIComponent(I)+"="+encodeURIComponent(J)}if(o.isArray(E)||E.jquery){o.each(E,function(){H(this.name,this.value)})}else{for(var F in E){if(o.isArray(E[F])){o.each(E[F],function(){H(F,this)})}else{H(F,o.isFunction(E[F])?E[F]():E[F])}}}return G.join("&").replace(/%20/g,"+")}});var m={},n,d=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];function t(F,E){var G={};o.each(d.concat.apply([],d.slice(0,E)),function() {G[this]=F});return G}o.fn.extend({show:function(J,L){if(J){return this.animate(t("show",3),J,L)}else{for(var H=0,F=this.length;H").appendTo("body");K=I.css("display");if(K==="none"){K="block"}I.remove();m[G]=K}o.data(this[H],"olddisplay",K)}}for(var H=0,F=this.length;H=0;H--){if(G[H].elem==this){if(E){G[H](true)}G.splice(H,1)}}});if(!E){this.dequeue()}return this}});o.each({slideDown:t("show",1),slideUp:t("hide",1),slideToggle:t("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(E,F){o.fn[E]=function(G,H){return this.animate(F,G,H)}});o.extend({speed:function(G,H,F){var E=typeof G==="object"?G:{complete:F||!F&&H||o.isFunction(G)&&G,duration:G,easing:F&&H||H&&!o.isFunction(H)&&H};E.duration=o.fx.off?0:typeof E.duration==="number"?E.duration:o.fx.speeds[E.duration]||o.fx.speeds._default;E.old=E.complete;E.complete=function(){if(E.queue!==false){o(this).dequeue()}if(o.isFunction(E.old)){E.old.call(this)}};return E},easing:{linear:function(G,H,E,F){return E+F*G},swing:function(G,H,E,F){return((-Math.cos(G*Math.PI)/2)+0.5)*F+E}},timers:[],fx:function(F,E,G){this.options=E;this.elem=F;this.prop=G;if(!E.orig){E.orig={}}}});o.fx.prototype={update:function(){if(this.options.step){this.options.step.call(this.elem,this.now,this)}(o.fx.step[this.prop]||o.fx.step._default)(this);if((this.prop=="height"||this.prop=="width")&&this.elem.style){this.elem.style.display="block"}},cur:function(F){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null)){return this.elem[this.prop]}var E=parseFloat(o.css(this.elem,this.prop,F));return E&&E>-10000?E:parseFloat(o.curCSS(this.elem,this.prop))||0},custom:function(I,H,G){this.startTime=e();this.start=I;this.end=H;this.unit=G||this.unit||"px";this.now=this.start;this.pos=this.state=0;var E=this;function F(J){return E.step(J)}F.elem=this.elem;if(F()&&o.timers.push(F)&&!n){n=setInterval(function(){var K=o.timers;for(var J=0;J=this.options.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;var E=true;for(var F in this.options.curAnim){if(this.options.curAnim[F]!==true){E=false}}if(E){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;this.elem.style.display=this.options.display;if(o.css(this.elem,"display")=="none"){this.elem.style.display="block"}}if(this.options.hide){o(this.elem).hide()}if(this.options.hide||this.options.show){for(var I in this.options.curAnim){o.attr(this.elem.style,I,this.options.orig[I])}}this.options.complete.call(this.elem)}return false}else{var J=G-this.startTime;this.state=J/this.options.duration;this.pos=o.easing[this.options.easing||(o.easing.swing?"swing":"linear")](this.state,J,0,1,this.options.duration);this.now=this.start+((this.end-this.start)*this.pos);this.update()}return true}};o.extend(o.fx,{speeds:{slow:600,fast:200,_default:400},step:{opacity:function(E){o.attr(E.elem.style,"opacity",E.now)},_default:function(E){if(E.elem.style&&E.elem.style[E.prop]!=null){E.elem.style[E.prop]=E.now+E.unit}else{E.elem[E.prop]=E.now}}}});if(document.documentElement.getBoundingClientRect){o.fn.offset=function(){if(!this[0]){return{top:0,left:0}}if(this[0]===this[0].ownerDocument.body){return o.offset.bodyOffset(this[0])}var G=this[0].getBoundingClientRect(),J=this[0].ownerDocument,F=J.body,E=J.documentElement,L=E.clientTop||F.clientTop||0,K=E.clientLeft||F.clientLeft||0,I=G.top+(self.pageYOffset||o.boxModel&&E.scrollTop||F.scrollTop)-L,H=G.left+(self.pageXOffset||o.boxModel&&E.scrollLeft||F.scrollLeft)-K;return{top:I,left:H}}}else{o.fn.offset=function(){if(!this[0]){return{top:0,left:0}}if(this[0]===this[0].ownerDocument.body){return o.offset.bodyOffset(this[0])}o.offset.initialized||o.offset.initialize();var J=this[0],G=J.offsetParent,F=J,O=J.ownerDocument,M,H=O.documentElement,K=O.body,L=O.defaultView,E=L.getComputedStyle(J,null),N=J.offsetTop,I=J.offsetLeft;while((J=J.parentNode)&&J!==K&&J!==H){M=L.getComputedStyle(J,null);N-=J.scrollTop,I-=J.scrollLeft;if(J===G){N+=J.offsetTop,I+=J.offsetLeft;if(o.offset.doesNotAddBorder&&!(o.offset.doesAddBorderForTableAndCells&&/^t(able|d|h)$/i.test(J.tagName))){N+=parseInt(M.borderTopWidth,10)||0,I+=parseInt(M.borderLeftWidth,10)||0}F=G,G=J.offsetParent}if(o.offset.subtractsBorderForOverflowNotVisible&&M.overflow!=="visible"){N+=parseInt(M.borderTopWidth,10)||0,I+=parseInt(M.borderLeftWidth,10)||0}E=M}if(E.position==="relative"||E.position==="static"){N+=K.offsetTop,I+=K.offsetLeft}if(E.position==="fixed"){N+=Math.max(H.scrollTop,K.scrollTop),I+=Math.max(H.scrollLeft,K.scrollLeft)}return{top:N,left:I}}}o.offset={initialize:function(){if(this.initialized){return}var L=document.body,F=document.createElement("div"),H,G,N,I,M,E,J=L.style.marginTop,K='
    ';M={position:"absolute",top:0,left:0,margin:0,border:0,width:"1px",height:"1px",visibility:"hidden"};for(E in M){F.style[E]=M[E]}F.innerHTML=K;L.insertBefore(F,L.firstChild);H=F.firstChild,G=H.firstChild,I=H.nextSibling.firstChild.firstChild;this.doesNotAddBorder=(G.offsetTop!==5);this.doesAddBorderForTableAndCells=(I.offsetTop===5);H.style.overflow="hidden",H.style.position="relative";this.subtractsBorderForOverflowNotVisible=(G.offsetTop===-5);L.style.marginTop="1px";this.doesNotIncludeMarginInBodyOffset=(L.offsetTop===0);L.style.marginTop=J;L.removeChild(F);this.initialized=true},bodyOffset:function(E){o.offset.initialized||o.offset.initialize();var G=E.offsetTop,F=E.offsetLeft;if(o.offset.doesNotIncludeMarginInBodyOffset){G+=parseInt(o.curCSS(E,"marginTop",true),10)||0,F+=parseInt(o.curCSS(E,"marginLeft",true),10)||0}return{top:G,left:F}}};o.fn.extend({position:function(){var I=0,H=0,F;if(this[0]){var G=this.offsetParent(),J=this.offset(),E=/^body|html$/i.test(G[0].tagName)?{top:0,left:0}:G.offset();J.top-=j(this,"marginTop");J.left-=j(this,"marginLeft");E.top+=j(G,"borderTopWidth");E.left+=j(G,"borderLeftWidth");F={top:J.top-E.top,left:J.left-E.left}}return F},offsetParent:function(){var E=this[0].offsetParent||document.body;while(E&&(!/^body|html$/i.test(E.tagName)&&o.css(E,"position")=="static")){E=E.offsetParent}return o(E)}});o.each(["Left","Top"],function(F,E){var G="scroll"+E;o.fn[G]=function(H){if(!this[0]){return null}return H!==g?this.each(function(){this==l||this==document?l.scrollTo(!F?H:o(l).scrollLeft(),F?H:o(l).scrollTop()):this[G]=H}):this[0]==l||this[0]==document?self[F?"pageYOffset":"pageXOffset"]||o.boxModel&&document.documentElement[G]||document.body[G]:this[0][G]}});o.each(["Height","Width"],function(I,G){var E=I?"Left":"Top",H=I?"Right":"Bottom",F=G.toLowerCase();o.fn["inner"+G]=function(){return this[0]?o.css(this[0],F,false,"padding"):null};o.fn["outer"+G]=function(K){return this[0]?o.css(this[0],F,false,K?"margin":"border"):null};var J=G.toLowerCase();o.fn[J]=function(K){return this[0]==l?document.compatMode=="CSS1Compat"&&document.documentElement["client"+G]||document.body["client"+G]:this[0]==document?Math.max(document.documentElement["client"+G],document.body["scroll"+G],document.documentElement["scroll"+G],document.body["offset"+G],document.documentElement["offset"+G]):K===g?(this.length?o.css(this[0],J):null):this.css(J,typeof K==="string"?K:K+"px")}})})(); + +/* + * jQuery hashchange event - v1.3 - 7/21/2010 + * http://benalman.com/projects/jquery-hashchange-plugin/ + * + * Copyright (c) 2010 "Cowboy" Ben Alman + * Dual licensed under the MIT and GPL licenses. + * http://benalman.com/about/license/ + */ +(function($,e,b){var c="hashchange",h=document,f,g=$.event.special,i=h.documentMode,d="on"+c in e&&(i===b||i>7);function a(j){j=j||location.href;return"#"+j.replace(/^[^#]*#?(.*)$/,"$1")}$.fn[c]=function(j){return j?this.bind(c,j):this.trigger(c)};$.fn[c].delay=50;g[c]=$.extend(g[c],{setup:function(){if(d){return false}$(f.start)},teardown:function(){if(d){return false}$(f.stop)}});f=(function(){var j={},p,m=a(),k=function(q){return q},l=k,o=k;j.start=function(){p||n()};j.stop=function(){p&&clearTimeout(p);p=b};function n(){var r=a(),q=o(m);if(r!==m){l(m=r,q);$(e).trigger(c)}else{if(q!==m){location.href=location.href.replace(/#.*/,"")+q}}p=setTimeout(n,$.fn[c].delay)}$.browser.msie&&!d&&(function(){var q,r;j.start=function(){if(!q){r=$.fn[c].src;r=r&&r+a();q=$('